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": "1c5f3390-9d28-4298-a632-b4fb0399c12c",
"ParentTaskId": "d4653c08-5a7d-440d-a91a-721f9c039c7b",
"Integration": {
"IntegrationId": "34cd40c9-77ba-4e2a-8b19-04147a45c3af",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f4695d98-ba43-47fd-830d-262176d970d8": 2.0,
"8623b978-9592-48e4-81f9-962650f540bf": 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": "8df0cee6-0822-4964-988b-c4bb5db2cfc1",
"Name": "sample string 1",
"Created": "2026-08-01T21:36:27.6416681+00:00",
"Modified": "2026-08-01T21:36:27.6416681+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"67a0b3c1-4047-4eb5-af5c-49397bae1bf4",
"caa901b0-111f-43d3-8f9f-1711181c8ba5"
],
"NonLaborAssignments": [
{
"Id": "bc45d175-0f0a-4d09-96be-00e1ff504bda",
"ResourceId": "f47ad3cd-216b-4e8f-8606-73b7aca2a8ba",
"Quantity": 3.0
},
{
"Id": "bc45d175-0f0a-4d09-96be-00e1ff504bda",
"ResourceId": "f47ad3cd-216b-4e8f-8606-73b7aca2a8ba",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bf1af53b-3667-49ba-a19d-d43b89e89595",
"Type": 0,
"ResourceId": "288e7d50-83f0-48df-a101-1500489bd3f1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "bf1af53b-3667-49ba-a19d-d43b89e89595",
"Type": 0,
"ResourceId": "288e7d50-83f0-48df-a101-1500489bd3f1",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3ca1fd78-b27a-4781-846d-88f9a497dbe1",
"WorkTypeParentId": "31706c9a-a7f5-4e44-817a-16415d352216",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e3053d5e-d973-4dfb-b6fe-9905b89e50ed",
"UPN": "69ccab26-2e81-4510-9f0e-56df6e3bbc43",
"PostDate": "2026-08-01T21:36:27.6416681+00:00",
"Comment": "sample string 4",
"CC": [
"f9df21e3-70fb-4610-8777-643e5b10e978",
"9b04cc91-c2e9-4cb2-8933-93b775359b5c"
],
"Users": [
"c01d7a4b-c041-4ec1-ab6c-367d8d3f4eb1",
"88219156-c9ed-44b4-9f7f-8a548d4cea7d"
]
},
{
"Id": "e3053d5e-d973-4dfb-b6fe-9905b89e50ed",
"UPN": "69ccab26-2e81-4510-9f0e-56df6e3bbc43",
"PostDate": "2026-08-01T21:36:27.6416681+00:00",
"Comment": "sample string 4",
"CC": [
"f9df21e3-70fb-4610-8777-643e5b10e978",
"9b04cc91-c2e9-4cb2-8933-93b775359b5c"
],
"Users": [
"c01d7a4b-c041-4ec1-ab6c-367d8d3f4eb1",
"88219156-c9ed-44b4-9f7f-8a548d4cea7d"
]
}
],
"StartDate": "2026-08-01T21:36:27.6416681+00:00",
"DueDate": "2026-08-01T21:36:27.6416681+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"13af3343-6239-4648-a367-c8e7e55994ab": "7ea0252e-6240-4b64-87e7-90be1725901a",
"5d9f3686-00d4-4869-b185-f15b918ed741": "08ba6d1a-fcdb-4532-8d42-95ea001d814d"
},
"HasUpdates": true,
"Modified": "2026-08-01T21:36:27.6416681+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-01T21:36:27.6416681+00:00"
},
"LastComment": "2026-08-01T21:36:27.6416681+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b1de185b-f742-46c1-a815-ace9e0a1a80a",
"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": "708b900d-fc30-401f-b767-0892ce64268f",
"id": "3ae53085-63a7-4c2a-9fe6-0cad2d1c9b60",
"ConfigId": "753a7f0b-f124-4d41-997e-46d6d2e2e205"
}