POST api/workplan/{id}/tasks
Add Task
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Work Plan Id |
globally unique identifier |
Required |
Body Parameters
TasksRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| WorkTypeId | globally unique identifier |
None. |
|
| ParentTaskId | globally unique identifier |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| Assignments | Dictionary of globally unique identifier [key] and decimal number [value] |
None. |
|
| ProcessAssignments | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"WorkTypeId": "b3001a92-9687-4a90-b718-81fdbb956035",
"ParentTaskId": "1c4c4b6f-a7c3-4e05-8d01-2fa1cb83f826",
"Integration": {
"IntegrationId": "077b840a-d899-4f19-8171-5d420885d73b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c8c3d2b6-75e1-4355-8df0-7007007d1178": 2.0,
"7b2c61de-4ba0-4c08-8c16-bad5c3836363": 4.0
},
"ProcessAssignments": true
}
Response Information
Resource Description
WorkPlanTask| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Created | date |
None. |
|
| Modified | date |
None. |
|
| Author | string |
None. |
|
| Editor | string |
None. |
|
| AssignedTo | Collection of globally unique identifier |
None. |
|
| NonLaborAssignments | Collection of TaskNonLaborAssignment |
None. |
|
| Assignments | Collection of TaskAssignment |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| WorkTypeParentId | globally unique identifier |
None. |
|
| WorkTypeIndex | integer |
None. |
|
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| Index | integer |
None. |
|
| Complete | boolean |
None. |
|
| Comments | Collection of TaskComment |
None. |
|
| StartDate | date |
None. |
|
| DueDate | date |
None. |
|
| TaskScheduleType | TaskType |
None. |
|
| StatusUpdate | StatusUpdateClass |
None. |
|
| LastComment | date |
None. |
|
| IsScheduled | boolean |
None. |
|
| Integration | TaskIntegrationInfo |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "62e60cba-6489-4c08-bcbb-b54df97146ea",
"Name": "sample string 1",
"Created": "2026-03-16T21:18:09.1161089+00:00",
"Modified": "2026-03-16T21:18:09.1161089+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f32d1058-b11e-4ffb-bd37-8f2094152836",
"7196732a-ed91-46c0-80b1-e30ac705a5b6"
],
"NonLaborAssignments": [
{
"Id": "e68410b2-2b66-4b79-b1c8-c6ce6f0a77c4",
"ResourceId": "e8a9f64d-78fd-4add-9f81-5a738966cb8e",
"Quantity": 3.0
},
{
"Id": "e68410b2-2b66-4b79-b1c8-c6ce6f0a77c4",
"ResourceId": "e8a9f64d-78fd-4add-9f81-5a738966cb8e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "495ca53e-f2c6-4354-9373-3df9cac8997d",
"Type": 0,
"ResourceId": "087bf00f-a55d-47e5-a56a-880e97cfc25f",
"Units": 3.0
},
{
"Id": "495ca53e-f2c6-4354-9373-3df9cac8997d",
"Type": 0,
"ResourceId": "087bf00f-a55d-47e5-a56a-880e97cfc25f",
"Units": 3.0
}
],
"ParentId": "f625dc05-c4a6-47bf-9530-d0088102fd99",
"WorkTypeParentId": "9cda7492-9910-4248-8299-211f3ecf7aef",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "105cc0dd-6f58-4990-9621-73e37b20de78",
"UPN": "d70011b8-f66f-4703-bb77-be05268a6edb",
"PostDate": "2026-03-16T21:18:09.1161089+00:00",
"Comment": "sample string 4",
"CC": [
"254b9c72-0090-48f7-b83d-90b0c1577dc7",
"2c09520f-57ac-4ee0-abd9-b3340cffc4ac"
],
"Users": [
"050c8d38-547c-440b-9d0d-83cc63d4cef9",
"a75476e4-3a79-405f-805c-f8a49afd81df"
]
},
{
"Id": "105cc0dd-6f58-4990-9621-73e37b20de78",
"UPN": "d70011b8-f66f-4703-bb77-be05268a6edb",
"PostDate": "2026-03-16T21:18:09.1161089+00:00",
"Comment": "sample string 4",
"CC": [
"254b9c72-0090-48f7-b83d-90b0c1577dc7",
"2c09520f-57ac-4ee0-abd9-b3340cffc4ac"
],
"Users": [
"050c8d38-547c-440b-9d0d-83cc63d4cef9",
"a75476e4-3a79-405f-805c-f8a49afd81df"
]
}
],
"StartDate": "2026-03-16T21:18:09.1161089+00:00",
"DueDate": "2026-03-16T21:18:09.1161089+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"70f3af06-4731-40b4-9ba9-f96991c309b5": "0eab9910-d90f-4d52-82fb-5687d2d64bfe",
"9c5bdbc7-a43c-4f8f-ba9d-13a79601c9d9": "cb73bc67-03f0-4d42-95b2-d9484cf4eb0d"
},
"HasUpdates": true,
"Modified": "2026-03-16T21:18:09.1161089+00:00",
"Editor": "sample string 3",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"CalcFields": {
"sample string 1": {},
"sample string 3": {}
},
"State": 0,
"ApproveRejectBy": "sample string 4",
"ApproveRejectDate": "2026-03-16T21:18:09.1161089+00:00"
},
"LastComment": "2026-03-16T21:18:09.1161089+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "be5134a3-1718-4c0e-bd89-1cea853032a1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "4242c954-bf0f-4560-b2db-8f3d9983a2db",
"id": "e2231f66-9242-420d-85ba-11934359f2c6",
"ConfigId": "7efc6ead-766a-4193-b845-043c2d542c8b"
}