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": "f3c2bd3d-9c8c-4870-9b02-8617c5b5e5b7",
"ParentTaskId": "8ea2fd90-614f-4cbf-acd6-a774191f39d0",
"Integration": {
"IntegrationId": "c5c97dab-db3d-49b3-b8e5-356ddac610ee",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bb72b499-e558-4b63-8dc2-24ee540ad134": 2.0,
"ec6700a0-0199-44d8-9e2f-526b1f4b7aae": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "a239ed5b-b5e3-416b-938e-2636e776c5d8",
"Name": "sample string 1",
"Created": "2026-03-14T01:17:26.6407646+00:00",
"Modified": "2026-03-14T01:17:26.6407646+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"a36ca66f-1075-4ecb-81ff-d3a1a1aa4fcc",
"1c434fa8-1d21-44ad-b945-a14bacdaff08"
],
"NonLaborAssignments": [
{
"Id": "8e87cab7-8ee6-47e2-8d15-ac48441b2cd9",
"ResourceId": "3931d7b6-211e-45ed-8f56-be517e4cd16d",
"Quantity": 3.0
},
{
"Id": "8e87cab7-8ee6-47e2-8d15-ac48441b2cd9",
"ResourceId": "3931d7b6-211e-45ed-8f56-be517e4cd16d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d8dc8916-da9f-43b5-9f31-f2fb5b67e4b1",
"Type": 0,
"ResourceId": "cea7f11e-4eca-4a0b-8cc2-cb58102e8640",
"Units": 3.0
},
{
"Id": "d8dc8916-da9f-43b5-9f31-f2fb5b67e4b1",
"Type": 0,
"ResourceId": "cea7f11e-4eca-4a0b-8cc2-cb58102e8640",
"Units": 3.0
}
],
"ParentId": "d077d54e-918f-44a2-8fa8-8c3dc98d3a8e",
"WorkTypeParentId": "c38428f7-3815-4a89-a2cf-dc9e66f1646a",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "fe6b302a-ec5b-4088-8754-99ba13ba77f4",
"UPN": "bc45a6b5-a56c-466b-a468-f734d75fa96d",
"PostDate": "2026-03-14T01:17:26.6407646+00:00",
"Comment": "sample string 4",
"CC": [
"6fe72990-ba07-4cfc-900b-43ae35d99b7a",
"351d22b8-431d-4549-809b-03e7b373e970"
],
"Users": [
"856ff83a-43ee-4fdb-8f79-0ba04e48c12d",
"89b4b33d-4f3b-49fd-a626-cd441660774d"
]
},
{
"Id": "fe6b302a-ec5b-4088-8754-99ba13ba77f4",
"UPN": "bc45a6b5-a56c-466b-a468-f734d75fa96d",
"PostDate": "2026-03-14T01:17:26.6407646+00:00",
"Comment": "sample string 4",
"CC": [
"6fe72990-ba07-4cfc-900b-43ae35d99b7a",
"351d22b8-431d-4549-809b-03e7b373e970"
],
"Users": [
"856ff83a-43ee-4fdb-8f79-0ba04e48c12d",
"89b4b33d-4f3b-49fd-a626-cd441660774d"
]
}
],
"StartDate": "2026-03-14T01:17:26.6407646+00:00",
"DueDate": "2026-03-14T01:17:26.6407646+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b7c17e79-6862-4427-889a-d70e7d39aaac": "35402f4c-5a86-4281-8d7b-f9020b109024",
"a2ca0f09-dfb0-4a5c-8bae-b18edef907ea": "9de7fbbd-5958-475f-ac45-c66635060e40"
},
"HasUpdates": true,
"Modified": "2026-03-14T01:17:26.6407646+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-03-14T01:17:26.6407646+00:00"
},
"LastComment": "2026-03-14T01:17:26.6407646+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "50af849d-06fc-4395-a06c-bab1f2836bb2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "1d6680ef-49e3-472a-b5e6-d41499c3b834",
"id": "44385799-e06c-4d35-81d2-dbc7939f9c88",
"ConfigId": "ab15cc00-e33c-41f2-b0c0-8ef64a645d92"
}