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": "3def3402-3f8d-44f3-ae43-35d23367f6ea",
"ParentTaskId": "6c90ab51-733e-40f4-bbf9-b5f066270fe4",
"Integration": {
"IntegrationId": "eb31fde7-bf3c-4dfa-88c7-315a94e4e5fb",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f514ddda-4bfc-4079-a916-1f81f69045fd": 2.0,
"d442fbca-8107-4470-bf11-200855d56e42": 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": "88448c66-d1d8-4fa5-8224-8646e081fff0",
"Name": "sample string 1",
"Created": "2025-11-23T06:40:12.4170227+00:00",
"Modified": "2025-11-23T06:40:12.4170227+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e3b8d058-eda6-4ffe-87c5-362741447324",
"c10c4fb3-c0de-463d-9ae2-bdd87be3abcd"
],
"NonLaborAssignments": [
{
"Id": "71d8a427-d78e-4f82-a568-a77864eac040",
"ResourceId": "86a5497f-0a9d-4a1d-9c6d-f2b7d0136af9",
"Quantity": 3.0
},
{
"Id": "71d8a427-d78e-4f82-a568-a77864eac040",
"ResourceId": "86a5497f-0a9d-4a1d-9c6d-f2b7d0136af9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d8fddbb7-5c4a-43a4-850b-eff5bd7d5ff0",
"Type": 0,
"ResourceId": "3dc7baa7-6ec7-4212-883c-2ef1b5582aa6",
"Units": 3.0
},
{
"Id": "d8fddbb7-5c4a-43a4-850b-eff5bd7d5ff0",
"Type": 0,
"ResourceId": "3dc7baa7-6ec7-4212-883c-2ef1b5582aa6",
"Units": 3.0
}
],
"ParentId": "ae355d42-df63-44fd-974d-5a2f3de9c57b",
"WorkTypeParentId": "041e0214-d828-45e5-9843-a2a9169ae269",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "71182ed1-2e57-48ca-a21f-2dba1c86dc26",
"UPN": "861a19d2-e253-4d90-b9e3-6142224992de",
"PostDate": "2025-11-23T06:40:12.4326282+00:00",
"Comment": "sample string 4",
"CC": [
"81d9953a-ee69-497e-8802-856e151eafad",
"6dc3dfef-c337-4dc0-8cb2-a64f2cc4dc80"
],
"Users": [
"be2c8a1d-63f2-4efb-9dda-c86e21e97d6c",
"2c8819ef-bc47-43b7-9401-739798de14a1"
]
},
{
"Id": "71182ed1-2e57-48ca-a21f-2dba1c86dc26",
"UPN": "861a19d2-e253-4d90-b9e3-6142224992de",
"PostDate": "2025-11-23T06:40:12.4326282+00:00",
"Comment": "sample string 4",
"CC": [
"81d9953a-ee69-497e-8802-856e151eafad",
"6dc3dfef-c337-4dc0-8cb2-a64f2cc4dc80"
],
"Users": [
"be2c8a1d-63f2-4efb-9dda-c86e21e97d6c",
"2c8819ef-bc47-43b7-9401-739798de14a1"
]
}
],
"StartDate": "2025-11-23T06:40:12.4326282+00:00",
"DueDate": "2025-11-23T06:40:12.4326282+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"710f300d-3602-4e81-b3b0-912f3c43d871": "300817d3-2ec8-40ad-858f-245e880fcb99",
"14c06f48-7e4a-4e0c-a7a5-a1954de67e06": "f692b3df-53db-46d5-95f7-509dc8312232"
},
"HasUpdates": true,
"Modified": "2025-11-23T06:40:12.4326282+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": "2025-11-23T06:40:12.4326282+00:00"
},
"LastComment": "2025-11-23T06:40:12.4326282+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "50e45e36-f39b-4823-9d3b-7b986bf9cba1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "80869926-bb8b-4525-8c29-4f0c50522450",
"id": "85a96603-cf00-47ea-9b64-08eee6af36bd",
"ConfigId": "cfa5b566-6d62-43aa-bca6-9a634a76765d"
}