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": "ec93e33d-f3c2-4561-b472-c9edb0d79a9e",
"ParentTaskId": "cae2e805-c9ab-4138-adcc-370977507a88",
"Integration": {
"IntegrationId": "4119fa82-aa10-4947-83ab-6635951f1d44",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"99025e9c-fafb-4139-ae79-d0327b20e477": 2.0,
"ef8c377d-3523-402e-8f36-701d2c0df60d": 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": "b32bfbba-48e9-42d0-8128-102db2b5f028",
"Name": "sample string 1",
"Created": "2026-06-23T21:00:00.9625843+00:00",
"Modified": "2026-06-23T21:00:00.9625843+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"493d5c9e-044e-46eb-ae69-2ce27b410f29",
"d7b18a38-a832-4459-b519-102c4b087523"
],
"NonLaborAssignments": [
{
"Id": "15c3684b-920f-4e55-8692-ed74f84ab77d",
"ResourceId": "a96cc356-4e2c-49d0-8d11-f1aaa0bfff7d",
"Quantity": 3.0
},
{
"Id": "15c3684b-920f-4e55-8692-ed74f84ab77d",
"ResourceId": "a96cc356-4e2c-49d0-8d11-f1aaa0bfff7d",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "ef65839c-1901-4081-bcf0-39a3e07b837a",
"Type": 0,
"ResourceId": "219401b1-6b30-418b-97c1-9d71ac884195",
"Units": 3.0
},
{
"Id": "ef65839c-1901-4081-bcf0-39a3e07b837a",
"Type": 0,
"ResourceId": "219401b1-6b30-418b-97c1-9d71ac884195",
"Units": 3.0
}
],
"ParentId": "12496573-46a7-4e87-adbc-0577f9cec99d",
"WorkTypeParentId": "d1360423-8586-4d92-a42e-d07c310680df",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "25823d7d-dc18-4c69-b2cc-f04e4e2aa617",
"UPN": "14adb4af-e20f-4f21-919e-93684c18d9c0",
"PostDate": "2026-06-23T21:00:00.9625843+00:00",
"Comment": "sample string 4",
"CC": [
"5f0f3668-0e86-4e05-b0e2-6f67e3a90c54",
"53a64c23-87c9-4da2-b7cd-99ff874e0093"
],
"Users": [
"9d2b342d-3542-441e-8712-b73f08c9cc32",
"af1e7b52-172d-4ed7-89d0-8067b0b3f424"
]
},
{
"Id": "25823d7d-dc18-4c69-b2cc-f04e4e2aa617",
"UPN": "14adb4af-e20f-4f21-919e-93684c18d9c0",
"PostDate": "2026-06-23T21:00:00.9625843+00:00",
"Comment": "sample string 4",
"CC": [
"5f0f3668-0e86-4e05-b0e2-6f67e3a90c54",
"53a64c23-87c9-4da2-b7cd-99ff874e0093"
],
"Users": [
"9d2b342d-3542-441e-8712-b73f08c9cc32",
"af1e7b52-172d-4ed7-89d0-8067b0b3f424"
]
}
],
"StartDate": "2026-06-23T21:00:00.9625843+00:00",
"DueDate": "2026-06-23T21:00:00.9625843+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fe78c145-e50e-4f83-bb7d-35d95f90b14d": "eee3d354-14fa-46a1-a511-4172493fcef5",
"76567253-a7af-4303-a3d0-47b1894498ce": "0e9021b0-c950-4466-af91-1a10b670a710"
},
"HasUpdates": true,
"Modified": "2026-06-23T21:00:00.9625843+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-06-23T21:00:00.9625843+00:00"
},
"LastComment": "2026-06-23T21:00:00.9625843+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "50be7817-5ac5-4dde-a25f-4ba628f75ca5",
"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": "89b6fa5a-cdf1-4cd3-b054-2dd734de36d9",
"id": "056b6a29-1cb1-4459-950b-203ebb99e828",
"ConfigId": "c46942a0-7125-49c2-9295-8163c551eeab"
}