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": "5685fa61-be28-4e60-9599-6ea83528d236",
"ParentTaskId": "701b1823-b91c-4926-9c10-dd19a75af442",
"Integration": {
"IntegrationId": "8353016c-dd9e-47d8-bf3e-5db01ee40cf0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"45220053-b2a7-483c-83fe-199dbffee140": 2.0,
"37354914-e72d-47fa-9dc0-ecb52974cfaf": 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": "4dd22b04-5a25-43e5-9b0f-1b2c64fc19a7",
"Name": "sample string 1",
"Created": "2026-07-13T21:08:54.8221236+00:00",
"Modified": "2026-07-13T21:08:54.8221236+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e6c5ed96-ddb7-4ede-ae5b-c5d45707cb9e",
"cf44ff39-53ee-4f70-a0e6-628405e343a8"
],
"NonLaborAssignments": [
{
"Id": "b345e4a2-00f4-4b64-a0e4-90258d4a4346",
"ResourceId": "6183fed8-0d11-494d-8aeb-a5abf8533228",
"Quantity": 3.0
},
{
"Id": "b345e4a2-00f4-4b64-a0e4-90258d4a4346",
"ResourceId": "6183fed8-0d11-494d-8aeb-a5abf8533228",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "823162e4-5afa-466e-af8c-d8ad90b37624",
"Type": 0,
"ResourceId": "d23bce2d-7ad9-4272-8b42-233df9e49da0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "823162e4-5afa-466e-af8c-d8ad90b37624",
"Type": 0,
"ResourceId": "d23bce2d-7ad9-4272-8b42-233df9e49da0",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "8c3a42fa-bf47-416d-9cc8-47f510f66275",
"WorkTypeParentId": "3fcde7e8-5a83-4eb8-8109-9b88ae33d059",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "eebab8e2-53e6-4427-b936-591b5fb58c61",
"UPN": "9ba27d06-0978-4a22-a3d7-8120d0e885ab",
"PostDate": "2026-07-13T21:08:54.8221236+00:00",
"Comment": "sample string 4",
"CC": [
"bad7af54-040c-42ad-aa60-3a781464e244",
"4a4e22f6-05b8-4798-96bc-6c41c7e3ca96"
],
"Users": [
"e6b39782-a0ad-4e42-b433-2b547f0bbb99",
"8842dc56-730c-4c21-94bf-4024b81a501d"
]
},
{
"Id": "eebab8e2-53e6-4427-b936-591b5fb58c61",
"UPN": "9ba27d06-0978-4a22-a3d7-8120d0e885ab",
"PostDate": "2026-07-13T21:08:54.8221236+00:00",
"Comment": "sample string 4",
"CC": [
"bad7af54-040c-42ad-aa60-3a781464e244",
"4a4e22f6-05b8-4798-96bc-6c41c7e3ca96"
],
"Users": [
"e6b39782-a0ad-4e42-b433-2b547f0bbb99",
"8842dc56-730c-4c21-94bf-4024b81a501d"
]
}
],
"StartDate": "2026-07-13T21:08:54.8221236+00:00",
"DueDate": "2026-07-13T21:08:54.8221236+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"835b1c49-474b-4404-957e-de346554438a": "021a787d-043b-4cf6-8a2b-45ca4caaf7f7",
"a9369dc9-c343-455a-88ef-3468b1593b10": "b5b71d63-9547-4eae-9b3e-d115864cdf10"
},
"HasUpdates": true,
"Modified": "2026-07-13T21:08:54.8221236+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-07-13T21:08:54.8377559+00:00"
},
"LastComment": "2026-07-13T21:08:54.8377559+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e120ef44-475c-4d8e-a06d-f570d88cb6cc",
"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": "0f50e9a2-ed20-4fb7-8b56-55b7070d84e4",
"id": "1358c786-f278-4d97-9425-c04658239930",
"ConfigId": "be8122db-1452-437a-ba99-28745baa59ab"
}