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": "140d54d5-e151-4608-9fa9-4db94c34d4ac",
"ParentTaskId": "1abcadcc-d95c-4066-9799-ae6c4858bff6",
"Integration": {
"IntegrationId": "e7715641-eb77-4e5c-a7d7-63567c384b7b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d7b48441-95ba-48ae-908a-d8f7b037f170": 2.0,
"056880fa-f86f-48ad-a0e7-e3311da89294": 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": "961ec26e-78c8-4930-aae1-d4a81ef976b2",
"Name": "sample string 1",
"Created": "2026-10-12T10:09:06.4051164+00:00",
"Modified": "2026-10-12T10:09:06.4051164+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f354da5e-213f-4269-9f02-cb63f9dd0357",
"e2fe9a3c-3e3f-4d2c-9168-83e38c30737a"
],
"NonLaborAssignments": [
{
"Id": "e1d560ad-bcb8-42bb-ac17-7378e8207226",
"ResourceId": "5d8aea9c-b092-4592-8d32-a1107ee9ee0e",
"Quantity": 3.0
},
{
"Id": "e1d560ad-bcb8-42bb-ac17-7378e8207226",
"ResourceId": "5d8aea9c-b092-4592-8d32-a1107ee9ee0e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e9031aad-0e3a-4275-8f74-a65044b457bc",
"Type": 0,
"ResourceId": "a63fa2cf-13a7-4d9c-8064-89493ae6b801",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9a888722-3a48-4c73-abda-aaaadfabba6f",
"Start": "2026-10-12T10:09:06.4051164+00:00",
"Due": "2026-10-12T10:09:06.4051164+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9a888722-3a48-4c73-abda-aaaadfabba6f",
"Start": "2026-10-12T10:09:06.4051164+00:00",
"Due": "2026-10-12T10:09:06.4051164+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e9031aad-0e3a-4275-8f74-a65044b457bc",
"Type": 0,
"ResourceId": "a63fa2cf-13a7-4d9c-8064-89493ae6b801",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "9a888722-3a48-4c73-abda-aaaadfabba6f",
"Start": "2026-10-12T10:09:06.4051164+00:00",
"Due": "2026-10-12T10:09:06.4051164+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "9a888722-3a48-4c73-abda-aaaadfabba6f",
"Start": "2026-10-12T10:09:06.4051164+00:00",
"Due": "2026-10-12T10:09:06.4051164+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "a0f549de-dbb7-456c-ab14-25aa117f0c69",
"WorkTypeParentId": "091f09d0-8ec1-428b-b00e-6a4b2663452a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b9059687-9cc5-4e67-bdb3-f466f3186e02",
"UPN": "0e5b273f-c880-4d64-b20f-1a9b855ecdf8",
"PostDate": "2026-10-12T10:09:06.4051164+00:00",
"Comment": "sample string 4",
"CC": [
"1afacea4-cc68-441a-968e-165ed27fa28d",
"fdd8912a-8b05-4c3f-8586-7cbb02c379b6"
],
"Users": [
"95f7fdfe-8dfd-4d15-ac1e-e4f3e88a1f7d",
"c7bdac99-0be6-4478-b552-60abdb4f1843"
]
},
{
"Id": "b9059687-9cc5-4e67-bdb3-f466f3186e02",
"UPN": "0e5b273f-c880-4d64-b20f-1a9b855ecdf8",
"PostDate": "2026-10-12T10:09:06.4051164+00:00",
"Comment": "sample string 4",
"CC": [
"1afacea4-cc68-441a-968e-165ed27fa28d",
"fdd8912a-8b05-4c3f-8586-7cbb02c379b6"
],
"Users": [
"95f7fdfe-8dfd-4d15-ac1e-e4f3e88a1f7d",
"c7bdac99-0be6-4478-b552-60abdb4f1843"
]
}
],
"StartDate": "2026-10-12T10:09:06.4051164+00:00",
"DueDate": "2026-10-12T10:09:06.4051164+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7ad62ae4-3fb6-4903-a50f-7e1bdaacc84a": "3d2c6be4-3c89-4137-be41-85fd7fc7d5fc",
"7f9d0eda-3b91-45c9-a9d7-a33cd690955d": "11f38b43-ae2e-4f32-aa70-69a1c51efb2b"
},
"HasUpdates": true,
"Modified": "2026-10-12T10:09:06.4051164+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-10-12T10:09:06.4051164+00:00"
},
"LastComment": "2026-10-12T10:09:06.4051164+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e16e2b8c-d006-4eb7-98cf-bef2e0280387",
"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": "a6ca1bcb-757f-426f-b7dd-73b4f7f257dd",
"id": "3d779257-1edd-4d3c-b18a-9dd9ab6de4de",
"ConfigId": "751c10ba-ceea-4ff6-9bb7-37986c5acf49"
}