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": "5ba80fde-50ec-45dc-99e5-086120d49c1f",
"ParentTaskId": "9e35d00e-03bc-46b8-9dfa-c7c55dc4547a",
"Integration": {
"IntegrationId": "c7751fa4-3c83-4d0f-8438-c871863462cf",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"82d7cea7-4d5f-4b8f-a076-df8fb54b7c8b": 2.0,
"faba7af7-9526-451b-b782-6be41b017eec": 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": "0345a508-f53c-404a-acbc-01aa77bcc09a",
"Name": "sample string 1",
"Created": "2026-07-14T21:35:52.7863803+00:00",
"Modified": "2026-07-14T21:35:52.7863803+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"519ff5f9-7baa-4cfc-ae40-6a652fa1968f",
"80f92427-c904-4d51-889d-d730305d6ab9"
],
"NonLaborAssignments": [
{
"Id": "460c07c3-6275-495a-b4b0-86128fc81098",
"ResourceId": "aea21536-9e77-4f3f-af4a-432cb9207d99",
"Quantity": 3.0
},
{
"Id": "460c07c3-6275-495a-b4b0-86128fc81098",
"ResourceId": "aea21536-9e77-4f3f-af4a-432cb9207d99",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "11da50fe-5b02-4db1-8915-54b643e4b7cb",
"Type": 0,
"ResourceId": "4a7a32d0-d0ee-402a-8d93-d1700375afe6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "11da50fe-5b02-4db1-8915-54b643e4b7cb",
"Type": 0,
"ResourceId": "4a7a32d0-d0ee-402a-8d93-d1700375afe6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "a328f84c-3c1c-4104-8fb8-5c21be65491c",
"WorkTypeParentId": "2dc8594f-e533-46d4-96d6-5b80c439e552",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a6db5529-dd4e-4c29-bb5e-9d2b05b3aec4",
"UPN": "c7bc3f9e-079a-4095-995d-8b3109c617de",
"PostDate": "2026-07-14T21:35:52.7863803+00:00",
"Comment": "sample string 4",
"CC": [
"aec06b3b-c0f9-42cc-a606-e704a22d0396",
"a8fcd37e-9843-4e3c-99e2-2afa2edff696"
],
"Users": [
"e6260dc2-1ad4-47ae-9b9a-92ccc45deb5a",
"f18a4e34-08e0-4a2b-86d7-6692813a2dea"
]
},
{
"Id": "a6db5529-dd4e-4c29-bb5e-9d2b05b3aec4",
"UPN": "c7bc3f9e-079a-4095-995d-8b3109c617de",
"PostDate": "2026-07-14T21:35:52.7863803+00:00",
"Comment": "sample string 4",
"CC": [
"aec06b3b-c0f9-42cc-a606-e704a22d0396",
"a8fcd37e-9843-4e3c-99e2-2afa2edff696"
],
"Users": [
"e6260dc2-1ad4-47ae-9b9a-92ccc45deb5a",
"f18a4e34-08e0-4a2b-86d7-6692813a2dea"
]
}
],
"StartDate": "2026-07-14T21:35:52.7863803+00:00",
"DueDate": "2026-07-14T21:35:52.7863803+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"847548c3-8405-4457-a890-f4caf603f081": "b443213f-4ab1-4fe1-9302-995aa14c05b9",
"4222dc89-9244-4ff3-ac4c-7c4bae0f9072": "2a76d621-c5bb-4ae2-bd6d-aecbdc8b14f9"
},
"HasUpdates": true,
"Modified": "2026-07-14T21:35:52.7863803+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-14T21:35:52.8020093+00:00"
},
"LastComment": "2026-07-14T21:35:52.8020093+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "986f9185-0f60-45c5-ab54-8ac33d57f41e",
"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": "be7c9801-9d7f-4dc2-940e-d7cd3bb72172",
"id": "47aa8200-109e-4742-b229-8ce4fd304d77",
"ConfigId": "a5f3c278-8334-4e92-b056-ee528ac7d30f"
}