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": "7795e127-8fa5-4d5c-8782-3637bd531fcd",
"ParentTaskId": "49aa4280-8004-41f7-83dd-f4061e4be05b",
"Integration": {
"IntegrationId": "112cac28-45d1-44cd-bc95-c1b0bcb8df7a",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5239fed1-bd48-4386-9a30-b26327610555": 2.0,
"5cc8ec40-90dc-4883-ab8a-e93ff8a1f20d": 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": "b9b4e281-8619-4fd2-8397-9245f9f3bf79",
"Name": "sample string 1",
"Created": "2026-07-10T22:23:50.7808872+00:00",
"Modified": "2026-07-10T22:23:50.7808872+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"834fd075-087d-4b00-acf4-40995512623a",
"66340d37-9274-44a0-b654-12cacbb2984d"
],
"NonLaborAssignments": [
{
"Id": "e4d7aa11-c88b-489f-b4f8-4373f59db8d4",
"ResourceId": "c655bdb7-450c-47a9-943e-0b4d89d91cc3",
"Quantity": 3.0
},
{
"Id": "e4d7aa11-c88b-489f-b4f8-4373f59db8d4",
"ResourceId": "c655bdb7-450c-47a9-943e-0b4d89d91cc3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "c0e71a2d-e76e-4148-b426-0465df44b6d3",
"Type": 0,
"ResourceId": "6ab8368b-7fe3-4d01-8234-63cbd43565fc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "c0e71a2d-e76e-4148-b426-0465df44b6d3",
"Type": 0,
"ResourceId": "6ab8368b-7fe3-4d01-8234-63cbd43565fc",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "56e517a9-d30c-4790-b2ab-90f0dc6cabe2",
"WorkTypeParentId": "de379d2e-111e-4907-8752-54fbd36a7ef3",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9f525a6c-fc86-4530-9e92-cded5896b281",
"UPN": "e717e7ef-1626-4095-9319-626f7be009c7",
"PostDate": "2026-07-10T22:23:50.7808872+00:00",
"Comment": "sample string 4",
"CC": [
"16aec297-f9b1-4cf6-bfb2-3e214e0011d9",
"57e1dbc0-4102-4280-9880-636a4c4c33d5"
],
"Users": [
"4f5ace7b-79a4-447f-8024-6d7f1dd6b36e",
"aad18ab7-a326-4196-ad11-410cbd93415d"
]
},
{
"Id": "9f525a6c-fc86-4530-9e92-cded5896b281",
"UPN": "e717e7ef-1626-4095-9319-626f7be009c7",
"PostDate": "2026-07-10T22:23:50.7808872+00:00",
"Comment": "sample string 4",
"CC": [
"16aec297-f9b1-4cf6-bfb2-3e214e0011d9",
"57e1dbc0-4102-4280-9880-636a4c4c33d5"
],
"Users": [
"4f5ace7b-79a4-447f-8024-6d7f1dd6b36e",
"aad18ab7-a326-4196-ad11-410cbd93415d"
]
}
],
"StartDate": "2026-07-10T22:23:50.7808872+00:00",
"DueDate": "2026-07-10T22:23:50.7808872+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"bf6521eb-711e-410c-a640-7fefeb100f0d": "eae5b99c-5f0e-4e89-9bb9-697da97dc1e3",
"ccc21955-375d-46fc-8585-2a7ebcb7b2c9": "42478841-76e0-41ec-a9a6-437256d4463f"
},
"HasUpdates": true,
"Modified": "2026-07-10T22:23:50.7808872+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-10T22:23:50.7808872+00:00"
},
"LastComment": "2026-07-10T22:23:50.7808872+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d2f1d23e-4057-49cb-977b-4f1d56f55f6a",
"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": "6924014f-1815-46de-a987-fc6199e820fa",
"id": "63e4174d-8f7c-4bba-b3a0-e224468c64e0",
"ConfigId": "610948b9-8c4e-4721-8228-19db0bd17ddf"
}