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": "51928053-28c6-4190-b3cc-6bd1513e423b",
"ParentTaskId": "c6eacf56-7f26-455f-8e3e-eef950ec7212",
"Integration": {
"IntegrationId": "ccebe5fb-1873-4e53-9584-7f30c252d1e5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"af0692c9-9740-4e30-8e72-1db988b2d14e": 2.0,
"08586f86-ad4f-4ff9-b1ca-a11883b3de69": 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": "9d4c723e-9b07-411c-a55c-2702e5ea2106",
"Name": "sample string 1",
"Created": "2026-08-13T18:33:18.0055081+00:00",
"Modified": "2026-08-13T18:33:18.0055081+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d80e2ea6-1bc9-4e55-8494-2c5902134893",
"96159241-68d1-405b-bd48-48c900271252"
],
"NonLaborAssignments": [
{
"Id": "37f06e89-d317-4a50-8e40-f7a28dca7f37",
"ResourceId": "ce54a08e-2544-485a-a181-e02207252559",
"Quantity": 3.0
},
{
"Id": "37f06e89-d317-4a50-8e40-f7a28dca7f37",
"ResourceId": "ce54a08e-2544-485a-a181-e02207252559",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "cb1bb8b0-145f-4623-b968-f8bcfdfeaf67",
"Type": 0,
"ResourceId": "1f6637d6-713d-48fb-a5ae-b644a500439f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "cb1bb8b0-145f-4623-b968-f8bcfdfeaf67",
"Type": 0,
"ResourceId": "1f6637d6-713d-48fb-a5ae-b644a500439f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "6fc7b08d-5e18-4c03-bb1e-c9f20073a3d5",
"WorkTypeParentId": "2522d8a4-1cee-413d-87d7-8f38cc8b6772",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e6a92b4a-7c49-4133-9541-88469454db86",
"UPN": "9ab43673-bf82-4efd-811a-960b898d1049",
"PostDate": "2026-08-13T18:33:18.0055081+00:00",
"Comment": "sample string 4",
"CC": [
"83a7b7a0-cd4b-42eb-8fd6-2204037374c1",
"f8a67edc-1e43-41a4-82ce-2f35bc35a6f7"
],
"Users": [
"8dd827ce-3844-4602-928c-e210b29ca716",
"5f197c4c-c0bc-45f5-84cd-6cd0994dc227"
]
},
{
"Id": "e6a92b4a-7c49-4133-9541-88469454db86",
"UPN": "9ab43673-bf82-4efd-811a-960b898d1049",
"PostDate": "2026-08-13T18:33:18.0055081+00:00",
"Comment": "sample string 4",
"CC": [
"83a7b7a0-cd4b-42eb-8fd6-2204037374c1",
"f8a67edc-1e43-41a4-82ce-2f35bc35a6f7"
],
"Users": [
"8dd827ce-3844-4602-928c-e210b29ca716",
"5f197c4c-c0bc-45f5-84cd-6cd0994dc227"
]
}
],
"StartDate": "2026-08-13T18:33:18.0055081+00:00",
"DueDate": "2026-08-13T18:33:18.0055081+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"24050171-f626-4de2-adfb-77e95944dd79": "5926e13f-9651-4008-a1ed-f2f86a225027",
"cafdab7c-ad9f-4823-9dab-9c91ab67d380": "b006efa9-3636-4b39-963b-0c7d4c067e8a"
},
"HasUpdates": true,
"Modified": "2026-08-13T18:33:18.0055081+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-13T18:33:18.0055081+00:00"
},
"LastComment": "2026-08-13T18:33:18.0055081+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4a88c46c-8732-4e31-a3d8-4edc73795fa3",
"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": "b504b9f8-8f5b-4a7f-a71f-7256a8333fd1",
"id": "09397a89-5701-4bd8-806a-5b94ee929bd7",
"ConfigId": "1f4b026e-b9d8-4acb-9a4f-a687f34b365a"
}