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": "5a1d5d8f-04c1-42e5-a11c-54a329ec7901",
"ParentTaskId": "acdcff7e-8b0c-46fa-bdf4-20dc198fbb22",
"Integration": {
"IntegrationId": "2a3f2c60-dec3-441d-8a74-7c4742a82136",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"3c2eb1d1-2f4a-49d4-b97f-c0610139b1fb": 2.0,
"d642a3d7-5f72-42b8-9ce1-dacfe164cc99": 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": "5deea5ea-5f75-4d3a-a99c-c3db36ecd556",
"Name": "sample string 1",
"Created": "2026-09-10T03:10:57.5589423+00:00",
"Modified": "2026-09-10T03:10:57.5589423+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"02faf51e-6d69-4d63-9d72-4efce8407a32",
"dca1812c-8ff9-4222-8c2a-01f3eb8d23b3"
],
"NonLaborAssignments": [
{
"Id": "3f69a035-9c3b-4de8-8032-5aa2c9a4626c",
"ResourceId": "4f858ad6-e6f5-4ad1-9e93-ed5e76b2aabc",
"Quantity": 3.0
},
{
"Id": "3f69a035-9c3b-4de8-8032-5aa2c9a4626c",
"ResourceId": "4f858ad6-e6f5-4ad1-9e93-ed5e76b2aabc",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "933247c0-6e07-4319-ac82-bc747f331da2",
"Type": 0,
"ResourceId": "ba2c246e-2459-49d5-8972-20c0e3c17235",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "34498faf-1d9c-4400-b7ca-237a1e0fcdf4",
"Start": "2026-09-10T03:10:57.5589423+00:00",
"Due": "2026-09-10T03:10:57.5589423+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "34498faf-1d9c-4400-b7ca-237a1e0fcdf4",
"Start": "2026-09-10T03:10:57.5589423+00:00",
"Due": "2026-09-10T03:10:57.5589423+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "933247c0-6e07-4319-ac82-bc747f331da2",
"Type": 0,
"ResourceId": "ba2c246e-2459-49d5-8972-20c0e3c17235",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "34498faf-1d9c-4400-b7ca-237a1e0fcdf4",
"Start": "2026-09-10T03:10:57.5589423+00:00",
"Due": "2026-09-10T03:10:57.5589423+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "34498faf-1d9c-4400-b7ca-237a1e0fcdf4",
"Start": "2026-09-10T03:10:57.5589423+00:00",
"Due": "2026-09-10T03:10:57.5589423+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "2ecb9d79-f40b-4134-a1ca-d96f14af8309",
"WorkTypeParentId": "f6b89b50-16ba-475d-97cb-5e3918319eb9",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "57ab3164-4c62-4546-bd44-67b2df77d325",
"UPN": "5ca9181e-2830-47b6-869c-4cb651808419",
"PostDate": "2026-09-10T03:10:57.5589423+00:00",
"Comment": "sample string 4",
"CC": [
"811a5f00-e1cf-49fe-8e13-eb272aa8b9ea",
"c4195e1f-bcce-43e9-89e2-5812eda0197d"
],
"Users": [
"19d1aee7-a315-43ab-9a26-6b16adb25241",
"139bea7f-6ffc-435a-9841-a1575c7f0009"
]
},
{
"Id": "57ab3164-4c62-4546-bd44-67b2df77d325",
"UPN": "5ca9181e-2830-47b6-869c-4cb651808419",
"PostDate": "2026-09-10T03:10:57.5589423+00:00",
"Comment": "sample string 4",
"CC": [
"811a5f00-e1cf-49fe-8e13-eb272aa8b9ea",
"c4195e1f-bcce-43e9-89e2-5812eda0197d"
],
"Users": [
"19d1aee7-a315-43ab-9a26-6b16adb25241",
"139bea7f-6ffc-435a-9841-a1575c7f0009"
]
}
],
"StartDate": "2026-09-10T03:10:57.5589423+00:00",
"DueDate": "2026-09-10T03:10:57.5589423+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"5d1cadc4-c6aa-4db9-ac8e-13eb4f15d35f": "8c4fc6ef-c8bd-4245-8db5-312368c0676f",
"f6a7d4b6-df3a-4048-946c-c1076316ae6c": "7a0dc407-22cd-42dc-8745-34023f5c310c"
},
"HasUpdates": true,
"Modified": "2026-09-10T03:10:57.5589423+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-10T03:10:57.5589423+00:00"
},
"LastComment": "2026-09-10T03:10:57.5589423+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "83e0bc91-25a9-46f4-8f76-0e76069a7535",
"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": "65f8ec81-13ad-4612-ba14-a2b16eafad20",
"id": "57fbfb05-5853-4692-a097-14b2cf74becf",
"ConfigId": "21ba230e-1e08-4c3f-a917-9ad23f720212"
}