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": "653e4944-d301-419d-a43c-712ac7b4ba69",
"ParentTaskId": "e11e9324-5a4e-4a83-ab4f-6b5c39913460",
"Integration": {
"IntegrationId": "f83f1b8d-fb05-4063-8a87-7ef431dcb5d3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b9a6f207-dc33-4f5a-9d42-287882747e83": 2.0,
"f8a99c00-5e0a-4d59-97d4-5375a50eb3bf": 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": "8b6646ba-8774-4111-ac35-7f4f070097b6",
"Name": "sample string 1",
"Created": "2026-08-18T06:54:38.2673527+00:00",
"Modified": "2026-08-18T06:54:38.2673527+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3bc9fe01-6dc7-4432-a4a9-59520baa0d7a",
"131044dc-12e0-4696-9695-d29c558ffa7a"
],
"NonLaborAssignments": [
{
"Id": "9d3f5561-7c8d-430b-afc4-73fba56d3ba4",
"ResourceId": "866a2157-66e2-4c2c-9407-681ad17b9e39",
"Quantity": 3.0
},
{
"Id": "9d3f5561-7c8d-430b-afc4-73fba56d3ba4",
"ResourceId": "866a2157-66e2-4c2c-9407-681ad17b9e39",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "076f7d27-7031-47de-a008-e1365cdd20b5",
"Type": 0,
"ResourceId": "2746d911-6705-49fb-b771-317c6b3cc967",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "076f7d27-7031-47de-a008-e1365cdd20b5",
"Type": 0,
"ResourceId": "2746d911-6705-49fb-b771-317c6b3cc967",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9919f3a8-e96d-46c9-adf6-13820443f850",
"WorkTypeParentId": "d36199c0-1767-42f3-96fa-c2826b32ae5d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "54a65da3-bd7b-4c0c-93ab-3895ec7d7576",
"UPN": "c5a5383e-38bf-4c69-8b52-ceaca3642b61",
"PostDate": "2026-08-18T06:54:38.2673527+00:00",
"Comment": "sample string 4",
"CC": [
"ba1075bc-2a49-4e00-931f-1740a42ca127",
"4c85eff5-e3ff-48f2-9257-d3ca6d4f3156"
],
"Users": [
"e7da3eac-8e4c-4438-983b-3d11c97cb279",
"0497c663-4692-4d00-b61d-bd3dd844f8fe"
]
},
{
"Id": "54a65da3-bd7b-4c0c-93ab-3895ec7d7576",
"UPN": "c5a5383e-38bf-4c69-8b52-ceaca3642b61",
"PostDate": "2026-08-18T06:54:38.2673527+00:00",
"Comment": "sample string 4",
"CC": [
"ba1075bc-2a49-4e00-931f-1740a42ca127",
"4c85eff5-e3ff-48f2-9257-d3ca6d4f3156"
],
"Users": [
"e7da3eac-8e4c-4438-983b-3d11c97cb279",
"0497c663-4692-4d00-b61d-bd3dd844f8fe"
]
}
],
"StartDate": "2026-08-18T06:54:38.2673527+00:00",
"DueDate": "2026-08-18T06:54:38.2673527+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"634efe96-a61f-45bc-9894-40e0427fec21": "08064ead-12ca-485c-b21c-48d4b31e7cf3",
"1e230d98-e4be-448f-8720-d71fdfa624f4": "306efd34-c79e-4aaf-bd00-5d55be144233"
},
"HasUpdates": true,
"Modified": "2026-08-18T06:54:38.2673527+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-18T06:54:38.2673527+00:00"
},
"LastComment": "2026-08-18T06:54:38.2673527+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7cd09670-226a-4104-a50a-a7539da86cac",
"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": "01c2662c-495f-45af-a06c-00062c12c148",
"id": "969cda6e-c5ea-4500-9e72-0a78e602196a",
"ConfigId": "27bc6d01-1fb8-461c-9f15-e0c87e3315d9"
}