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": "2e3872c0-d58f-459e-af8d-7b50e0d194fc",
"ParentTaskId": "4e6894c8-9c20-4106-aa43-c3ef95568780",
"Integration": {
"IntegrationId": "96aa11c2-452a-44e2-bfcb-89d2507917a0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"edbae668-e509-475b-aa8b-0f2c0539671e": 2.0,
"2e3c77b4-907e-4bae-8357-6ae13ee4d8e1": 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": "14f78ff7-1cf3-4ce0-80dc-3af166d3c8a5",
"Name": "sample string 1",
"Created": "2026-07-14T01:39:29.3041535+00:00",
"Modified": "2026-07-14T01:39:29.3041535+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"8c02f7bc-2131-4a1e-9d10-f62d5d8d1102",
"6fd51a16-057a-44b4-baf3-7fded9622ed5"
],
"NonLaborAssignments": [
{
"Id": "981deb5e-4ba2-438f-b608-995bfaa2cb11",
"ResourceId": "e77d3772-9eb6-447a-962c-7f52deb2bc94",
"Quantity": 3.0
},
{
"Id": "981deb5e-4ba2-438f-b608-995bfaa2cb11",
"ResourceId": "e77d3772-9eb6-447a-962c-7f52deb2bc94",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "286712de-5eaa-4064-bd2a-53e059973dc7",
"Type": 0,
"ResourceId": "366112e0-84ec-49c6-8ffd-472d79fc20e8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "286712de-5eaa-4064-bd2a-53e059973dc7",
"Type": 0,
"ResourceId": "366112e0-84ec-49c6-8ffd-472d79fc20e8",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "1eed83c4-3b50-41f3-9bbc-7ad179c19064",
"WorkTypeParentId": "24aacf88-8c9e-4038-a4bf-d3c14c06fbd7",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "522b755d-5975-4a94-a5fe-1c1e48edd0eb",
"UPN": "d7a7ed69-db9a-446c-8e58-17da88029d77",
"PostDate": "2026-07-14T01:39:29.3041535+00:00",
"Comment": "sample string 4",
"CC": [
"83c6322c-e95f-4453-89a8-790ff497e2f6",
"2eac864c-89ae-4708-8094-4b3fdea554f1"
],
"Users": [
"c6d215d9-8922-4360-88fd-8bdf1388f608",
"c21ab85c-3a22-4d53-a5a6-baf023650b77"
]
},
{
"Id": "522b755d-5975-4a94-a5fe-1c1e48edd0eb",
"UPN": "d7a7ed69-db9a-446c-8e58-17da88029d77",
"PostDate": "2026-07-14T01:39:29.3041535+00:00",
"Comment": "sample string 4",
"CC": [
"83c6322c-e95f-4453-89a8-790ff497e2f6",
"2eac864c-89ae-4708-8094-4b3fdea554f1"
],
"Users": [
"c6d215d9-8922-4360-88fd-8bdf1388f608",
"c21ab85c-3a22-4d53-a5a6-baf023650b77"
]
}
],
"StartDate": "2026-07-14T01:39:29.3041535+00:00",
"DueDate": "2026-07-14T01:39:29.3041535+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0492e5c5-e437-46d2-a8fa-ea773cd36984": "7fec6807-47d8-4d53-8c7a-9c065a775f4d",
"c7848fd3-13b2-4225-bed4-be52100c2c17": "9052df71-e2b1-44ae-ae34-c81026057dcb"
},
"HasUpdates": true,
"Modified": "2026-07-14T01:39:29.3041535+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-14T01:39:29.3041535+00:00"
},
"LastComment": "2026-07-14T01:39:29.3041535+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "99a32d13-5ce9-4000-b7cf-ebeb0cd97308",
"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": "a21464b2-812d-45e1-89d0-1a09cd23d8e4",
"id": "f906e8a6-e64d-47ca-a16e-2bf6ec1c3a8c",
"ConfigId": "c42d93b7-0b38-4e08-ab88-c75924d3029b"
}