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": "b88fea30-ff45-4d83-9b8a-83d832299e32",
"ParentTaskId": "17088104-8e87-4a87-9d84-764b20c16d85",
"Integration": {
"IntegrationId": "de5e7a98-1481-4ede-a011-745315854577",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b78897ab-71ac-49bf-bd1c-a6125d1fe96b": 2.0,
"6a85c4c5-ea18-4d5c-be86-efc182baa945": 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": "199b167a-70cd-490d-9ab3-e96390abb010",
"Name": "sample string 1",
"Created": "2026-04-25T08:37:38.548602+00:00",
"Modified": "2026-04-25T08:37:38.548602+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f4645016-7e9b-473e-9122-707d43859933",
"18e5b49d-b927-4590-954e-f464baf21ce5"
],
"NonLaborAssignments": [
{
"Id": "27fbc175-678d-4d6f-956f-875ea11cc2b1",
"ResourceId": "61bcbbbc-76f7-4c33-93b8-0bf0b9a88a50",
"Quantity": 3.0
},
{
"Id": "27fbc175-678d-4d6f-956f-875ea11cc2b1",
"ResourceId": "61bcbbbc-76f7-4c33-93b8-0bf0b9a88a50",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "43590e76-eb29-4155-8e93-ce289bb8ff00",
"Type": 0,
"ResourceId": "b56b9150-0d1c-438e-a5f9-790753132eda",
"Units": 3.0
},
{
"Id": "43590e76-eb29-4155-8e93-ce289bb8ff00",
"Type": 0,
"ResourceId": "b56b9150-0d1c-438e-a5f9-790753132eda",
"Units": 3.0
}
],
"ParentId": "27931d41-87ca-4e31-96ff-0a9f2bde2e0e",
"WorkTypeParentId": "6a56eefc-3eba-4137-9b1e-e5623299a15b",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "901b78fb-2eb8-40d4-93d4-a0dc486af7ee",
"UPN": "f3cde9b2-d48d-4ff6-8126-13f30790813a",
"PostDate": "2026-04-25T08:37:38.548602+00:00",
"Comment": "sample string 4",
"CC": [
"23e2f3f7-5c4c-4bf3-bce2-309d6377b1d3",
"8f63bb89-2f15-491c-9f13-88a444112fcf"
],
"Users": [
"c59ae169-cfdb-488d-a3c5-88695080e059",
"b575e308-fe2e-4cd2-b896-28ee5fe01326"
]
},
{
"Id": "901b78fb-2eb8-40d4-93d4-a0dc486af7ee",
"UPN": "f3cde9b2-d48d-4ff6-8126-13f30790813a",
"PostDate": "2026-04-25T08:37:38.548602+00:00",
"Comment": "sample string 4",
"CC": [
"23e2f3f7-5c4c-4bf3-bce2-309d6377b1d3",
"8f63bb89-2f15-491c-9f13-88a444112fcf"
],
"Users": [
"c59ae169-cfdb-488d-a3c5-88695080e059",
"b575e308-fe2e-4cd2-b896-28ee5fe01326"
]
}
],
"StartDate": "2026-04-25T08:37:38.548602+00:00",
"DueDate": "2026-04-25T08:37:38.548602+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"b278180b-35b1-4a6d-9984-271e7e7745c7": "5a15ade9-fb3a-4cd3-8946-cea4311f75d2",
"4db018a4-e670-4e8c-ba02-928bff235001": "b9b6f0ca-9fd9-4330-8e5b-358dd960a29a"
},
"HasUpdates": true,
"Modified": "2026-04-25T08:37:38.548602+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-04-25T08:37:38.548602+00:00"
},
"LastComment": "2026-04-25T08:37:38.548602+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "5fad7762-daf3-464b-bbb4-c4385bf70609",
"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": "987a3249-c3e0-41b7-9bce-5f4ed4f69603",
"id": "656438aa-4828-4aa3-9b6d-1ed9e2fa506f",
"ConfigId": "8d4a9822-391d-40fe-a6af-ba277e753bd3"
}