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": "58216f7a-2f7e-4150-bcfe-3605e1267217",
"ParentTaskId": "7a75e519-2eda-404c-9f1d-17be034b9361",
"Integration": {
"IntegrationId": "41aaa13a-6847-4f1f-a275-9727ce3da4c3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"08081adf-b982-4404-af30-456548dc41e8": 2.0,
"52c5d112-aab5-40f7-8c83-53a4793f71dc": 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": "77c99201-3629-44f6-8d7b-091c598ed7b8",
"Name": "sample string 1",
"Created": "2026-08-09T02:13:04.6013787+00:00",
"Modified": "2026-08-09T02:13:04.6013787+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ecf64c39-b141-4897-b183-688baa1add66",
"92bc2ee1-e15c-4e0c-bd14-58a45cdab0d1"
],
"NonLaborAssignments": [
{
"Id": "0cc12b3c-04e3-439f-b4a2-bcd2eb6c4627",
"ResourceId": "230b1f72-7361-438c-b1db-84ddda722202",
"Quantity": 3.0
},
{
"Id": "0cc12b3c-04e3-439f-b4a2-bcd2eb6c4627",
"ResourceId": "230b1f72-7361-438c-b1db-84ddda722202",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "aeff5c9b-1fa5-49c3-80d9-4d54e5544d7f",
"Type": 0,
"ResourceId": "1779403f-4a05-474a-9d20-e91f5b654d79",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "aeff5c9b-1fa5-49c3-80d9-4d54e5544d7f",
"Type": 0,
"ResourceId": "1779403f-4a05-474a-9d20-e91f5b654d79",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "1c5b6c93-2927-4acd-a982-fa90dcc43017",
"WorkTypeParentId": "0d03551b-4f33-48a2-bf1d-d8a6629dbc60",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f4dd6c66-744e-4740-a61a-b2b628355a3c",
"UPN": "a1b33d6c-6207-4b8c-a9d2-e28c9fd1efe5",
"PostDate": "2026-08-09T02:13:04.6013787+00:00",
"Comment": "sample string 4",
"CC": [
"b4a26d21-ae4d-4b77-b8d7-24a4a5c85363",
"6f073188-ec2d-41da-831a-2920b1a479a7"
],
"Users": [
"c595d47b-22b9-485e-b562-2b009f29ecb1",
"6ec12d8b-d167-4c85-a84d-80ff481d88db"
]
},
{
"Id": "f4dd6c66-744e-4740-a61a-b2b628355a3c",
"UPN": "a1b33d6c-6207-4b8c-a9d2-e28c9fd1efe5",
"PostDate": "2026-08-09T02:13:04.6013787+00:00",
"Comment": "sample string 4",
"CC": [
"b4a26d21-ae4d-4b77-b8d7-24a4a5c85363",
"6f073188-ec2d-41da-831a-2920b1a479a7"
],
"Users": [
"c595d47b-22b9-485e-b562-2b009f29ecb1",
"6ec12d8b-d167-4c85-a84d-80ff481d88db"
]
}
],
"StartDate": "2026-08-09T02:13:04.6013787+00:00",
"DueDate": "2026-08-09T02:13:04.6013787+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fe5c70d7-b8ea-48c0-bf77-1cd53edbd133": "163cd9ce-459b-4ec0-8a52-a42ea4b5d816",
"4e11086e-c877-4ce1-ad1b-3426dee507b6": "74d57a5b-ff4d-45c2-bc7f-606c51b34ecc"
},
"HasUpdates": true,
"Modified": "2026-08-09T02:13:04.6013787+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-08-09T02:13:04.6013787+00:00"
},
"LastComment": "2026-08-09T02:13:04.6013787+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "40468978-8149-414b-8faf-680b5d5f9cf3",
"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": "7fe35a77-9b90-4346-936b-51203fe6dd37",
"id": "dd4c941c-8bcf-46d9-bcb1-2a3c5b5a7586",
"ConfigId": "d0100fce-5869-47fa-b888-d78d37b5eb50"
}