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": "4ec30e5c-558e-4847-8052-5c15e2c24cdb",
"ParentTaskId": "c5c891ba-59b4-4407-9c8c-414b08fbb9b9",
"Integration": {
"IntegrationId": "75642f4e-f108-49db-be37-46634b49a6b4",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"013b611e-ba52-408a-94c8-63ab6d39f1d4": 2.0,
"2af45f52-3cb5-4650-90f9-f7977367cd69": 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": "420da10b-ef9f-4578-b695-b5b9ce32d018",
"Name": "sample string 1",
"Created": "2026-06-30T04:57:21.9723018+00:00",
"Modified": "2026-06-30T04:57:21.9723018+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"7a56bb27-d402-4d44-9a08-53524995c3b1",
"2c49909e-71ab-489d-8995-c79bae235e0a"
],
"NonLaborAssignments": [
{
"Id": "59b91c3f-c7d0-439a-b088-8a3e7737222e",
"ResourceId": "d9ff183c-9cd9-4601-9d15-86a3b9fee9d8",
"Quantity": 3.0
},
{
"Id": "59b91c3f-c7d0-439a-b088-8a3e7737222e",
"ResourceId": "d9ff183c-9cd9-4601-9d15-86a3b9fee9d8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "e6bdde54-8df7-4576-b37f-88b912b744d2",
"Type": 0,
"ResourceId": "e622e3c3-79d1-4333-802c-517de7a4dccb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "e6bdde54-8df7-4576-b37f-88b912b744d2",
"Type": 0,
"ResourceId": "e622e3c3-79d1-4333-802c-517de7a4dccb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "38dd9e1b-6cec-4135-b0ec-45c4154fd4de",
"WorkTypeParentId": "7d6c03b3-b10b-4a56-a709-383f74237238",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "514488ad-e22f-4731-8797-5fd7375c087c",
"UPN": "cd45bce1-70a1-4ef3-8589-161e3fcab926",
"PostDate": "2026-06-30T04:57:21.9723018+00:00",
"Comment": "sample string 4",
"CC": [
"6522fde7-3865-462d-a88b-861c7343076d",
"ad0f03fd-e21f-43e2-b42e-cd60dbd4cbbe"
],
"Users": [
"2bdf1834-8190-4c26-b38d-349587cf10f3",
"48c7d0dd-04a7-4b1b-8eb6-8f95603dd9d3"
]
},
{
"Id": "514488ad-e22f-4731-8797-5fd7375c087c",
"UPN": "cd45bce1-70a1-4ef3-8589-161e3fcab926",
"PostDate": "2026-06-30T04:57:21.9723018+00:00",
"Comment": "sample string 4",
"CC": [
"6522fde7-3865-462d-a88b-861c7343076d",
"ad0f03fd-e21f-43e2-b42e-cd60dbd4cbbe"
],
"Users": [
"2bdf1834-8190-4c26-b38d-349587cf10f3",
"48c7d0dd-04a7-4b1b-8eb6-8f95603dd9d3"
]
}
],
"StartDate": "2026-06-30T04:57:21.9723018+00:00",
"DueDate": "2026-06-30T04:57:21.9723018+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"0cfaf275-4413-4b4e-ac2d-aefba22f605d": "b40f2611-b4c4-41a3-b6cd-a8d1a8e47354",
"9b29b2ee-777e-4133-bc67-a12c0d868df6": "991c2983-e984-449e-b14f-561d6517dc36"
},
"HasUpdates": true,
"Modified": "2026-06-30T04:57:21.9723018+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-06-30T04:57:21.9723018+00:00"
},
"LastComment": "2026-06-30T04:57:21.9723018+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "ccd3e866-6e55-4a02-926f-b419be2d083f",
"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": "5708ea0b-3861-4ddf-a8d3-ba40809eaaeb",
"id": "ddd6bdd4-b5e6-4a8b-a865-3e2064a16317",
"ConfigId": "17743819-ad73-44d8-90b7-c6c574fd6334"
}