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": "f80daf32-91de-4ebe-becb-f74ccddc1210",
"ParentTaskId": "d3745564-ee4f-4143-8c3b-e523fa4e4ff0",
"Integration": {
"IntegrationId": "941f2079-e971-4c6c-810e-05f982d540ea",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1938d150-cc82-4b12-a92c-fc3986d5b6a9": 2.0,
"368c7a2d-224f-4566-ab2a-0ed881d9b72a": 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": "ca053dfd-a3eb-476f-b3ba-b7a3fbaf9856",
"Name": "sample string 1",
"Created": "2026-02-07T13:49:28.7449913+00:00",
"Modified": "2026-02-07T13:49:28.7449913+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"091f473b-8de8-420a-8c16-7fe95ea1c685",
"80d1b509-9844-48b2-b101-7032efc31978"
],
"NonLaborAssignments": [
{
"Id": "fca2b856-5733-4f25-9f5f-0201ca0b13bf",
"ResourceId": "93fd0775-5e61-4339-b342-f91f16748502",
"Quantity": 3.0
},
{
"Id": "fca2b856-5733-4f25-9f5f-0201ca0b13bf",
"ResourceId": "93fd0775-5e61-4339-b342-f91f16748502",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "074a08de-bd6a-4a0d-b3c0-a9eb0e855f7f",
"Type": 0,
"ResourceId": "086943c1-eb35-4420-ad77-d2d4b8b5a64a",
"Units": 3.0
},
{
"Id": "074a08de-bd6a-4a0d-b3c0-a9eb0e855f7f",
"Type": 0,
"ResourceId": "086943c1-eb35-4420-ad77-d2d4b8b5a64a",
"Units": 3.0
}
],
"ParentId": "8dda257c-c553-4383-a255-f3ba44a8f71d",
"WorkTypeParentId": "7e922a46-e60c-42d6-bc70-1cd81e85fc7c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "bed496d2-99e7-45b4-abd2-08ad42c86b36",
"UPN": "4a7731c5-0bd2-4a2b-bed9-cf96fe940c08",
"PostDate": "2026-02-07T13:49:28.7449913+00:00",
"Comment": "sample string 4",
"CC": [
"8c30fa0d-9478-40d8-b645-c49b9a1033dd",
"f506c652-eae4-438f-be08-e1826ddd9eb4"
],
"Users": [
"f815b605-0b0f-4028-8175-69eb2eacb63b",
"d4073ea7-7376-4a2d-97b8-a41092ff41b0"
]
},
{
"Id": "bed496d2-99e7-45b4-abd2-08ad42c86b36",
"UPN": "4a7731c5-0bd2-4a2b-bed9-cf96fe940c08",
"PostDate": "2026-02-07T13:49:28.7449913+00:00",
"Comment": "sample string 4",
"CC": [
"8c30fa0d-9478-40d8-b645-c49b9a1033dd",
"f506c652-eae4-438f-be08-e1826ddd9eb4"
],
"Users": [
"f815b605-0b0f-4028-8175-69eb2eacb63b",
"d4073ea7-7376-4a2d-97b8-a41092ff41b0"
]
}
],
"StartDate": "2026-02-07T13:49:28.7449913+00:00",
"DueDate": "2026-02-07T13:49:28.7449913+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2d54b786-747e-41fc-8da4-dcab6d4e7943": "0c5ec94d-399a-4048-a1df-a84c4b5f2b20",
"9378b4a3-179b-4a2b-8ad6-2fe54fe22311": "c99926d2-62c1-4278-b616-098226574a7d"
},
"HasUpdates": true,
"Modified": "2026-02-07T13:49:28.7449913+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-07T13:49:28.7449913+00:00"
},
"LastComment": "2026-02-07T13:49:28.7449913+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ec8610ce-8e8e-4a08-9b4b-fb8074ce2971",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "c5f7569d-30af-4ddd-bb58-786adeeabe22",
"id": "0c108f23-913c-45d8-addf-be9979078b28",
"ConfigId": "f2ec9a7c-b6da-439a-ac01-4ed946e14ea8"
}