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": "06df11de-516f-491c-a1d9-23d64ed96bc2",
"ParentTaskId": "e2a04d48-9132-4319-a1a6-81e577f21424",
"Integration": {
"IntegrationId": "62f63b4a-0d06-4043-9dd3-37101d97090b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d12bd01d-0f37-4d3f-93ba-be10b5f7e90a": 2.0,
"50cc83e9-8fbd-4fd6-ac65-c8865dac1a3e": 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": "31099a36-8f6c-4d44-91f9-36f2c9f96e04",
"Name": "sample string 1",
"Created": "2026-10-17T07:35:55.139664+00:00",
"Modified": "2026-10-17T07:35:55.139664+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7c4f8296-f70e-4701-84a0-5b003eca5988",
"673c8bcb-10ae-4e58-8b90-85155490ea75"
],
"NonLaborAssignments": [
{
"Id": "5b1161c3-72b2-49c5-be60-8bc339290bb7",
"ResourceId": "072ec042-ba13-409a-89c6-f7d1d0f71578",
"Quantity": 3.0
},
{
"Id": "5b1161c3-72b2-49c5-be60-8bc339290bb7",
"ResourceId": "072ec042-ba13-409a-89c6-f7d1d0f71578",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "74019cc1-b4ca-443a-a514-7b2b8e3240b6",
"Type": 0,
"ResourceId": "9e503c7a-f939-410b-b4d9-5a950d2b0d90",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "8f0df68a-cc13-4cc9-ba12-1f0e40d500b4",
"Start": "2026-10-17T07:35:55.139664+00:00",
"Due": "2026-10-17T07:35:55.139664+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "8f0df68a-cc13-4cc9-ba12-1f0e40d500b4",
"Start": "2026-10-17T07:35:55.139664+00:00",
"Due": "2026-10-17T07:35:55.139664+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "74019cc1-b4ca-443a-a514-7b2b8e3240b6",
"Type": 0,
"ResourceId": "9e503c7a-f939-410b-b4d9-5a950d2b0d90",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "8f0df68a-cc13-4cc9-ba12-1f0e40d500b4",
"Start": "2026-10-17T07:35:55.139664+00:00",
"Due": "2026-10-17T07:35:55.139664+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "8f0df68a-cc13-4cc9-ba12-1f0e40d500b4",
"Start": "2026-10-17T07:35:55.139664+00:00",
"Due": "2026-10-17T07:35:55.139664+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "97d7eab1-8a0e-4f87-ae45-2461eda2c182",
"WorkTypeParentId": "1aaaca29-3348-4d45-85ba-bb737900d51e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2a90c9fc-7b25-40de-b887-dca0c1b4be08",
"UPN": "446a84a6-0cda-462e-ab7c-842c6f4481c5",
"PostDate": "2026-10-17T07:35:55.139664+00:00",
"Comment": "sample string 4",
"CC": [
"1ba0d980-b5ab-4d46-bf18-d5363d55819c",
"dfdeb0e7-f508-4dbd-87ce-4ad936dea351"
],
"Users": [
"0542a290-3ab7-4617-a205-06e01cc63bbc",
"97e97ade-ffa2-4986-a359-35f95d320818"
]
},
{
"Id": "2a90c9fc-7b25-40de-b887-dca0c1b4be08",
"UPN": "446a84a6-0cda-462e-ab7c-842c6f4481c5",
"PostDate": "2026-10-17T07:35:55.139664+00:00",
"Comment": "sample string 4",
"CC": [
"1ba0d980-b5ab-4d46-bf18-d5363d55819c",
"dfdeb0e7-f508-4dbd-87ce-4ad936dea351"
],
"Users": [
"0542a290-3ab7-4617-a205-06e01cc63bbc",
"97e97ade-ffa2-4986-a359-35f95d320818"
]
}
],
"StartDate": "2026-10-17T07:35:55.139664+00:00",
"DueDate": "2026-10-17T07:35:55.139664+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cd2a21bd-fd5d-4797-8c87-87151a8bd348": "e6100be3-8da2-4489-8034-d414a2da3e48",
"813c82b9-7fcb-4ea1-b831-5ef6f075721b": "865cfbe2-692b-4ef5-a179-be77b0200369"
},
"HasUpdates": true,
"Modified": "2026-10-17T07:35:55.139664+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-17T07:35:55.139664+00:00"
},
"LastComment": "2026-10-17T07:35:55.139664+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ea20cf5e-a486-46e8-99f3-0baa807d92b8",
"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": "e5305424-6970-46b5-af6f-682a273b40f7",
"id": "d20a7814-6a99-4fb3-8758-1dabac85897a",
"ConfigId": "0873d8cf-823d-4160-aca5-a447fff02f30"
}