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": "8d16826f-0c50-4ac9-99ca-22cce835c2ea",
"ParentTaskId": "60579173-7466-4338-9de0-4b7c24e2d081",
"Integration": {
"IntegrationId": "b65adcec-af76-4d77-8119-a0e8d374f193",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"2ed9cf00-2a2c-4ce3-80c2-d5cc89efa304": 2.0,
"518f9520-b700-4a02-affe-d2759c3aa43c": 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": "9ef8c472-ddf2-4113-bd46-7d63556f0411",
"Name": "sample string 1",
"Created": "2026-05-20T04:26:55.3283534+00:00",
"Modified": "2026-05-20T04:26:55.3283534+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7381de57-963e-425f-9666-0be0dc6b9038",
"451586b3-e5ee-4850-b1a5-6fc20465d921"
],
"NonLaborAssignments": [
{
"Id": "c85c824c-6d85-4c15-873d-706c2009877b",
"ResourceId": "d7e0fc40-6d1a-4dc2-ae82-8b38cc3639a5",
"Quantity": 3.0
},
{
"Id": "c85c824c-6d85-4c15-873d-706c2009877b",
"ResourceId": "d7e0fc40-6d1a-4dc2-ae82-8b38cc3639a5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b7586e08-78a9-46f6-83e7-52aec86046e7",
"Type": 0,
"ResourceId": "0d2bf28d-74f9-41db-9e51-e7fa4cb1f025",
"Units": 3.0
},
{
"Id": "b7586e08-78a9-46f6-83e7-52aec86046e7",
"Type": 0,
"ResourceId": "0d2bf28d-74f9-41db-9e51-e7fa4cb1f025",
"Units": 3.0
}
],
"ParentId": "718ed260-7328-4b79-aa92-1ff7599003fc",
"WorkTypeParentId": "32bfa9fc-9be0-44ad-b5d1-d21cb9a4ce0a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "7663f48b-c822-4699-9f75-3065801ff711",
"UPN": "cf6ae82d-0a3d-4510-a20b-921498517fde",
"PostDate": "2026-05-20T04:26:55.3283534+00:00",
"Comment": "sample string 4",
"CC": [
"3fb50926-7ed7-44ba-b309-148bbcfb370f",
"b544a5ae-d702-4ab2-99db-265431beb6c6"
],
"Users": [
"499b14ce-6d45-4861-8b29-64b670c7c510",
"c994cbda-8bce-4b28-9bdd-0a8853689f38"
]
},
{
"Id": "7663f48b-c822-4699-9f75-3065801ff711",
"UPN": "cf6ae82d-0a3d-4510-a20b-921498517fde",
"PostDate": "2026-05-20T04:26:55.3283534+00:00",
"Comment": "sample string 4",
"CC": [
"3fb50926-7ed7-44ba-b309-148bbcfb370f",
"b544a5ae-d702-4ab2-99db-265431beb6c6"
],
"Users": [
"499b14ce-6d45-4861-8b29-64b670c7c510",
"c994cbda-8bce-4b28-9bdd-0a8853689f38"
]
}
],
"StartDate": "2026-05-20T04:26:55.3283534+00:00",
"DueDate": "2026-05-20T04:26:55.3283534+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"592061fc-14b2-4930-bb98-f8189d752cac": "5f18576a-d26a-493f-b815-465aea7a4786",
"18c9bd55-8796-4492-87eb-24794a2110b8": "11780812-78e6-46e5-b2af-1b15564246c3"
},
"HasUpdates": true,
"Modified": "2026-05-20T04:26:55.3283534+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-05-20T04:26:55.3283534+00:00"
},
"LastComment": "2026-05-20T04:26:55.3283534+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "65e14e44-03ab-4f7c-bc67-446bb2405932",
"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": "bc8ebd32-e92e-46a5-a0f7-8f2229f2973f",
"id": "ded4fac4-cb1a-4194-8ee6-5b16bae58021",
"ConfigId": "238ae3e9-75e3-4244-b102-e5d163f8879c"
}