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": "6072916c-05dc-4e56-ad03-6899dc1f974e",
"ParentTaskId": "a815034c-772b-49fd-a967-6992c2465e9b",
"Integration": {
"IntegrationId": "8eda2181-ec75-4b4e-9183-5642a2668c8e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"566cead7-15a4-4f20-906f-db8d47ac945d": 2.0,
"1479d1c4-01d1-4208-8254-d8ed6976badb": 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": "95923f71-e075-4ba4-9e2b-63849f0e4565",
"Name": "sample string 1",
"Created": "2026-11-04T21:19:35.4504661+00:00",
"Modified": "2026-11-04T21:19:35.4504661+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"eed7e311-0528-43d5-845d-0c3af058641d",
"6b77b5fc-a3ca-489b-9591-b3be5849c4f7"
],
"NonLaborAssignments": [
{
"Id": "7f2eb005-aba6-4322-9887-6f6b6856f381",
"ResourceId": "d1495c74-d5fb-45dd-b344-b1cc4e44e015",
"Quantity": 3.0
},
{
"Id": "7f2eb005-aba6-4322-9887-6f6b6856f381",
"ResourceId": "d1495c74-d5fb-45dd-b344-b1cc4e44e015",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e5c4422b-d3a2-43be-b2b9-1402bd3a687c",
"Type": 0,
"ResourceId": "66b89858-ff45-4f82-9738-8f166a8e323f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0f54a873-b193-4e35-9790-76564dc6f17d",
"Start": "2026-11-04T21:19:35.4504661+00:00",
"Due": "2026-11-04T21:19:35.4504661+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0f54a873-b193-4e35-9790-76564dc6f17d",
"Start": "2026-11-04T21:19:35.4504661+00:00",
"Due": "2026-11-04T21:19:35.4504661+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
},
{
"Id": "e5c4422b-d3a2-43be-b2b9-1402bd3a687c",
"Type": 0,
"ResourceId": "66b89858-ff45-4f82-9738-8f166a8e323f",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0,
"WorkCurve": "sample string 6",
"Segments": [
{
"Id": "0f54a873-b193-4e35-9790-76564dc6f17d",
"Start": "2026-11-04T21:19:35.4504661+00:00",
"Due": "2026-11-04T21:19:35.4504661+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
},
{
"Id": "0f54a873-b193-4e35-9790-76564dc6f17d",
"Start": "2026-11-04T21:19:35.4504661+00:00",
"Due": "2026-11-04T21:19:35.4504661+00:00",
"Units": 1.0,
"Effort": 1.0,
"Quantity": 1.0,
"Cost": 1.0
}
]
}
],
"ParentId": "7e0689c0-95c7-4e3a-94e9-7c7121b104e3",
"WorkTypeParentId": "b8051dbe-d0de-46b2-8882-fd8e78e2e9f3",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "05d88abe-9a04-47bf-a72f-2f19d644a804",
"UPN": "e41f821a-7761-4eaf-af45-ee3c271cfe6e",
"PostDate": "2026-11-04T21:19:35.4504661+00:00",
"Comment": "sample string 4",
"CC": [
"186f3122-3d75-44bc-b97e-a7c2850c1a6e",
"ceb7f570-13d8-465e-a33f-033b3d3b0fed"
],
"Users": [
"5b207b4e-086b-405e-a8a6-17bf07df01c9",
"4221d9a9-3bb9-492f-a8f1-d2130ce5875a"
]
},
{
"Id": "05d88abe-9a04-47bf-a72f-2f19d644a804",
"UPN": "e41f821a-7761-4eaf-af45-ee3c271cfe6e",
"PostDate": "2026-11-04T21:19:35.4504661+00:00",
"Comment": "sample string 4",
"CC": [
"186f3122-3d75-44bc-b97e-a7c2850c1a6e",
"ceb7f570-13d8-465e-a33f-033b3d3b0fed"
],
"Users": [
"5b207b4e-086b-405e-a8a6-17bf07df01c9",
"4221d9a9-3bb9-492f-a8f1-d2130ce5875a"
]
}
],
"StartDate": "2026-11-04T21:19:35.4504661+00:00",
"DueDate": "2026-11-04T21:19:35.4504661+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"6ad120e0-e5bd-4a5a-a633-f715dd487af9": "13849378-1be5-46a9-a740-cfbb36fb13ab",
"6520f6eb-3afd-4afa-93c0-9099e0cd3ed3": "2a521016-5fa3-4856-88d1-883b34c74e7e"
},
"HasUpdates": true,
"Modified": "2026-11-04T21:19:35.4504661+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-11-04T21:19:35.4504661+00:00"
},
"LastComment": "2026-11-04T21:19:35.4504661+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b7b94d15-46c8-4e8e-b42c-42de095b590e",
"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": "4f56e03c-52f0-4f89-a7ca-acdc05bf5e2b",
"id": "d77fc1e6-6af1-49b2-8ae3-36013a513db9",
"ConfigId": "060d5e6d-cf1b-46a9-8ce9-54426d1d380a"
}