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": "67320921-3c31-4bec-8edd-88fa42c8913d",
"ParentTaskId": "acaab22d-a272-46ed-97b8-d863ef742213",
"Integration": {
"IntegrationId": "7cd55fa4-c952-4414-91b1-600b0e950d66",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"05dab16f-95aa-482a-909a-8818692d1798": 2.0,
"1e171be6-ac94-4a1a-99fb-e9210be10e08": 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": "14685462-c76e-40f1-a0b5-c5ec0321bc97",
"Name": "sample string 1",
"Created": "2026-07-31T21:08:15.3651276+00:00",
"Modified": "2026-07-31T21:08:15.3651276+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"1a96ae6c-7a35-4dd6-b79b-9a27c0ae2e83",
"fc4768f6-4ddb-4bb4-87dc-ef85ce3a016b"
],
"NonLaborAssignments": [
{
"Id": "91cb25b1-8e66-4590-b208-e3e4b69a57ac",
"ResourceId": "f8ad2505-d374-4f88-b970-526343f44fc9",
"Quantity": 3.0
},
{
"Id": "91cb25b1-8e66-4590-b208-e3e4b69a57ac",
"ResourceId": "f8ad2505-d374-4f88-b970-526343f44fc9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a3f45205-0d3e-4624-9b40-268d50f6eb2d",
"Type": 0,
"ResourceId": "27ece4f3-438b-43dc-849f-bc54a1765bda",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "a3f45205-0d3e-4624-9b40-268d50f6eb2d",
"Type": 0,
"ResourceId": "27ece4f3-438b-43dc-849f-bc54a1765bda",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9aa637a3-c360-41e8-a158-db0992f7d532",
"WorkTypeParentId": "bbc3f99f-c2cb-432f-9d87-769e9fa3f4af",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4ad6a0fa-5687-4882-9752-4a66d8edf209",
"UPN": "b18acc24-0e8d-4770-9ceb-491c1c2ea0a7",
"PostDate": "2026-07-31T21:08:15.3651276+00:00",
"Comment": "sample string 4",
"CC": [
"3b2524f8-b01e-4965-b661-9b2b4d29b46f",
"64a86bfc-0940-4477-b2aa-778159ad6387"
],
"Users": [
"09ba33de-c9b9-4d9d-a03e-4bc518a755c2",
"5d42200f-8682-4825-b861-9ef655bc3fc7"
]
},
{
"Id": "4ad6a0fa-5687-4882-9752-4a66d8edf209",
"UPN": "b18acc24-0e8d-4770-9ceb-491c1c2ea0a7",
"PostDate": "2026-07-31T21:08:15.3651276+00:00",
"Comment": "sample string 4",
"CC": [
"3b2524f8-b01e-4965-b661-9b2b4d29b46f",
"64a86bfc-0940-4477-b2aa-778159ad6387"
],
"Users": [
"09ba33de-c9b9-4d9d-a03e-4bc518a755c2",
"5d42200f-8682-4825-b861-9ef655bc3fc7"
]
}
],
"StartDate": "2026-07-31T21:08:15.3651276+00:00",
"DueDate": "2026-07-31T21:08:15.3651276+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5b91288b-f937-484e-8457-00449453401b": "6ce00455-6922-40f0-a743-420a1d890e21",
"f42db6a5-a257-418d-a8c1-8cbc5a6441a2": "e52295c3-a6f2-4d3d-9d2a-56aef9321e70"
},
"HasUpdates": true,
"Modified": "2026-07-31T21:08:15.3651276+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-31T21:08:15.3651276+00:00"
},
"LastComment": "2026-07-31T21:08:15.3651276+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "38a306d0-925a-4d80-9542-a47795731bf1",
"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": "70278731-7b56-4414-a4db-3dbf7cad224d",
"id": "ac6f5bf8-b6f8-4e81-92df-836810efb53e",
"ConfigId": "2af1ea4c-5705-490c-9db9-48250e2aacb7"
}