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": "025b9071-f92d-4532-b434-e0234ef5149e",
"ParentTaskId": "4df1ef1b-b511-43c1-98b1-595547b19088",
"Integration": {
"IntegrationId": "7f1c4c95-2fe3-4586-b345-0b54ed87c37c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"e3fae1bb-7501-446c-b953-e96939b2af4c": 2.0,
"6521a7a8-8fbc-4e2d-90d4-c146431cc334": 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": "296d2bfd-313d-44d7-afcb-81bdfc97c302",
"Name": "sample string 1",
"Created": "2026-05-19T04:38:59.4212799+00:00",
"Modified": "2026-05-19T04:38:59.4212799+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2304cd74-d0b0-475c-920c-8f907a4e6121",
"c14af654-39f0-4ddf-ae6c-a47deb2f3cbe"
],
"NonLaborAssignments": [
{
"Id": "3d382712-81cd-4f42-b401-7f652fee21ad",
"ResourceId": "12caeacb-1421-4d76-98a8-387919a6f9b0",
"Quantity": 3.0
},
{
"Id": "3d382712-81cd-4f42-b401-7f652fee21ad",
"ResourceId": "12caeacb-1421-4d76-98a8-387919a6f9b0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "baea824a-1177-4ce0-8b6b-e4a63ce5bdb0",
"Type": 0,
"ResourceId": "1cb6c063-05d4-4c69-82dc-566e42290de0",
"Units": 3.0
},
{
"Id": "baea824a-1177-4ce0-8b6b-e4a63ce5bdb0",
"Type": 0,
"ResourceId": "1cb6c063-05d4-4c69-82dc-566e42290de0",
"Units": 3.0
}
],
"ParentId": "7fd4bb12-4d31-4c9e-8e79-2c6dee7900a5",
"WorkTypeParentId": "9a660973-5478-4cab-9ddd-0a9cfe243d43",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "74258e52-c621-43f5-9771-7a6a12d635fd",
"UPN": "316c73d3-f032-448e-af2f-3e276473a08c",
"PostDate": "2026-05-19T04:38:59.4212799+00:00",
"Comment": "sample string 4",
"CC": [
"5afcce23-643b-4f5d-a49b-2676fff4f930",
"6efd02da-53ac-4633-ab85-a524f324c9b8"
],
"Users": [
"f41c76c2-8064-4b23-a44e-7d42dbc9f74a",
"e4f84ed8-0051-4044-8317-a8dfabfee1e4"
]
},
{
"Id": "74258e52-c621-43f5-9771-7a6a12d635fd",
"UPN": "316c73d3-f032-448e-af2f-3e276473a08c",
"PostDate": "2026-05-19T04:38:59.4212799+00:00",
"Comment": "sample string 4",
"CC": [
"5afcce23-643b-4f5d-a49b-2676fff4f930",
"6efd02da-53ac-4633-ab85-a524f324c9b8"
],
"Users": [
"f41c76c2-8064-4b23-a44e-7d42dbc9f74a",
"e4f84ed8-0051-4044-8317-a8dfabfee1e4"
]
}
],
"StartDate": "2026-05-19T04:38:59.4212799+00:00",
"DueDate": "2026-05-19T04:38:59.4212799+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"7ff2f68f-6e0e-4480-938c-f2ce98e9d1fd": "df232023-b5d3-41e5-8aa3-e5538bb1d31b",
"60a5d52e-a5aa-4456-b0e7-1c70144b5f66": "4c074b6c-aed3-4c48-9277-f878953cf03d"
},
"HasUpdates": true,
"Modified": "2026-05-19T04:38:59.4212799+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-05-19T04:38:59.4212799+00:00"
},
"LastComment": "2026-05-19T04:38:59.4212799+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "186e4580-b659-432f-9497-deb6f6d2cd78",
"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": "00d7fe70-5914-432c-b475-5503cabb225e",
"id": "ffde898d-432d-46be-bc91-d5fe0efd08e9",
"ConfigId": "a93a2ebf-b320-46d4-9574-e70d593aca34"
}