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": "9301c42a-7ecf-48d3-bb09-766c4f53cfb0",
"ParentTaskId": "19e70122-9995-4fd6-84f6-75151d59b869",
"Integration": {
"IntegrationId": "bde025dd-2c88-4a2b-ab7f-8ecbb4526727",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"71e2d742-78e9-45ff-adaf-2ab98df5bc19": 2.0,
"8f6e9926-a225-4eae-be6c-fd3bf558a05a": 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": "7359f468-721c-4075-9e49-04e11a9e53f5",
"Name": "sample string 1",
"Created": "2026-08-03T20:14:26.7473518+00:00",
"Modified": "2026-08-03T20:14:26.7473518+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"dc4f4ca4-806e-4539-8334-6bfc6532d96e",
"9e70e054-5ccf-4471-b3a7-956136b29da9"
],
"NonLaborAssignments": [
{
"Id": "47405474-8516-41f5-ab1b-cfedf5464375",
"ResourceId": "909c20ed-168a-40ec-beba-38263a6f2db6",
"Quantity": 3.0
},
{
"Id": "47405474-8516-41f5-ab1b-cfedf5464375",
"ResourceId": "909c20ed-168a-40ec-beba-38263a6f2db6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "14d134ac-90ad-4323-b378-b72cd9299278",
"Type": 0,
"ResourceId": "dfba2c99-c99f-45a3-81ef-f0287df6c204",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "14d134ac-90ad-4323-b378-b72cd9299278",
"Type": 0,
"ResourceId": "dfba2c99-c99f-45a3-81ef-f0287df6c204",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "2d4cf9ef-040a-4178-810c-554d91d1684d",
"WorkTypeParentId": "4b894230-9acd-40e5-9995-f97fea2544d0",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f0dbc860-0d0e-4bb6-b092-f2bb316df740",
"UPN": "80eafe33-fbb4-4cad-98c9-c4deadf33bdb",
"PostDate": "2026-08-03T20:14:26.7473518+00:00",
"Comment": "sample string 4",
"CC": [
"759aff73-aefc-4581-8300-e3130e44ff91",
"c8b2bddd-9e91-4486-bcd1-d9593f872b40"
],
"Users": [
"42365572-fe84-48d9-877d-c85d0b8ee4ed",
"13edf159-1c7c-47e7-b9dc-f3a6395924de"
]
},
{
"Id": "f0dbc860-0d0e-4bb6-b092-f2bb316df740",
"UPN": "80eafe33-fbb4-4cad-98c9-c4deadf33bdb",
"PostDate": "2026-08-03T20:14:26.7473518+00:00",
"Comment": "sample string 4",
"CC": [
"759aff73-aefc-4581-8300-e3130e44ff91",
"c8b2bddd-9e91-4486-bcd1-d9593f872b40"
],
"Users": [
"42365572-fe84-48d9-877d-c85d0b8ee4ed",
"13edf159-1c7c-47e7-b9dc-f3a6395924de"
]
}
],
"StartDate": "2026-08-03T20:14:26.7473518+00:00",
"DueDate": "2026-08-03T20:14:26.7473518+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"69a099e4-f8c5-452c-931e-cafcb75dd4be": "e9112060-2305-445e-b4d9-eff6db315401",
"7c440b5e-04e5-4812-88f0-c112bbffacb0": "cbf7ef8e-1df3-4797-bfb5-f47bc481ef7a"
},
"HasUpdates": true,
"Modified": "2026-08-03T20:14:26.7473518+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-08-03T20:14:26.7473518+00:00"
},
"LastComment": "2026-08-03T20:14:26.7473518+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "410ed208-8cb4-4591-916f-4f573d5628f1",
"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": "485488d5-1037-4aca-92e4-4acbe1d66b6e",
"id": "822b2a9c-d69b-41b1-a870-23d44bc526e9",
"ConfigId": "dfc9da23-07d7-45b1-a4b0-9d1e15cd4c89"
}