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": "a7175821-536e-4685-b5b6-5c8c9414b9af",
"ParentTaskId": "7794b437-1ed8-4a04-9bed-7f0a7d094640",
"Integration": {
"IntegrationId": "d37d4ebc-bd6d-482b-9b16-818f27989a94",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c687518f-10bd-41ab-814a-21c0f09fc845": 2.0,
"c595b3fe-e87a-49ef-8cd8-caabbd34456b": 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": "2e73b363-d0b4-466a-9dc9-45d00aa2f331",
"Name": "sample string 1",
"Created": "2026-06-27T03:01:21.3277404+00:00",
"Modified": "2026-06-27T03:01:21.3277404+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"cb94614b-ddf4-405c-8f1b-edf3813e0d09",
"d82ecf50-4458-42b1-8159-74373aebdc4f"
],
"NonLaborAssignments": [
{
"Id": "3853769f-a20e-4ca0-a59a-602bfc6847b9",
"ResourceId": "1ba190e9-fbde-4048-86f1-210b2e64cd3f",
"Quantity": 3.0
},
{
"Id": "3853769f-a20e-4ca0-a59a-602bfc6847b9",
"ResourceId": "1ba190e9-fbde-4048-86f1-210b2e64cd3f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3fe82c57-4051-49b8-a6a9-a23e02d21626",
"Type": 0,
"ResourceId": "6ff71ac9-ea08-43ba-94d9-bd21ca55cc48",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "3fe82c57-4051-49b8-a6a9-a23e02d21626",
"Type": 0,
"ResourceId": "6ff71ac9-ea08-43ba-94d9-bd21ca55cc48",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "76957421-f33f-44a7-ad4a-5bd1f0e53d79",
"WorkTypeParentId": "19ec7926-e045-430c-b436-1947e796cd67",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "33957c52-4b50-453e-9803-09dec1cec252",
"UPN": "afb86238-4fb5-4bac-9573-d8e75c2bf25a",
"PostDate": "2026-06-27T03:01:21.3277404+00:00",
"Comment": "sample string 4",
"CC": [
"d80eaaae-4c31-4e75-8838-3b897515e867",
"8642dea9-115f-41ce-bfcd-6ab146a9893a"
],
"Users": [
"7cbfeca0-3929-486c-9506-2a117215fdcf",
"5a9622ae-c4ca-4b4d-8be9-7a4c2dc7356c"
]
},
{
"Id": "33957c52-4b50-453e-9803-09dec1cec252",
"UPN": "afb86238-4fb5-4bac-9573-d8e75c2bf25a",
"PostDate": "2026-06-27T03:01:21.3277404+00:00",
"Comment": "sample string 4",
"CC": [
"d80eaaae-4c31-4e75-8838-3b897515e867",
"8642dea9-115f-41ce-bfcd-6ab146a9893a"
],
"Users": [
"7cbfeca0-3929-486c-9506-2a117215fdcf",
"5a9622ae-c4ca-4b4d-8be9-7a4c2dc7356c"
]
}
],
"StartDate": "2026-06-27T03:01:21.3277404+00:00",
"DueDate": "2026-06-27T03:01:21.3277404+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d726f00e-d6df-45dc-9e2e-6f9b0ad5c372": "3ce74c3b-d3bc-422e-8082-5c9819dcaf81",
"a1f92e8b-9d0b-4157-b796-8ab02c013864": "0c1f994e-0536-46ba-b841-e5414e56aeb6"
},
"HasUpdates": true,
"Modified": "2026-06-27T03:01:21.3277404+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-06-27T03:01:21.3277404+00:00"
},
"LastComment": "2026-06-27T03:01:21.3277404+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b272d3ab-0809-464d-b49a-62e5b8c0b996",
"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": "d5ddc61a-03b8-4b89-a7ac-55a15e058e12",
"id": "a40d3498-38de-474b-816d-30783d97d566",
"ConfigId": "3b9443ac-f92c-4119-ad7b-e9abf755b5a0"
}