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": "c5e6fd9e-798d-4fae-b3d6-1cd2cdd47a23",
"ParentTaskId": "dbe29855-d5a5-4b6c-bb9c-005d03fe60ee",
"Integration": {
"IntegrationId": "8b144b67-7a28-466d-9607-efb3ca710f80",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4420b9bf-c11a-429f-9768-df1b378a510d": 2.0,
"380d582c-9665-4f52-ad47-d821708657ad": 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": "051fa554-de24-4abe-a69b-b033be73962e",
"Name": "sample string 1",
"Created": "2026-09-26T08:51:08.1330326+00:00",
"Modified": "2026-09-26T08:51:08.1330326+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7b68f111-27e1-4a3b-905d-d52f0b1f51ba",
"4c7b7b0d-29f4-4585-bacf-ad4a96aef858"
],
"NonLaborAssignments": [
{
"Id": "b632e784-32d5-4ba9-8c6a-7fa7fc0c6369",
"ResourceId": "fb48f431-3794-4b68-b16f-73d48a3f58d3",
"Quantity": 3.0
},
{
"Id": "b632e784-32d5-4ba9-8c6a-7fa7fc0c6369",
"ResourceId": "fb48f431-3794-4b68-b16f-73d48a3f58d3",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4bbd98ed-8818-468f-9042-0a5c7ad03b6f",
"Type": 0,
"ResourceId": "502d773c-e95f-417b-9c18-609ce7662208",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6c184194-8ec5-4957-a203-20566e9ea79b",
"Start": "2026-09-26T08:51:08.1330326+00:00",
"Due": "2026-09-26T08:51:08.1330326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6c184194-8ec5-4957-a203-20566e9ea79b",
"Start": "2026-09-26T08:51:08.1330326+00:00",
"Due": "2026-09-26T08:51:08.1330326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "4bbd98ed-8818-468f-9042-0a5c7ad03b6f",
"Type": 0,
"ResourceId": "502d773c-e95f-417b-9c18-609ce7662208",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "6c184194-8ec5-4957-a203-20566e9ea79b",
"Start": "2026-09-26T08:51:08.1330326+00:00",
"Due": "2026-09-26T08:51:08.1330326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "6c184194-8ec5-4957-a203-20566e9ea79b",
"Start": "2026-09-26T08:51:08.1330326+00:00",
"Due": "2026-09-26T08:51:08.1330326+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "d85ed81a-8ed8-4ebb-9d0b-5a7df65d0a19",
"WorkTypeParentId": "154315cb-ab8d-4d5c-9c4f-3465533034cd",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "3bc349a3-968f-49ea-8275-6145845e39e0",
"UPN": "20925535-c132-48ca-96f2-6a88ff20d1d5",
"PostDate": "2026-09-26T08:51:08.1330326+00:00",
"Comment": "sample string 4",
"CC": [
"9af82f1e-d465-4959-b331-30fd66d4b684",
"fe5c88ea-24ff-4278-8647-8d1d4c5fcc9a"
],
"Users": [
"db890da3-7ebd-48bd-a3f4-3804247517c6",
"20f4f1c5-e72f-4adb-a5f3-2c6fdcf73932"
]
},
{
"Id": "3bc349a3-968f-49ea-8275-6145845e39e0",
"UPN": "20925535-c132-48ca-96f2-6a88ff20d1d5",
"PostDate": "2026-09-26T08:51:08.1330326+00:00",
"Comment": "sample string 4",
"CC": [
"9af82f1e-d465-4959-b331-30fd66d4b684",
"fe5c88ea-24ff-4278-8647-8d1d4c5fcc9a"
],
"Users": [
"db890da3-7ebd-48bd-a3f4-3804247517c6",
"20f4f1c5-e72f-4adb-a5f3-2c6fdcf73932"
]
}
],
"StartDate": "2026-09-26T08:51:08.1330326+00:00",
"DueDate": "2026-09-26T08:51:08.1330326+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d739e5bf-484d-4383-a4e8-770eb9fc3fe2": "b8b26703-476e-446e-8f8f-920b20b3db4f",
"fa46ba39-1588-4349-b04c-bf8fdf764e11": "286264f3-445d-4bfb-841f-46a698bd3de2"
},
"HasUpdates": true,
"Modified": "2026-09-26T08:51:08.1330326+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-26T08:51:08.1330326+00:00"
},
"LastComment": "2026-09-26T08:51:08.1330326+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b90d69d1-0b17-438a-89d5-d2f7479989de",
"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": "152d1605-2021-4622-bfd0-69bde297a8a8",
"id": "b8f835df-5235-4b17-9f5c-7a60d830a45b",
"ConfigId": "2714b274-e8dc-46f5-94f2-cdcf9a767756"
}