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": "817810b4-54ea-40f1-adc5-515f38f579c6",
"ParentTaskId": "9142f838-5bd4-4236-8f25-8440fc2132dc",
"Integration": {
"IntegrationId": "022314a3-4ef1-4e28-b32f-056ab5c1cef5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"bbd0d0cd-7362-451f-bb24-fdf035fd1d3d": 2.0,
"c04f9b2a-ccb6-4753-a576-378135357446": 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": "b2b124b5-3384-4131-8664-ad65af978939",
"Name": "sample string 1",
"Created": "2026-02-22T07:10:56.5597338+00:00",
"Modified": "2026-02-22T07:10:56.5597338+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2ea66a26-9e44-4373-ae5c-a53bb2e5e8ba",
"e2a9cf9a-75f4-4eb9-a2aa-3d2c9c18601f"
],
"NonLaborAssignments": [
{
"Id": "73fc6993-c0e0-4697-8913-b8833e548704",
"ResourceId": "e6992872-1b16-4975-98f1-8111035722de",
"Quantity": 3.0
},
{
"Id": "73fc6993-c0e0-4697-8913-b8833e548704",
"ResourceId": "e6992872-1b16-4975-98f1-8111035722de",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "bba7184c-dbe6-4d39-9a87-aeeb7f0e4c6b",
"Type": 0,
"ResourceId": "143e9e91-f9d8-403b-99c4-d37a570d5b0e",
"Units": 3.0
},
{
"Id": "bba7184c-dbe6-4d39-9a87-aeeb7f0e4c6b",
"Type": 0,
"ResourceId": "143e9e91-f9d8-403b-99c4-d37a570d5b0e",
"Units": 3.0
}
],
"ParentId": "cd23596f-327f-4d1c-8937-864fde8b1c9c",
"WorkTypeParentId": "49973b0c-f482-4f0f-bed6-16bebdb390e3",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "6728dc3d-d035-4709-8f2c-bbfd65fa9d62",
"UPN": "8d8d7570-966b-4a6c-ac32-7cca44d803cc",
"PostDate": "2026-02-22T07:10:56.5597338+00:00",
"Comment": "sample string 4",
"CC": [
"225d5eab-4037-4417-80e4-8b35af98ed06",
"4a8442b8-c9b3-4223-a27e-ca4b0c24e04f"
],
"Users": [
"572844c0-4c76-475a-9c12-2ce61fc34bb6",
"0aff02df-afa3-4e08-b747-e0535596d3df"
]
},
{
"Id": "6728dc3d-d035-4709-8f2c-bbfd65fa9d62",
"UPN": "8d8d7570-966b-4a6c-ac32-7cca44d803cc",
"PostDate": "2026-02-22T07:10:56.5597338+00:00",
"Comment": "sample string 4",
"CC": [
"225d5eab-4037-4417-80e4-8b35af98ed06",
"4a8442b8-c9b3-4223-a27e-ca4b0c24e04f"
],
"Users": [
"572844c0-4c76-475a-9c12-2ce61fc34bb6",
"0aff02df-afa3-4e08-b747-e0535596d3df"
]
}
],
"StartDate": "2026-02-22T07:10:56.5597338+00:00",
"DueDate": "2026-02-22T07:10:56.5597338+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6ad1291a-a8d4-4e4a-ac93-889007eebb13": "6749e9da-c5d3-4863-b4fd-9c2c1b17c61f",
"957ad608-ba7b-439d-b29f-92e572ed2440": "776f7361-92e5-410c-8b89-f3a4f2bcb48d"
},
"HasUpdates": true,
"Modified": "2026-02-22T07:10:56.5597338+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-22T07:10:56.5597338+00:00"
},
"LastComment": "2026-02-22T07:10:56.5597338+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "7f931a3e-562b-4924-9c30-1753886b70b3",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "5e5a8894-eb62-4313-9cf6-8811a5e6a942",
"id": "2006e67e-3a2a-4cfa-aac9-7253beea304a",
"ConfigId": "d7df6c95-cbc3-471b-8533-3e6423fd58e1"
}