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": "0236a081-639d-49b6-8996-1ec888974971",
"ParentTaskId": "ef05b87d-8feb-4315-b772-28c4dd84b68c",
"Integration": {
"IntegrationId": "0236193b-58cc-41d2-916d-87da6d9f25d7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"41749851-c471-4f0c-b44b-000a80730569": 2.0,
"19600b8b-2e34-4f9c-a115-09a01f0f2588": 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": "e5bf18ce-c792-45a1-aded-8d33ac73ed11",
"Name": "sample string 1",
"Created": "2026-07-24T02:41:04.2788859+00:00",
"Modified": "2026-07-24T02:41:04.2788859+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3d635002-4da6-44ee-b907-881df97a01fe",
"e1f0af30-309d-43af-8ca7-7ae5196c9794"
],
"NonLaborAssignments": [
{
"Id": "3b237eb8-0fcb-4bae-abcc-b5f688228715",
"ResourceId": "5f25f748-3dc4-44a3-a2f0-1e23675b0c47",
"Quantity": 3.0
},
{
"Id": "3b237eb8-0fcb-4bae-abcc-b5f688228715",
"ResourceId": "5f25f748-3dc4-44a3-a2f0-1e23675b0c47",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "8daf539b-0c60-4808-9191-7d4b299b7e9d",
"Type": 0,
"ResourceId": "61fb10e9-0433-425a-ac49-9d71bb115900",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "8daf539b-0c60-4808-9191-7d4b299b7e9d",
"Type": 0,
"ResourceId": "61fb10e9-0433-425a-ac49-9d71bb115900",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "1f3852c6-5d21-4ad7-a8c9-36d9511a6546",
"WorkTypeParentId": "7261a671-dd23-4682-ba47-52002ecf54d1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "d96e4348-d1e0-4b19-92ec-48bef2164064",
"UPN": "8db67124-6a54-4008-8ebf-d039d9b74420",
"PostDate": "2026-07-24T02:41:04.2788859+00:00",
"Comment": "sample string 4",
"CC": [
"2e952760-fe0d-4f9e-b7af-9b34e0abcb8e",
"07697c4a-d2a1-4f0d-b33d-2e16839da4c1"
],
"Users": [
"17765348-b4cd-4b8a-a07f-392d4d3903e5",
"13710ffa-faf7-4bc7-a6f8-743d5ec5131d"
]
},
{
"Id": "d96e4348-d1e0-4b19-92ec-48bef2164064",
"UPN": "8db67124-6a54-4008-8ebf-d039d9b74420",
"PostDate": "2026-07-24T02:41:04.2788859+00:00",
"Comment": "sample string 4",
"CC": [
"2e952760-fe0d-4f9e-b7af-9b34e0abcb8e",
"07697c4a-d2a1-4f0d-b33d-2e16839da4c1"
],
"Users": [
"17765348-b4cd-4b8a-a07f-392d4d3903e5",
"13710ffa-faf7-4bc7-a6f8-743d5ec5131d"
]
}
],
"StartDate": "2026-07-24T02:41:04.2788859+00:00",
"DueDate": "2026-07-24T02:41:04.2788859+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"91249f8a-8cb4-4090-a8c0-59ba011e788e": "5f42320b-5080-4585-aa05-5e11061d8f56",
"063beb37-5baf-4e32-ba54-89a16cb75f47": "41bbcec2-dfb6-499f-b546-9d2385d5c511"
},
"HasUpdates": true,
"Modified": "2026-07-24T02:41:04.2788859+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-24T02:41:04.2788859+00:00"
},
"LastComment": "2026-07-24T02:41:04.2788859+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e163b163-2b8e-45d3-a47b-9fee7259e5b2",
"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": "79e52c40-8fd9-4adc-a661-d24bca2b87aa",
"id": "71351936-04a8-4dd9-8ede-8f0c5638bdb4",
"ConfigId": "6c4c72ca-3a89-4901-8a51-e64cebbd1ae5"
}