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": "bb0cef1f-00a4-439f-aa13-8a25677e9573",
"ParentTaskId": "6899e11a-f854-4345-a198-f565170ebc36",
"Integration": {
"IntegrationId": "05f45de5-fe1b-453b-a829-e2199b5d007b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3d83589f-0d20-4be7-bf77-29d3b1c73a87": 2.0,
"13aa0c12-4d53-4ae6-a5f7-ddc29c953d0c": 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": "086dd603-169d-4045-a3ba-3b182fc6af06",
"Name": "sample string 1",
"Created": "2026-10-25T09:43:23.8801705+00:00",
"Modified": "2026-10-25T09:43:23.8801705+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"720b267a-e6c4-4a7b-a55b-da08b00fa202",
"926ee71e-e67f-4352-8b38-fe34132dd1af"
],
"NonLaborAssignments": [
{
"Id": "074f9a53-a3fc-4ccc-b425-5ac7f1c52780",
"ResourceId": "c5d72cd4-b560-4761-9cad-18f539442a07",
"Quantity": 3.0
},
{
"Id": "074f9a53-a3fc-4ccc-b425-5ac7f1c52780",
"ResourceId": "c5d72cd4-b560-4761-9cad-18f539442a07",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "63260970-0404-4755-8d23-9ce890eebf62",
"Type": 0,
"ResourceId": "a6219be2-0f8f-4296-8477-7aa2e9cc70cf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "53a63e67-f97a-49a2-8f6a-be764695f557",
"Start": "2026-10-25T09:43:23.8801705+00:00",
"Due": "2026-10-25T09:43:23.8801705+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "53a63e67-f97a-49a2-8f6a-be764695f557",
"Start": "2026-10-25T09:43:23.8801705+00:00",
"Due": "2026-10-25T09:43:23.8801705+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "63260970-0404-4755-8d23-9ce890eebf62",
"Type": 0,
"ResourceId": "a6219be2-0f8f-4296-8477-7aa2e9cc70cf",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "53a63e67-f97a-49a2-8f6a-be764695f557",
"Start": "2026-10-25T09:43:23.8801705+00:00",
"Due": "2026-10-25T09:43:23.8801705+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "53a63e67-f97a-49a2-8f6a-be764695f557",
"Start": "2026-10-25T09:43:23.8801705+00:00",
"Due": "2026-10-25T09:43:23.8801705+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "3d5069d2-da16-4d15-bf57-d71c88b8108c",
"WorkTypeParentId": "6531aded-9669-47ea-8983-bcd992fdac37",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "14280d87-3f0c-4bd7-b44a-63e5f3b26326",
"UPN": "feac6b25-ced1-411a-8ea6-ce875e4b7535",
"PostDate": "2026-10-25T09:43:23.8801705+00:00",
"Comment": "sample string 4",
"CC": [
"82450b34-e1dc-44d0-b56d-2b946c7c6557",
"3f8146a1-57ac-4da4-8b90-8af4da58a85a"
],
"Users": [
"aa2566c5-486d-4a4d-94e1-e4e9c3333991",
"b38afb8b-b687-47f6-8df0-2db79e9915c0"
]
},
{
"Id": "14280d87-3f0c-4bd7-b44a-63e5f3b26326",
"UPN": "feac6b25-ced1-411a-8ea6-ce875e4b7535",
"PostDate": "2026-10-25T09:43:23.8801705+00:00",
"Comment": "sample string 4",
"CC": [
"82450b34-e1dc-44d0-b56d-2b946c7c6557",
"3f8146a1-57ac-4da4-8b90-8af4da58a85a"
],
"Users": [
"aa2566c5-486d-4a4d-94e1-e4e9c3333991",
"b38afb8b-b687-47f6-8df0-2db79e9915c0"
]
}
],
"StartDate": "2026-10-25T09:43:23.8801705+00:00",
"DueDate": "2026-10-25T09:43:23.8801705+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"47091eab-cf04-43fc-90f9-370fee6dd63e": "afb422a0-d098-4920-9aff-b91ec12e35d1",
"0f9a6d15-1e80-4d11-9e7c-2ef9dd11e678": "5d45a67b-199d-433b-bfb2-a62309324303"
},
"HasUpdates": true,
"Modified": "2026-10-25T09:43:23.8801705+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-10-25T09:43:23.8801705+00:00"
},
"LastComment": "2026-10-25T09:43:23.8801705+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "75e83cfc-ccf3-4ab7-86f8-24f1ee86627c",
"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": "3465c73c-5c55-455c-b56b-13c8c95547c4",
"id": "41839df1-a89d-4759-8bd5-15f6bbcd9397",
"ConfigId": "043856d5-a4a3-4842-8000-2388c915d27e"
}