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": "e9f6143b-2d04-4f7c-ac65-2f21b790d52c",
"ParentTaskId": "ae4d8bc1-6d8b-42bc-91c4-d7bdd52946e3",
"Integration": {
"IntegrationId": "738bce68-b72e-487e-b667-7812fff39a20",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"27297b34-7ffa-43d3-887a-273d0ca95433": 2.0,
"cce636e7-3b00-4ea2-9b85-659b9b51ea5a": 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": "2a807c02-f7af-4760-9bdd-217c37fbf024",
"Name": "sample string 1",
"Created": "2026-08-05T21:58:00.6519464+00:00",
"Modified": "2026-08-05T21:58:00.6519464+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2029be27-a6bd-4514-8bef-406eb012b0e9",
"6ab9f128-f4fa-44b8-bc7e-e99f066bbc07"
],
"NonLaborAssignments": [
{
"Id": "c4379120-2c59-4cf5-af4b-2ac727993e92",
"ResourceId": "5c6648d3-dda4-489a-b844-e25ecc567da8",
"Quantity": 3.0
},
{
"Id": "c4379120-2c59-4cf5-af4b-2ac727993e92",
"ResourceId": "5c6648d3-dda4-489a-b844-e25ecc567da8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c1257601-1c19-4dd4-83e1-43e34c7f6082",
"Type": 0,
"ResourceId": "95f59734-e9bb-4823-b01d-bf4d6ec1144d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "c1257601-1c19-4dd4-83e1-43e34c7f6082",
"Type": 0,
"ResourceId": "95f59734-e9bb-4823-b01d-bf4d6ec1144d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "548aea65-79ef-44c3-8595-7b09afdae24b",
"WorkTypeParentId": "5f64c1ee-dfbb-49db-b903-eeabe7a07340",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "23e132e4-1ad9-470f-a850-70a7f6f53883",
"UPN": "bf0688e2-9d57-4a84-be45-f6a8195ed6f2",
"PostDate": "2026-08-05T21:58:00.6519464+00:00",
"Comment": "sample string 4",
"CC": [
"ac8f1c89-e4ba-46f7-8600-29445336b01a",
"bb302819-db3d-408e-9ad6-84ca637e06ff"
],
"Users": [
"dab29547-1505-421c-9d22-5bb40ee2abcc",
"60144f21-d7f6-46e6-9668-9e871cdd4e78"
]
},
{
"Id": "23e132e4-1ad9-470f-a850-70a7f6f53883",
"UPN": "bf0688e2-9d57-4a84-be45-f6a8195ed6f2",
"PostDate": "2026-08-05T21:58:00.6519464+00:00",
"Comment": "sample string 4",
"CC": [
"ac8f1c89-e4ba-46f7-8600-29445336b01a",
"bb302819-db3d-408e-9ad6-84ca637e06ff"
],
"Users": [
"dab29547-1505-421c-9d22-5bb40ee2abcc",
"60144f21-d7f6-46e6-9668-9e871cdd4e78"
]
}
],
"StartDate": "2026-08-05T21:58:00.6519464+00:00",
"DueDate": "2026-08-05T21:58:00.6519464+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fb0a69c4-fad2-42cf-8f5a-12b643a155b3": "9b326667-2499-4ac3-9df0-c7a6123122ef",
"4be5bc9b-2a4a-4087-9163-3c1e78a65444": "0f2808c2-fdb2-4aa6-b1fe-ff91248e9a0b"
},
"HasUpdates": true,
"Modified": "2026-08-05T21:58:00.6519464+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-08-05T21:58:00.6519464+00:00"
},
"LastComment": "2026-08-05T21:58:00.6519464+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f4879513-aaf4-4719-98ac-9f9ca1e149fa",
"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": "d53c08fa-df92-4e4e-a16e-5ec1fdc42e32",
"id": "ae8007db-1e70-4859-84c3-12d9958ace18",
"ConfigId": "e49848ae-ab99-4e2d-87f5-604fe3259882"
}