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": "22956a99-4933-43da-9654-4c12da2261d3",
"ParentTaskId": "cebe216d-2f17-49f5-8db6-ccce50b19367",
"Integration": {
"IntegrationId": "c71810dc-1e60-4ee0-b1af-e8d1ca86bf4c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"735a4a89-19f1-49e8-8027-b9404242a91a": 2.0,
"857e13fb-1ea9-45fa-85c5-6aa9c237b8b7": 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. |
|
| LinkedFileIds | Collection of string |
None. |
|
| LinkedLinkIds | Collection of string |
None. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "c08bc2a6-fe44-4d45-945c-3dd8d2ee8e40",
"Name": "sample string 1",
"Created": "2026-07-17T19:21:36.2761795+00:00",
"Modified": "2026-07-17T19:21:36.2761795+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bf2cfe8f-0788-4f9b-a037-a1d67a793673",
"560ff037-73dc-475d-b972-ce202e4385fa"
],
"NonLaborAssignments": [
{
"Id": "cbbb2d4c-2cda-435b-bba7-851c0f5909c3",
"ResourceId": "63feb3fc-0707-4bfd-b3f8-b8e0dcae644a",
"Quantity": 3.0
},
{
"Id": "cbbb2d4c-2cda-435b-bba7-851c0f5909c3",
"ResourceId": "63feb3fc-0707-4bfd-b3f8-b8e0dcae644a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "583b4f71-8836-4346-8948-433d3fdee9f6",
"Type": 0,
"ResourceId": "c6b9d5d1-d1d6-428d-9d6c-bd494908bbb6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "583b4f71-8836-4346-8948-433d3fdee9f6",
"Type": 0,
"ResourceId": "c6b9d5d1-d1d6-428d-9d6c-bd494908bbb6",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "537f3985-dc7b-4665-a0b4-f77f75ca2e98",
"WorkTypeParentId": "f8b37560-00b6-44c8-b2c8-9320154f4a39",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "df1b3eac-67d0-4558-88ab-b97371710230",
"UPN": "177fc56c-9a37-44f3-bd2c-07881ed888a1",
"PostDate": "2026-07-17T19:21:36.2761795+00:00",
"Comment": "sample string 4",
"CC": [
"742d4310-cc8f-41dd-b9ca-a7aba9160f6e",
"687fb591-2560-4946-aa13-39b15d233460"
],
"Users": [
"804afbec-4768-4d60-91db-78e99b589d2d",
"9e5b6578-8aba-491a-8319-db58497c542e"
]
},
{
"Id": "df1b3eac-67d0-4558-88ab-b97371710230",
"UPN": "177fc56c-9a37-44f3-bd2c-07881ed888a1",
"PostDate": "2026-07-17T19:21:36.2761795+00:00",
"Comment": "sample string 4",
"CC": [
"742d4310-cc8f-41dd-b9ca-a7aba9160f6e",
"687fb591-2560-4946-aa13-39b15d233460"
],
"Users": [
"804afbec-4768-4d60-91db-78e99b589d2d",
"9e5b6578-8aba-491a-8319-db58497c542e"
]
}
],
"StartDate": "2026-07-17T19:21:36.2761795+00:00",
"DueDate": "2026-07-17T19:21:36.2761795+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"4a829a15-64a2-49a0-b070-2338c1fde0c8": "69b624e9-0cd0-43ac-85cf-f87519faf841",
"9ddf1bd5-5363-44f4-a542-6493dcf8b5cf": "788e3456-e08e-4e4a-87e6-5527858e25dd"
},
"HasUpdates": true,
"Modified": "2026-07-17T19:21:36.2761795+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-07-17T19:21:36.2761795+00:00"
},
"LastComment": "2026-07-17T19:21:36.2761795+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "8c3595c0-1039-45e0-8a50-b2bb357d9faf",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"LinkedFileIds": [
"sample string 1",
"sample string 2"
],
"LinkedLinkIds": [
"sample string 1",
"sample string 2"
],
"WorkPlanId": "31e91466-a0f5-46f7-8466-cd20386298de",
"id": "7fbbbe25-c80e-45eb-aaf2-fbc36472a30f",
"ConfigId": "f6c05c4a-9556-47c7-ae62-65bcd4f3fd2a"
}