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": "dcb28b75-2cfb-463a-84d7-b477a8e6d2a8",
"ParentTaskId": "8f248671-3d4f-492b-a02b-504e6e17d9aa",
"Integration": {
"IntegrationId": "0f795d9f-8500-45ac-a128-987f368b9dc0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bb7c9dd9-6c78-44cc-b74c-46ca46491529": 2.0,
"07895935-5c0a-4d18-800f-76a6fb214d23": 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": "878e2191-beaa-4e2f-a64c-1e6f82a9aa25",
"Name": "sample string 1",
"Created": "2026-02-10T14:14:06.6962935+00:00",
"Modified": "2026-02-10T14:14:06.6962935+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"34411e99-5a15-4bd8-bc8e-acd172a25f47",
"a2422bd0-be57-4ae8-885c-c132b88343f0"
],
"NonLaborAssignments": [
{
"Id": "9eb766a1-5a84-45ac-8e9c-7bcab7dd0473",
"ResourceId": "768c666f-f69b-41cc-84bf-4d7451e97265",
"Quantity": 3.0
},
{
"Id": "9eb766a1-5a84-45ac-8e9c-7bcab7dd0473",
"ResourceId": "768c666f-f69b-41cc-84bf-4d7451e97265",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "a29d9bad-5db2-457c-9815-e675acfba405",
"Type": 0,
"ResourceId": "7e3aa9c6-96ee-421d-a265-b64963ce94e3",
"Units": 3.0
},
{
"Id": "a29d9bad-5db2-457c-9815-e675acfba405",
"Type": 0,
"ResourceId": "7e3aa9c6-96ee-421d-a265-b64963ce94e3",
"Units": 3.0
}
],
"ParentId": "b1082cfa-cc26-406f-9dfa-52aaecdc3011",
"WorkTypeParentId": "45eb39a2-0fba-4037-9578-fe273f80460f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6162fccb-fd67-4d60-bba6-9a6b38561e3d",
"UPN": "848f3357-a196-43d2-b052-fa9d2852a7dc",
"PostDate": "2026-02-10T14:14:06.6962935+00:00",
"Comment": "sample string 4",
"CC": [
"d3dddebc-28c1-4cc8-8a4f-c0ddda6c8e26",
"35a8cd25-e620-4377-af2f-3e4ee698f07a"
],
"Users": [
"731738e8-853c-4e75-8626-99e0d5ddaf5d",
"3833cabb-32c1-4991-9faf-59072e75d837"
]
},
{
"Id": "6162fccb-fd67-4d60-bba6-9a6b38561e3d",
"UPN": "848f3357-a196-43d2-b052-fa9d2852a7dc",
"PostDate": "2026-02-10T14:14:06.6962935+00:00",
"Comment": "sample string 4",
"CC": [
"d3dddebc-28c1-4cc8-8a4f-c0ddda6c8e26",
"35a8cd25-e620-4377-af2f-3e4ee698f07a"
],
"Users": [
"731738e8-853c-4e75-8626-99e0d5ddaf5d",
"3833cabb-32c1-4991-9faf-59072e75d837"
]
}
],
"StartDate": "2026-02-10T14:14:06.6962935+00:00",
"DueDate": "2026-02-10T14:14:06.6962935+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"86028075-e0a9-4d0a-b756-b5b14981fe61": "c5e22630-75ce-410d-be06-baf3b2c73831",
"1842f0f3-4e74-4c03-99f7-200af79dff42": "0e147b87-fe65-41a3-af19-75357eb31785"
},
"HasUpdates": true,
"Modified": "2026-02-10T14:14:06.6962935+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-02-10T14:14:06.6962935+00:00"
},
"LastComment": "2026-02-10T14:14:06.6962935+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4df7b206-0370-4a79-b718-b305c5ba999b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "09ef524f-30d0-4aef-95ee-ab5007a16ecc",
"id": "7febbeb6-56d8-4dfe-8bcd-35f93e16b0b2",
"ConfigId": "a7531b57-1711-4d88-b50f-c45c1413158e"
}