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": "77366a2c-2bdf-4e8c-8378-bb9d682d3135",
"ParentTaskId": "edbe8076-7052-4c83-bf9c-14d859c3e987",
"Integration": {
"IntegrationId": "23d758ea-e8d4-4e62-8317-5b40da6c455d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"098e27ae-9e57-4160-b6f4-040c2ab57ced": 2.0,
"94191caa-7445-4fea-b55f-c149d45911c2": 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. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "387ee8fd-b3c1-441d-af28-c134e9e03b56",
"Name": "sample string 1",
"Created": "2026-06-25T17:50:54.7867882+00:00",
"Modified": "2026-06-25T17:50:54.7867882+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"450f8b5b-8556-453f-a6e2-0ff59e0b469e",
"44531828-3962-424a-9f65-ca0ab1a23bd2"
],
"NonLaborAssignments": [
{
"Id": "e9ac3bdc-ee38-4617-ad3e-9c5afda76848",
"ResourceId": "37e84ea8-da5d-41fc-be5d-10a6068e8a61",
"Quantity": 3.0
},
{
"Id": "e9ac3bdc-ee38-4617-ad3e-9c5afda76848",
"ResourceId": "37e84ea8-da5d-41fc-be5d-10a6068e8a61",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "fc8eee2f-5564-4ce5-a020-09f3b7fa49c4",
"Type": 0,
"ResourceId": "e63ae060-53af-40ce-b16b-7a4ed80b6c14",
"Units": 3.0
},
{
"Id": "fc8eee2f-5564-4ce5-a020-09f3b7fa49c4",
"Type": 0,
"ResourceId": "e63ae060-53af-40ce-b16b-7a4ed80b6c14",
"Units": 3.0
}
],
"ParentId": "c1204e15-a73d-4c11-90c2-195267986441",
"WorkTypeParentId": "b8926a4c-2d12-4770-8a80-0673e79a370b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4f356dd3-1b24-4d78-8917-659b5ff8fa9d",
"UPN": "1f370290-e350-40f5-95d3-3a05b756b752",
"PostDate": "2026-06-25T17:50:54.7867882+00:00",
"Comment": "sample string 4",
"CC": [
"a64d4361-44e1-4236-a9da-6c496e420af0",
"1234f5bf-c3fe-425c-895f-43df8d321466"
],
"Users": [
"df372c87-ddf9-46ec-bf27-e69588acc4e2",
"45598c9f-f1b6-459c-96e8-0a18996eac8c"
]
},
{
"Id": "4f356dd3-1b24-4d78-8917-659b5ff8fa9d",
"UPN": "1f370290-e350-40f5-95d3-3a05b756b752",
"PostDate": "2026-06-25T17:50:54.7867882+00:00",
"Comment": "sample string 4",
"CC": [
"a64d4361-44e1-4236-a9da-6c496e420af0",
"1234f5bf-c3fe-425c-895f-43df8d321466"
],
"Users": [
"df372c87-ddf9-46ec-bf27-e69588acc4e2",
"45598c9f-f1b6-459c-96e8-0a18996eac8c"
]
}
],
"StartDate": "2026-06-25T17:50:54.7867882+00:00",
"DueDate": "2026-06-25T17:50:54.7867882+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"8c1ffb2d-c1d0-440c-8734-30fd129c9509": "fd9c66e2-8117-4dca-b072-1ed0aafc8e2f",
"7f338c1b-ce3e-4552-92a0-0bcdef80f2e0": "c21d34f5-beaa-4f68-8617-feada1ad5e4e"
},
"HasUpdates": true,
"Modified": "2026-06-25T17:50:54.7867882+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-06-25T17:50:54.7867882+00:00"
},
"LastComment": "2026-06-25T17:50:54.7867882+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2590742e-5728-4783-a988-4f2688738d86",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "8d9ba3c9-485e-410f-8226-6ec114fa4d3f",
"id": "1223b123-4eca-4525-a1de-c525febd2bdf",
"ConfigId": "cf82bffe-ca9e-40d1-a62a-3dcc7d3cb7c0"
}