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": "889759d4-3654-46d0-ac8a-46378a6aa77f",
"ParentTaskId": "9a39113a-9dd6-4578-b19f-9e1876ef1c46",
"Integration": {
"IntegrationId": "56bcb296-e4c9-40c3-8c9a-5f5ea62753b6",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1f540910-9176-442e-bfe0-597cd5ba4824": 2.0,
"e00fce8b-4872-4ae1-9ba4-5a5e26764ffd": 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": "061de5d6-8339-45f3-8717-a2ffdcb502eb",
"Name": "sample string 1",
"Created": "2026-09-13T09:31:26.9569934+00:00",
"Modified": "2026-09-13T09:31:26.9569934+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"e5e205e4-5f75-4394-88ef-76523fd35b8f",
"57c9fe69-37fc-4833-9fb4-cde9103a19cb"
],
"NonLaborAssignments": [
{
"Id": "cde9becb-346f-40ef-8ced-1923b559f1a2",
"ResourceId": "ba9af971-2428-432e-95bc-d561fce473a7",
"Quantity": 3.0
},
{
"Id": "cde9becb-346f-40ef-8ced-1923b559f1a2",
"ResourceId": "ba9af971-2428-432e-95bc-d561fce473a7",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3d83b4de-c410-4faf-a930-12d57f150ce3",
"Type": 0,
"ResourceId": "10087bed-a0c0-46d7-9dc1-6815b82e3a44",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b1cdfe1e-4c28-4de0-89c4-12f5e412795d",
"Start": "2026-09-13T09:31:26.9569934+00:00",
"Due": "2026-09-13T09:31:26.9569934+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b1cdfe1e-4c28-4de0-89c4-12f5e412795d",
"Start": "2026-09-13T09:31:26.9569934+00:00",
"Due": "2026-09-13T09:31:26.9569934+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "3d83b4de-c410-4faf-a930-12d57f150ce3",
"Type": 0,
"ResourceId": "10087bed-a0c0-46d7-9dc1-6815b82e3a44",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "b1cdfe1e-4c28-4de0-89c4-12f5e412795d",
"Start": "2026-09-13T09:31:26.9569934+00:00",
"Due": "2026-09-13T09:31:26.9569934+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "b1cdfe1e-4c28-4de0-89c4-12f5e412795d",
"Start": "2026-09-13T09:31:26.9569934+00:00",
"Due": "2026-09-13T09:31:26.9569934+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "5a1a106d-fb28-4b9a-b664-e50a74da6bf7",
"WorkTypeParentId": "89e85733-c2a5-45e6-804d-1873aa224b73",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "9fb1405e-7844-41a9-96c1-71ec1ac5143e",
"UPN": "ed580305-1f5f-440c-8ed4-3d7c55390c66",
"PostDate": "2026-09-13T09:31:26.9569934+00:00",
"Comment": "sample string 4",
"CC": [
"b5409a42-2678-40b5-9ebd-082a2f5172b9",
"2168bd3e-1f50-4c60-b645-8cd494eb51b1"
],
"Users": [
"2aae0b91-22da-42cd-b04d-623be1ffe66d",
"f0f35752-adde-437f-997b-643a3b064724"
]
},
{
"Id": "9fb1405e-7844-41a9-96c1-71ec1ac5143e",
"UPN": "ed580305-1f5f-440c-8ed4-3d7c55390c66",
"PostDate": "2026-09-13T09:31:26.9569934+00:00",
"Comment": "sample string 4",
"CC": [
"b5409a42-2678-40b5-9ebd-082a2f5172b9",
"2168bd3e-1f50-4c60-b645-8cd494eb51b1"
],
"Users": [
"2aae0b91-22da-42cd-b04d-623be1ffe66d",
"f0f35752-adde-437f-997b-643a3b064724"
]
}
],
"StartDate": "2026-09-13T09:31:26.9569934+00:00",
"DueDate": "2026-09-13T09:31:26.9569934+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"43c7dc9f-966e-420a-ad93-2b303bfd385a": "0630f601-5260-480d-ae5d-fd068ae94c01",
"f200bfb0-57fa-462b-bb9c-9aed4c07134b": "9bdd9669-c225-4b90-a67c-da863d0eaf87"
},
"HasUpdates": true,
"Modified": "2026-09-13T09:31:26.9569934+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-09-13T09:31:26.9569934+00:00"
},
"LastComment": "2026-09-13T09:31:26.9569934+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "403bf09c-b7dc-4141-a2d6-163b0d12189e",
"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": "e7a2ca50-e7ba-4b95-8de2-626e18032f38",
"id": "d9476a3d-8f7f-4ddb-acaa-ce7220dbe94b",
"ConfigId": "c2d3aa6e-fc37-424f-b3f3-368e241e9f40"
}