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": "533593d2-d8ad-4b50-9269-a12a3da4b790",
"ParentTaskId": "6b4698bf-69bf-4198-b761-26fb530a7b2f",
"Integration": {
"IntegrationId": "bcf132cc-0003-48bb-bdcd-c8650d7539f4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c5c2aa69-1014-490a-8cf1-472e12c29d32": 2.0,
"1a8db369-2634-42ed-b268-2048f8a17aa5": 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": "05b447ba-3989-4a87-957c-6e833622704c",
"Name": "sample string 1",
"Created": "2026-07-28T21:32:17.8481971+00:00",
"Modified": "2026-07-28T21:32:17.8481971+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"6a1d4939-3cba-4c25-90c1-3f619e92ca82",
"bf8e21f9-5039-4486-92f0-4effc5c47c4c"
],
"NonLaborAssignments": [
{
"Id": "8e44e39c-122c-410a-8a9a-15b08333ad23",
"ResourceId": "392520ca-4e36-45ef-bd78-b05aa90f56e0",
"Quantity": 3.0
},
{
"Id": "8e44e39c-122c-410a-8a9a-15b08333ad23",
"ResourceId": "392520ca-4e36-45ef-bd78-b05aa90f56e0",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "9b181c43-28c5-4bab-8d29-41af404c15a4",
"Type": 0,
"ResourceId": "6da6669c-69f9-439e-886c-e46a9b71a891",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "9b181c43-28c5-4bab-8d29-41af404c15a4",
"Type": 0,
"ResourceId": "6da6669c-69f9-439e-886c-e46a9b71a891",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "724ba4cd-8bdc-4408-9273-d64a67c60597",
"WorkTypeParentId": "9182024f-2110-4871-9f9b-5345df615ed9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "558415bf-dd1f-4d8c-88b8-1e47c2d41133",
"UPN": "92fc9605-70c0-47f7-9ffa-1a9388686071",
"PostDate": "2026-07-28T21:32:17.8481971+00:00",
"Comment": "sample string 4",
"CC": [
"374b168e-5690-4b99-95ad-45895fd473e6",
"6df99692-2aac-4b5a-ae65-75837709a25b"
],
"Users": [
"22634add-4612-4a81-92ee-7b6d02470a8c",
"6b58447a-685a-4e14-afed-28470fe0ab98"
]
},
{
"Id": "558415bf-dd1f-4d8c-88b8-1e47c2d41133",
"UPN": "92fc9605-70c0-47f7-9ffa-1a9388686071",
"PostDate": "2026-07-28T21:32:17.8481971+00:00",
"Comment": "sample string 4",
"CC": [
"374b168e-5690-4b99-95ad-45895fd473e6",
"6df99692-2aac-4b5a-ae65-75837709a25b"
],
"Users": [
"22634add-4612-4a81-92ee-7b6d02470a8c",
"6b58447a-685a-4e14-afed-28470fe0ab98"
]
}
],
"StartDate": "2026-07-28T21:32:17.8481971+00:00",
"DueDate": "2026-07-28T21:32:17.8481971+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"56c1cd02-2e2b-4900-b1c2-19189225ee18": "5f41185a-0b5b-4135-8c50-78a99b590f9e",
"ef12ad38-1857-4d44-a8c8-1adb504dacc5": "26030055-901d-42a5-93d3-a42bd9f0f069"
},
"HasUpdates": true,
"Modified": "2026-07-28T21:32:17.8481971+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-28T21:32:17.8481971+00:00"
},
"LastComment": "2026-07-28T21:32:17.8481971+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "cc7055fd-d750-4d5d-864f-92478eecb339",
"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": "faa7eb71-1b5f-4f2e-9539-cdb4828bbd3f",
"id": "41d5cb31-597d-4178-a632-6d0dcc9651f0",
"ConfigId": "e6cda36e-56ff-454d-908d-69cbd1727e5d"
}