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": "79b449a8-e49c-4442-8ab8-dc2e83eadced",
"ParentTaskId": "ebb1a9cd-32f0-41c9-a595-f0bd22c6f508",
"Integration": {
"IntegrationId": "3bc0edc5-a3e0-493c-bc52-97a49b9af57d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ccc11998-5047-488c-92ad-5dcc4af4c3b9": 2.0,
"5067ebf5-0e85-40b0-ac7c-6ba4fced85cb": 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": "22099641-fde6-465f-83b7-a7faa184fd17",
"Name": "sample string 1",
"Created": "2026-06-01T11:22:18.2793316+00:00",
"Modified": "2026-06-01T11:22:18.2793316+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"583eda4e-48dc-4653-bec9-cea6c4451bf7",
"15e2e739-ef1b-4d27-9e33-a1b1e47c896b"
],
"NonLaborAssignments": [
{
"Id": "bae6dc67-f515-47fe-bdbf-a36c2412f8ed",
"ResourceId": "1b0456b8-cc28-4d4f-b90d-1d2f9a47b820",
"Quantity": 3.0
},
{
"Id": "bae6dc67-f515-47fe-bdbf-a36c2412f8ed",
"ResourceId": "1b0456b8-cc28-4d4f-b90d-1d2f9a47b820",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b8358da2-912e-402d-b275-47c35006fffd",
"Type": 0,
"ResourceId": "5819c20b-34a0-4dcd-ae0f-d0b203547421",
"Units": 3.0
},
{
"Id": "b8358da2-912e-402d-b275-47c35006fffd",
"Type": 0,
"ResourceId": "5819c20b-34a0-4dcd-ae0f-d0b203547421",
"Units": 3.0
}
],
"ParentId": "bcb0a3ce-5203-4731-af4b-3a26c59c8982",
"WorkTypeParentId": "79947a57-8b58-4d58-b57b-5b3619a6b44b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "aea0a84b-1eeb-492d-8dff-571b12f3e7f8",
"UPN": "12d2bb8d-c67b-49a9-8eef-34c3601ba47e",
"PostDate": "2026-06-01T11:22:18.2793316+00:00",
"Comment": "sample string 4",
"CC": [
"fae62b45-086e-42f5-a2ae-9553f98be7f7",
"32bca680-cd34-415f-aba7-1df729d2645b"
],
"Users": [
"1aae56fa-9cf4-4d45-bd80-ca79c2855e60",
"a8cfea06-37dc-481e-9bc8-e9c5bd697a96"
]
},
{
"Id": "aea0a84b-1eeb-492d-8dff-571b12f3e7f8",
"UPN": "12d2bb8d-c67b-49a9-8eef-34c3601ba47e",
"PostDate": "2026-06-01T11:22:18.2793316+00:00",
"Comment": "sample string 4",
"CC": [
"fae62b45-086e-42f5-a2ae-9553f98be7f7",
"32bca680-cd34-415f-aba7-1df729d2645b"
],
"Users": [
"1aae56fa-9cf4-4d45-bd80-ca79c2855e60",
"a8cfea06-37dc-481e-9bc8-e9c5bd697a96"
]
}
],
"StartDate": "2026-06-01T11:22:18.2793316+00:00",
"DueDate": "2026-06-01T11:22:18.2793316+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9a724775-df2a-4778-afe0-2f5c3a32d3ed": "3a86b711-681e-4446-a435-0bf3ddfdc061",
"bae1cf38-8df0-4ef4-987b-6645e3f85041": "ebc37174-a52e-4e2a-982e-2b2c4a2a0531"
},
"HasUpdates": true,
"Modified": "2026-06-01T11:22:18.2793316+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-06-01T11:22:18.2793316+00:00"
},
"LastComment": "2026-06-01T11:22:18.2793316+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3b6418b7-3eb7-4713-9181-b7b7093149f2",
"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": "9fa3abee-79bb-4e66-806a-c26d2c535b5a",
"id": "f206d816-e2b8-4bb2-9fe4-4de40e8b8552",
"ConfigId": "fe476eda-121e-4bb2-9268-0dadea045b17"
}