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": "012b3114-1c4e-45b8-bc7c-7295e5331653",
"ParentTaskId": "fa4a7a21-5b0d-4833-bb3b-fbb524732a26",
"Integration": {
"IntegrationId": "d451c33f-43c7-47dc-97da-6993bce88c88",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1ef5db60-901a-4897-8339-3b87702f13dd": 2.0,
"f74ef426-3b1a-45bd-a549-43140faf4831": 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": "b87cbaef-8283-42c7-b872-ec6fbcccdefc",
"Name": "sample string 1",
"Created": "2026-06-28T08:34:20.7145405+00:00",
"Modified": "2026-06-28T08:34:20.7145405+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bdff4517-852e-4671-a7e4-137dd6681a02",
"26412fa9-73df-4d7b-8e39-c40514b18bab"
],
"NonLaborAssignments": [
{
"Id": "55301077-774d-48e5-98c2-e8ee8ad8f5e4",
"ResourceId": "7db222b9-4024-4044-b900-f91dce65651f",
"Quantity": 3.0
},
{
"Id": "55301077-774d-48e5-98c2-e8ee8ad8f5e4",
"ResourceId": "7db222b9-4024-4044-b900-f91dce65651f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "baef2ac0-17af-4b38-bc15-62e43180448e",
"Type": 0,
"ResourceId": "de8945ff-e8d2-4b2b-b325-9b90a051c2e6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "baef2ac0-17af-4b38-bc15-62e43180448e",
"Type": 0,
"ResourceId": "de8945ff-e8d2-4b2b-b325-9b90a051c2e6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "3a7c33fc-90c1-49c4-84c8-0e0b89058b70",
"WorkTypeParentId": "cb164ade-d7fb-44fe-b862-c6df1f2d401d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "227903af-8310-4db6-8722-e2ba7e55d0a9",
"UPN": "1f68a89c-2f7d-4855-8b14-e31245238fef",
"PostDate": "2026-06-28T08:34:20.7145405+00:00",
"Comment": "sample string 4",
"CC": [
"a5f04de0-2ab8-4006-b106-4b5f382b008e",
"69260376-afdc-41b7-b66e-fe0844418a0d"
],
"Users": [
"ce52fedd-22c0-438d-9e8e-540cc86701ca",
"fb4903f6-1066-47ce-8978-86a21a85b907"
]
},
{
"Id": "227903af-8310-4db6-8722-e2ba7e55d0a9",
"UPN": "1f68a89c-2f7d-4855-8b14-e31245238fef",
"PostDate": "2026-06-28T08:34:20.7145405+00:00",
"Comment": "sample string 4",
"CC": [
"a5f04de0-2ab8-4006-b106-4b5f382b008e",
"69260376-afdc-41b7-b66e-fe0844418a0d"
],
"Users": [
"ce52fedd-22c0-438d-9e8e-540cc86701ca",
"fb4903f6-1066-47ce-8978-86a21a85b907"
]
}
],
"StartDate": "2026-06-28T08:34:20.7145405+00:00",
"DueDate": "2026-06-28T08:34:20.7145405+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"37ae2990-a792-4345-abc8-5e8c1204ecb2": "420e1dde-ece6-4f81-8956-735014f9dc61",
"406fd047-696b-4fcd-9d2d-2e8c481001d9": "337cec6c-cf2d-468a-b83e-e05384f6f612"
},
"HasUpdates": true,
"Modified": "2026-06-28T08:34:20.7145405+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-28T08:34:20.7145405+00:00"
},
"LastComment": "2026-06-28T08:34:20.7145405+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a32dac07-58dc-427c-bb08-4528ecb05558",
"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": "f544fffc-6d0f-43a0-9e4e-a1aed3ef8169",
"id": "4997f288-c054-45e0-9f82-9e04223b3df1",
"ConfigId": "ab67684d-c7b4-49ea-9d3c-81147dbc61cf"
}