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": "a8a716dc-e39e-46ee-8993-f76af1c4a093",
"ParentTaskId": "4a76941c-36f4-4122-90d3-2fce3fb71add",
"Integration": {
"IntegrationId": "e224b9f0-9e22-4c63-bc4f-a8822c60d6d1",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b87ab5db-281a-4a26-8ee8-9aae20660395": 2.0,
"12a9dfd8-5ded-47ea-836b-5682902db879": 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": "68e6e056-a194-4164-a891-787d07621b18",
"Name": "sample string 1",
"Created": "2026-07-16T02:57:53.5587811+00:00",
"Modified": "2026-07-16T02:57:53.5587811+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"11eb8e0e-d071-46b5-b6fb-900f7d4e6c08",
"b35f2454-cec9-4cab-ac29-104d13c50077"
],
"NonLaborAssignments": [
{
"Id": "1ee94f92-e962-47ea-8ed6-9053e9e005f2",
"ResourceId": "8b211398-9881-46b2-a42f-76705d3d123e",
"Quantity": 3.0
},
{
"Id": "1ee94f92-e962-47ea-8ed6-9053e9e005f2",
"ResourceId": "8b211398-9881-46b2-a42f-76705d3d123e",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9759bfda-bd34-49df-8844-8e6f17f7e45e",
"Type": 0,
"ResourceId": "2afda5dd-2d22-4e35-bfc2-42fb7ed79208",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "9759bfda-bd34-49df-8844-8e6f17f7e45e",
"Type": 0,
"ResourceId": "2afda5dd-2d22-4e35-bfc2-42fb7ed79208",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "bcdf68fa-8691-4266-889d-b128d1e0db40",
"WorkTypeParentId": "1f96556a-2cc6-4f63-993e-9ff959c21be6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f5070ec9-66d7-4ed7-965a-97d91238e306",
"UPN": "8f4d1d4b-23bf-45fc-98b3-85111ffe5d58",
"PostDate": "2026-07-16T02:57:53.5587811+00:00",
"Comment": "sample string 4",
"CC": [
"4486cdbe-47c3-4267-9db7-13a5c4ddba81",
"b0bab137-a5d2-4206-87dd-60546b54d65a"
],
"Users": [
"03541ac0-44f0-47e3-9c6d-8a24cd3083b8",
"a8515540-c5cb-4de7-9b73-ecba281f4340"
]
},
{
"Id": "f5070ec9-66d7-4ed7-965a-97d91238e306",
"UPN": "8f4d1d4b-23bf-45fc-98b3-85111ffe5d58",
"PostDate": "2026-07-16T02:57:53.5587811+00:00",
"Comment": "sample string 4",
"CC": [
"4486cdbe-47c3-4267-9db7-13a5c4ddba81",
"b0bab137-a5d2-4206-87dd-60546b54d65a"
],
"Users": [
"03541ac0-44f0-47e3-9c6d-8a24cd3083b8",
"a8515540-c5cb-4de7-9b73-ecba281f4340"
]
}
],
"StartDate": "2026-07-16T02:57:53.5587811+00:00",
"DueDate": "2026-07-16T02:57:53.5587811+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3f8ca124-796f-4f05-9747-c9f9348685f8": "173c72a1-d905-48f8-8399-6df455ee1235",
"b7355d65-3b80-4184-aeaf-3276d86b45a6": "db694f3b-7c0a-44a9-bdcc-44b55b898747"
},
"HasUpdates": true,
"Modified": "2026-07-16T02:57:53.5587811+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-16T02:57:53.5587811+00:00"
},
"LastComment": "2026-07-16T02:57:53.5587811+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "004ba8cd-d263-432b-903e-4f56f4f6270c",
"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": "b205b297-ba2d-4ad1-9020-44add0dde924",
"id": "9bca0097-32a0-4e7c-aabb-c0edbdb947af",
"ConfigId": "7ecef43d-23f2-44f9-aca6-bbbf7375d25c"
}