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": "a545a80d-da8c-41a9-b91e-d4c108426072",
"ParentTaskId": "4cb528c5-6e52-4346-8cd3-2209f1798df9",
"Integration": {
"IntegrationId": "672866ce-44b2-4123-a2d9-d9cd58f2e6a5",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3e4b03da-1408-49bd-bed1-26c439622f65": 2.0,
"c0840f25-1b25-4834-a808-a299b9c4e09e": 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": "b15fca64-1b5f-44df-87be-bed9b4d0c5d5",
"Name": "sample string 1",
"Created": "2026-05-24T22:47:26.4520416+00:00",
"Modified": "2026-05-24T22:47:26.4520416+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0eaabfb0-e4fc-46dd-93cd-c94a801f691f",
"318ec01c-0e06-47d9-896d-e16e990eb97b"
],
"NonLaborAssignments": [
{
"Id": "355ab342-e75e-4a51-b629-c70703b8f06a",
"ResourceId": "16342420-99a2-4656-8886-317f6f4cc93f",
"Quantity": 3.0
},
{
"Id": "355ab342-e75e-4a51-b629-c70703b8f06a",
"ResourceId": "16342420-99a2-4656-8886-317f6f4cc93f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e6846269-6634-4d7e-a8c7-f4f8ee4f904d",
"Type": 0,
"ResourceId": "77658045-559c-4405-bc36-4972881455a3",
"Units": 3.0
},
{
"Id": "e6846269-6634-4d7e-a8c7-f4f8ee4f904d",
"Type": 0,
"ResourceId": "77658045-559c-4405-bc36-4972881455a3",
"Units": 3.0
}
],
"ParentId": "669d3b50-c205-41f0-a5c6-771ec2f81634",
"WorkTypeParentId": "78ed1d8d-4173-40ea-9e45-1e8bc6101149",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b09ce458-0271-4764-9650-ee7b08e54e7c",
"UPN": "cda4f082-c473-425d-a450-ae6dd3b4bf91",
"PostDate": "2026-05-24T22:47:26.4520416+00:00",
"Comment": "sample string 4",
"CC": [
"b4a374f4-17b1-47c1-81d4-168c6fba0a75",
"303d800e-2c9a-41d8-866a-e1ce68f6d3de"
],
"Users": [
"021757d0-e674-432c-8379-409f814a2596",
"6d25a316-61fe-409e-a28f-c02063d8926b"
]
},
{
"Id": "b09ce458-0271-4764-9650-ee7b08e54e7c",
"UPN": "cda4f082-c473-425d-a450-ae6dd3b4bf91",
"PostDate": "2026-05-24T22:47:26.4520416+00:00",
"Comment": "sample string 4",
"CC": [
"b4a374f4-17b1-47c1-81d4-168c6fba0a75",
"303d800e-2c9a-41d8-866a-e1ce68f6d3de"
],
"Users": [
"021757d0-e674-432c-8379-409f814a2596",
"6d25a316-61fe-409e-a28f-c02063d8926b"
]
}
],
"StartDate": "2026-05-24T22:47:26.4520416+00:00",
"DueDate": "2026-05-24T22:47:26.4520416+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"047f9722-7417-4430-b0ca-f71b78f9d75b": "7cba45d2-1339-46b2-a10f-3f18c77e5074",
"0d195cc3-7aa6-416a-9d6a-7777b4f36193": "f23c282b-5f92-42a5-8ae6-0960d7af592a"
},
"HasUpdates": true,
"Modified": "2026-05-24T22:47:26.4520416+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-24T22:47:26.4520416+00:00"
},
"LastComment": "2026-05-24T22:47:26.4520416+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "39c7ded8-a101-4e89-a79c-7b20f9762684",
"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": "1906a444-a775-46ae-a777-debaac61624f",
"id": "16590415-45c9-4994-b8b6-630cd5e5ba9d",
"ConfigId": "18a7a05d-f2ba-4a4e-b70d-1d6412a6eeb0"
}