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": "4c1c8451-32a6-4a4e-966e-7c81046985eb",
"ParentTaskId": "b155cc31-e567-4a42-b84a-82f2340ad435",
"Integration": {
"IntegrationId": "3a893e17-b69f-476e-874a-fb511cf20459",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"0363fb65-2328-479c-8f3e-a6661730d0bb": 2.0,
"2abec0e7-fbea-4a80-9b58-62fcb0a7fc25": 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": "5d597ea1-d52a-4900-a157-093c57e773df",
"Name": "sample string 1",
"Created": "2026-04-22T08:11:39.8678575+00:00",
"Modified": "2026-04-22T08:11:39.8678575+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f83219ef-11ce-4a2e-9b3a-927a89f9966e",
"f5321d42-63bc-4757-9e6c-4ce22104a234"
],
"NonLaborAssignments": [
{
"Id": "52f211a8-9c34-495c-9696-219fb259291b",
"ResourceId": "6697d1d0-6b93-4948-8139-8441ecb43a93",
"Quantity": 3.0
},
{
"Id": "52f211a8-9c34-495c-9696-219fb259291b",
"ResourceId": "6697d1d0-6b93-4948-8139-8441ecb43a93",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "36dda400-0ee0-4865-ab7e-9d12c28ea525",
"Type": 0,
"ResourceId": "de0769a9-307d-4d94-b1b3-e90ebc05ffd2",
"Units": 3.0
},
{
"Id": "36dda400-0ee0-4865-ab7e-9d12c28ea525",
"Type": 0,
"ResourceId": "de0769a9-307d-4d94-b1b3-e90ebc05ffd2",
"Units": 3.0
}
],
"ParentId": "2eebf3e3-8952-4771-85db-c4ffeb7f1632",
"WorkTypeParentId": "01943b05-8bf6-4b1e-97b6-365cf62a899d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "77c90660-47d2-4a79-b23c-f4759be16033",
"UPN": "846deded-5807-487a-9dbb-0f9d63ca0c70",
"PostDate": "2026-04-22T08:11:39.8678575+00:00",
"Comment": "sample string 4",
"CC": [
"291e68e3-6791-43b3-9c2b-4e1f15c85e9d",
"07c8cee9-3b26-4025-a29a-05a51587aa7a"
],
"Users": [
"19a24e3c-445b-4236-8984-117e0964e6cc",
"3ff954c2-94ea-4967-ac70-e1699cdb8538"
]
},
{
"Id": "77c90660-47d2-4a79-b23c-f4759be16033",
"UPN": "846deded-5807-487a-9dbb-0f9d63ca0c70",
"PostDate": "2026-04-22T08:11:39.8678575+00:00",
"Comment": "sample string 4",
"CC": [
"291e68e3-6791-43b3-9c2b-4e1f15c85e9d",
"07c8cee9-3b26-4025-a29a-05a51587aa7a"
],
"Users": [
"19a24e3c-445b-4236-8984-117e0964e6cc",
"3ff954c2-94ea-4967-ac70-e1699cdb8538"
]
}
],
"StartDate": "2026-04-22T08:11:39.8678575+00:00",
"DueDate": "2026-04-22T08:11:39.8678575+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6a8045a2-978f-44dc-90b3-9385ceabcd23": "9ff1bdc3-a450-4ef9-b50a-6b344467deee",
"7c689fa1-ae1f-4e89-bc0f-df684313a17a": "62c50ea1-3887-479a-b0c3-a9ca9d49ab8a"
},
"HasUpdates": true,
"Modified": "2026-04-22T08:11:39.8678575+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-04-22T08:11:39.8678575+00:00"
},
"LastComment": "2026-04-22T08:11:39.8678575+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "2554abef-77bd-4b49-bc0e-ec8d0d9587dd",
"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": "e14f5a78-911e-4981-be12-561ef5030ad0",
"id": "622d3520-1a75-4ab1-89d6-84c0a9fceb2c",
"ConfigId": "5c96db3b-762f-4f37-be68-6f02f4538fc4"
}