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": "fbeb1a98-1751-404f-afc8-05308f1f4586",
"ParentTaskId": "abab386c-32d4-4631-a1ea-3519d327e25f",
"Integration": {
"IntegrationId": "c982fe70-a0c1-411f-8edd-09d06483c9be",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"623f283c-6e5f-45c4-ad7d-b982f5c34f28": 2.0,
"7f7df310-d2b3-46cc-95ec-9d43e91c7af5": 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": "e9bd220b-f7e3-487e-9e3e-d8ed487b4255",
"Name": "sample string 1",
"Created": "2026-07-03T15:19:15.6233126+00:00",
"Modified": "2026-07-03T15:19:15.6233126+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7fc81245-8f8e-4e3e-87f4-15918d01f9aa",
"d5bae989-8b69-44da-a541-372208c1d105"
],
"NonLaborAssignments": [
{
"Id": "1e8f7617-658b-4e92-b210-e4e8774aec61",
"ResourceId": "48c1e3d2-3c88-4c1d-ba5d-856fcab4666f",
"Quantity": 3.0
},
{
"Id": "1e8f7617-658b-4e92-b210-e4e8774aec61",
"ResourceId": "48c1e3d2-3c88-4c1d-ba5d-856fcab4666f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "79f7f09f-adbe-46a1-a1fb-12f50658789a",
"Type": 0,
"ResourceId": "64e929c2-7393-4a7a-a2cd-99673b2e6790",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "79f7f09f-adbe-46a1-a1fb-12f50658789a",
"Type": 0,
"ResourceId": "64e929c2-7393-4a7a-a2cd-99673b2e6790",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "66c27d10-3edf-4c9d-82ba-6e5728a9e9d5",
"WorkTypeParentId": "e3b1d3c6-9978-40ee-a650-bebc707ba67a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b046a124-c3e0-461d-8366-0f722b01e73e",
"UPN": "8fdb1074-e304-410e-bb7d-62680e019366",
"PostDate": "2026-07-03T15:19:15.6233126+00:00",
"Comment": "sample string 4",
"CC": [
"5e490d1d-9f5f-499a-a6c5-e2247e973514",
"72d5acb8-2433-48d4-ab6c-08bfcbba62a2"
],
"Users": [
"5cd6e2dc-da97-4deb-bff6-740e9c56899f",
"9a147587-05c6-4152-b612-9a7010a7f7db"
]
},
{
"Id": "b046a124-c3e0-461d-8366-0f722b01e73e",
"UPN": "8fdb1074-e304-410e-bb7d-62680e019366",
"PostDate": "2026-07-03T15:19:15.6233126+00:00",
"Comment": "sample string 4",
"CC": [
"5e490d1d-9f5f-499a-a6c5-e2247e973514",
"72d5acb8-2433-48d4-ab6c-08bfcbba62a2"
],
"Users": [
"5cd6e2dc-da97-4deb-bff6-740e9c56899f",
"9a147587-05c6-4152-b612-9a7010a7f7db"
]
}
],
"StartDate": "2026-07-03T15:19:15.6233126+00:00",
"DueDate": "2026-07-03T15:19:15.6233126+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"09ac4a48-2a3f-46cd-b38c-e1b93011abfc": "f40f518b-1f1e-4ee9-b0dc-9b4051f5a236",
"f4fe04c5-2d78-4898-bcbc-9f99a4b3544c": "3c4a7d8d-8eaf-40d9-98cd-5dd6f15aea2c"
},
"HasUpdates": true,
"Modified": "2026-07-03T15:19:15.6233126+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-07-03T15:19:15.6233126+00:00"
},
"LastComment": "2026-07-03T15:19:15.6233126+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "6e763fd0-ed57-4e4a-bb45-145e9cce5680",
"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": "3d8b7c07-8da9-43ad-b81f-4db6f73f4e63",
"id": "ea1db014-9ce2-4821-82f8-31b77c8a72dd",
"ConfigId": "1df26a88-eb77-485b-934c-22bc515cb22a"
}