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": "997afc30-dce5-460c-8a15-95cc328a6e39",
"ParentTaskId": "64c98fb4-7102-43f8-a795-a6edf5ec9fc5",
"Integration": {
"IntegrationId": "c297e694-587b-44f6-8711-2d7cd80852f9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1c5f6360-940b-4c46-bd6b-02fcbfb5c8a0": 2.0,
"0de54dd5-830c-45d4-adf7-58209c1057de": 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": "53c8fe70-eafe-4330-9c5a-802fff4b4f03",
"Name": "sample string 1",
"Created": "2026-07-28T15:19:16.1576491+00:00",
"Modified": "2026-07-28T15:19:16.1576491+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"143c24b7-c39e-488c-9452-0bb1ba6a45bf",
"42104eb1-3b35-4b1a-8c1a-734ed4d6ff56"
],
"NonLaborAssignments": [
{
"Id": "f364f56e-b4a3-48e4-a960-c33b55dc2632",
"ResourceId": "a943b284-ea7a-4ac2-824c-7668772f3cf0",
"Quantity": 3.0
},
{
"Id": "f364f56e-b4a3-48e4-a960-c33b55dc2632",
"ResourceId": "a943b284-ea7a-4ac2-824c-7668772f3cf0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "185815fe-10ca-4391-8758-5904984e26f0",
"Type": 0,
"ResourceId": "5c0e04d0-0f1a-47cc-bf65-813415afb88a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "185815fe-10ca-4391-8758-5904984e26f0",
"Type": 0,
"ResourceId": "5c0e04d0-0f1a-47cc-bf65-813415afb88a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "eac990b6-a4dd-4286-8375-c24f40eaa171",
"WorkTypeParentId": "738b2da4-c644-4680-943b-5ee930ac3d1a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "dbf33f73-7f6f-4fc6-90dd-4f49562a31c5",
"UPN": "9dd5832c-2a8f-4871-aaa5-3e64a06af4e9",
"PostDate": "2026-07-28T15:19:16.1576491+00:00",
"Comment": "sample string 4",
"CC": [
"c2f8a681-2063-4297-90aa-54fec7162ef1",
"5567c5a9-3baf-4e79-8502-8e5030707a40"
],
"Users": [
"64d7a773-77a6-46ee-be35-7a3cfd97df8a",
"33c00bfb-cc3e-47c5-83ee-a2b19942c55b"
]
},
{
"Id": "dbf33f73-7f6f-4fc6-90dd-4f49562a31c5",
"UPN": "9dd5832c-2a8f-4871-aaa5-3e64a06af4e9",
"PostDate": "2026-07-28T15:19:16.1576491+00:00",
"Comment": "sample string 4",
"CC": [
"c2f8a681-2063-4297-90aa-54fec7162ef1",
"5567c5a9-3baf-4e79-8502-8e5030707a40"
],
"Users": [
"64d7a773-77a6-46ee-be35-7a3cfd97df8a",
"33c00bfb-cc3e-47c5-83ee-a2b19942c55b"
]
}
],
"StartDate": "2026-07-28T15:19:16.1576491+00:00",
"DueDate": "2026-07-28T15:19:16.1576491+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"636414f2-3388-44ef-a82a-44457309c5fb": "1a9da57b-a430-4914-9fb5-766a0b7a98b5",
"51fd6eb2-5277-413b-ae42-c160366466a7": "b1734637-9982-4a0c-acf4-46ff3a866466"
},
"HasUpdates": true,
"Modified": "2026-07-28T15:19:16.1576491+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-28T15:19:16.1576491+00:00"
},
"LastComment": "2026-07-28T15:19:16.1576491+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "de2133ef-150e-425e-95fa-7375c77c6865",
"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": "cb048442-b863-4179-8580-1be6d22a1ef2",
"id": "abf73bf5-0a38-4784-b87c-ee676b7c479f",
"ConfigId": "59c9279b-77d0-49cb-915a-6f4519be016a"
}