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": "210a3bc6-e1e0-4319-acd8-79ca410425e9",
"ParentTaskId": "2bb19a79-b64f-4cf0-8405-533c709da75f",
"Integration": {
"IntegrationId": "f185a30a-6ee4-45b9-b119-b108251514ef",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"ed2d89cd-b26b-41e0-87de-77b61efecdc3": 2.0,
"bd6dbc77-6429-4466-8957-201443bbe7e3": 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": "8a843447-3175-420f-992e-6e6605c996df",
"Name": "sample string 1",
"Created": "2026-06-30T17:40:28.0641764+00:00",
"Modified": "2026-06-30T17:40:28.0641764+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b163dbce-0939-4b15-8f61-e1f5e2dabca4",
"c50ba7c9-8bb1-4cca-8b16-c6aa947e75b6"
],
"NonLaborAssignments": [
{
"Id": "7cb44b42-1c07-49c7-89e3-b1492ee27473",
"ResourceId": "139130db-520b-405d-b56b-9c85671966a5",
"Quantity": 3.0
},
{
"Id": "7cb44b42-1c07-49c7-89e3-b1492ee27473",
"ResourceId": "139130db-520b-405d-b56b-9c85671966a5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e9c14a65-5c07-4069-a52f-e01cfcd75e6f",
"Type": 0,
"ResourceId": "6408b0f4-485c-4274-b638-5764c96eae3a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "e9c14a65-5c07-4069-a52f-e01cfcd75e6f",
"Type": 0,
"ResourceId": "6408b0f4-485c-4274-b638-5764c96eae3a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "06d60cc3-c707-4a3e-9964-0114107bf6cc",
"WorkTypeParentId": "c679ebe8-bbfe-443c-924e-39f48f437748",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ad801e37-5052-4e3a-b5b9-b4ee99aa2fdf",
"UPN": "83d46879-d859-44d8-b9c6-5c55cddc074f",
"PostDate": "2026-06-30T17:40:28.0641764+00:00",
"Comment": "sample string 4",
"CC": [
"42f9a7b0-620d-4be0-8501-dab7af935a10",
"ac9f52ce-85b7-41a1-85ba-be13009a6b21"
],
"Users": [
"21085288-16b3-4e3c-abee-d848aeaa3c65",
"b2dba149-e41a-45b4-8e93-89eb9bde88aa"
]
},
{
"Id": "ad801e37-5052-4e3a-b5b9-b4ee99aa2fdf",
"UPN": "83d46879-d859-44d8-b9c6-5c55cddc074f",
"PostDate": "2026-06-30T17:40:28.0641764+00:00",
"Comment": "sample string 4",
"CC": [
"42f9a7b0-620d-4be0-8501-dab7af935a10",
"ac9f52ce-85b7-41a1-85ba-be13009a6b21"
],
"Users": [
"21085288-16b3-4e3c-abee-d848aeaa3c65",
"b2dba149-e41a-45b4-8e93-89eb9bde88aa"
]
}
],
"StartDate": "2026-06-30T17:40:28.0641764+00:00",
"DueDate": "2026-06-30T17:40:28.0641764+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"612d2ea5-44a7-4f2f-98c3-17a0c8809276": "41b427b3-1cf6-4fbb-98a8-2e353519cc0f",
"2848b517-a092-4fcb-843a-8f3ceb162208": "6ad7178b-e526-4bea-9326-504d75b7e313"
},
"HasUpdates": true,
"Modified": "2026-06-30T17:40:28.0641764+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-30T17:40:28.0641764+00:00"
},
"LastComment": "2026-06-30T17:40:28.0641764+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d5d8a312-d9b9-4376-850c-1cae4b723703",
"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": "2310bf26-f90c-4a74-9096-f8e1525456c0",
"id": "3e823034-532a-402a-a3fe-6cc5c6c62623",
"ConfigId": "6d5a037c-13c9-46a7-ad9b-59460da43ff3"
}