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": "2c45d402-bb3a-4c19-8958-c9aaf5bc0186",
"ParentTaskId": "7ae17188-23c2-4094-add7-452f86481527",
"Integration": {
"IntegrationId": "b9c14e45-93eb-42de-bc8e-08ae40025711",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"016c55f8-f149-46d9-ae74-dbc86dcba94f": 2.0,
"ad36f435-4554-4309-8f1f-6441c3e195d9": 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": "0d3989df-ef3a-4e20-a560-59371e56f740",
"Name": "sample string 1",
"Created": "2026-08-11T05:47:26.0007077+00:00",
"Modified": "2026-08-11T05:47:26.0007077+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8d14669f-804d-4c29-96da-c0f202fa7448",
"c4b2abaa-7d8e-49af-8da6-cb2773efd188"
],
"NonLaborAssignments": [
{
"Id": "1fcb9743-b2e3-4bb7-a888-0b6bc005ce85",
"ResourceId": "c919799a-6f12-4dd4-a3ee-9acf26475439",
"Quantity": 3.0
},
{
"Id": "1fcb9743-b2e3-4bb7-a888-0b6bc005ce85",
"ResourceId": "c919799a-6f12-4dd4-a3ee-9acf26475439",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b550be26-fde4-40df-b0c6-8d0f1bbe5ca4",
"Type": 0,
"ResourceId": "39a5dd11-85e7-48ed-9a5b-4ad6618ed6f7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "b550be26-fde4-40df-b0c6-8d0f1bbe5ca4",
"Type": 0,
"ResourceId": "39a5dd11-85e7-48ed-9a5b-4ad6618ed6f7",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "9c513e8e-25be-4cb2-8688-909531c5fbeb",
"WorkTypeParentId": "639b8ff3-4916-4997-9856-f539a783f937",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8f5c549b-74da-47fa-863e-06435f7ecb14",
"UPN": "a282b712-85a5-475c-80e7-a051732911ba",
"PostDate": "2026-08-11T05:47:26.0007077+00:00",
"Comment": "sample string 4",
"CC": [
"39b7e206-9517-4df7-a216-199a1efacf2b",
"e50410ce-9065-4f29-aa96-7ab21e620f10"
],
"Users": [
"442b8107-aeb6-4b1c-8d07-08d324185b0c",
"63c66307-eabd-42f9-8ecf-23de0de6b27b"
]
},
{
"Id": "8f5c549b-74da-47fa-863e-06435f7ecb14",
"UPN": "a282b712-85a5-475c-80e7-a051732911ba",
"PostDate": "2026-08-11T05:47:26.0007077+00:00",
"Comment": "sample string 4",
"CC": [
"39b7e206-9517-4df7-a216-199a1efacf2b",
"e50410ce-9065-4f29-aa96-7ab21e620f10"
],
"Users": [
"442b8107-aeb6-4b1c-8d07-08d324185b0c",
"63c66307-eabd-42f9-8ecf-23de0de6b27b"
]
}
],
"StartDate": "2026-08-11T05:47:26.0007077+00:00",
"DueDate": "2026-08-11T05:47:26.0007077+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5e62cbb2-349e-45cc-8730-b5da6ba9830f": "ad5a5bfa-d1dc-4990-bb2b-2a442831aee3",
"7d8a74a3-1ec0-4702-ad9c-37f8cff8ef15": "0f73a420-4384-4d82-b466-9c86392c2bb0"
},
"HasUpdates": true,
"Modified": "2026-08-11T05:47:26.0007077+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-11T05:47:26.0007077+00:00"
},
"LastComment": "2026-08-11T05:47:26.0007077+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c8c02215-9ecf-44b7-8979-737029c069a5",
"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": "06f4252c-8b71-442a-a069-e4d2c4fdbbce",
"id": "93cc9a23-f748-40ae-bc66-33256dcb5f4d",
"ConfigId": "84fb8b17-106e-468d-b195-2ede8d4567eb"
}