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": "f2026abe-3a9e-4d8d-95db-1dba6ad3284e",
"ParentTaskId": "1cf450b9-53d5-4ae5-a137-2c5eed3071fc",
"Integration": {
"IntegrationId": "67c96c7e-5f9b-4253-bf5e-5793c9eb855f",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"59abaad1-4bdf-4dc8-b6ef-01bff858b85b": 2.0,
"2e61cba0-d424-49dc-b874-9b98f8240ebc": 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": "0ba6dc4f-1ccd-459a-b754-d01be873b4ce",
"Name": "sample string 1",
"Created": "2026-09-30T07:36:54.1667673+00:00",
"Modified": "2026-09-30T07:36:54.1667673+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"bc992226-07f3-47f8-a451-a25a2c3f9636",
"34dfb844-e0f3-4f81-b67f-72f9778fb059"
],
"NonLaborAssignments": [
{
"Id": "0a121028-cc46-4b49-889f-f0a5cc66c228",
"ResourceId": "9ae6c0e0-a8a8-4c00-9fa7-626a5e00d477",
"Quantity": 3.0
},
{
"Id": "0a121028-cc46-4b49-889f-f0a5cc66c228",
"ResourceId": "9ae6c0e0-a8a8-4c00-9fa7-626a5e00d477",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "66c9275c-5aa7-4703-a492-a607e46c098d",
"Type": 0,
"ResourceId": "8c379c75-4280-46d2-b0ee-f3df03ab9d93",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7b795511-dd20-4a12-aa11-a4ea15bc639d",
"Start": "2026-09-30T07:36:54.1667673+00:00",
"Due": "2026-09-30T07:36:54.1667673+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7b795511-dd20-4a12-aa11-a4ea15bc639d",
"Start": "2026-09-30T07:36:54.1667673+00:00",
"Due": "2026-09-30T07:36:54.1667673+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "66c9275c-5aa7-4703-a492-a607e46c098d",
"Type": 0,
"ResourceId": "8c379c75-4280-46d2-b0ee-f3df03ab9d93",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "7b795511-dd20-4a12-aa11-a4ea15bc639d",
"Start": "2026-09-30T07:36:54.1667673+00:00",
"Due": "2026-09-30T07:36:54.1667673+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "7b795511-dd20-4a12-aa11-a4ea15bc639d",
"Start": "2026-09-30T07:36:54.1667673+00:00",
"Due": "2026-09-30T07:36:54.1667673+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "4e17a0ba-6de7-4bb3-8e10-ed5a0cce12c3",
"WorkTypeParentId": "b23a9177-7cfd-44cd-b23e-516fa0670b2c",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e700bb7d-537c-458f-8b46-86bc2654fa19",
"UPN": "a8dc7efb-f008-493d-8da4-df3163a946dc",
"PostDate": "2026-09-30T07:36:54.1667673+00:00",
"Comment": "sample string 4",
"CC": [
"a3b4658c-12d5-4b13-af07-95c7d0355ed7",
"b80e37df-333c-486b-844f-5579254836b7"
],
"Users": [
"ff94e4f2-559a-48c2-8028-d2a23b43c6ed",
"0d4a8895-045c-42f0-afa6-70da3cfd6875"
]
},
{
"Id": "e700bb7d-537c-458f-8b46-86bc2654fa19",
"UPN": "a8dc7efb-f008-493d-8da4-df3163a946dc",
"PostDate": "2026-09-30T07:36:54.1667673+00:00",
"Comment": "sample string 4",
"CC": [
"a3b4658c-12d5-4b13-af07-95c7d0355ed7",
"b80e37df-333c-486b-844f-5579254836b7"
],
"Users": [
"ff94e4f2-559a-48c2-8028-d2a23b43c6ed",
"0d4a8895-045c-42f0-afa6-70da3cfd6875"
]
}
],
"StartDate": "2026-09-30T07:36:54.1667673+00:00",
"DueDate": "2026-09-30T07:36:54.1667673+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"43d5b840-f226-4794-b2f9-e6904a21b762": "11c6ec6b-6f8c-4e87-ba55-387c1be7c996",
"50ed636a-6c1c-470a-8a95-12747b2e97f3": "c2744230-4c89-4553-ad57-1f7d15893a9a"
},
"HasUpdates": true,
"Modified": "2026-09-30T07:36:54.1667673+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-30T07:36:54.1667673+00:00"
},
"LastComment": "2026-09-30T07:36:54.1667673+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "33845abf-d5ae-4f4e-9fb6-e562206f0ec4",
"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": "8a13a24a-22d5-497b-b256-6bd575baab0f",
"id": "1c3fb266-8e13-48e8-a3e5-e3114e588574",
"ConfigId": "e18c33b5-d178-4124-b9b0-0e56df6203a9"
}