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": "c8b86c1d-8fb3-4a8b-b40e-ed0d8883d9c6",
"ParentTaskId": "92430cc4-66ff-4cf9-862f-1aaa3a618f80",
"Integration": {
"IntegrationId": "263334db-50a9-407c-8d60-f27ef7325d11",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"beb9844a-fcdb-4b72-a7d0-14ed7d7e15da": 2.0,
"043e8547-f114-49cf-9e2c-77833e59842c": 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": "4887cd64-4899-4855-a9f4-604a7e033edf",
"Name": "sample string 1",
"Created": "2026-06-10T02:55:11.4773237+00:00",
"Modified": "2026-06-10T02:55:11.4773237+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0354fc27-6001-4ff2-8f31-08d23be82157",
"549775ef-4b43-4f13-996c-f32752c8250f"
],
"NonLaborAssignments": [
{
"Id": "074ac9d9-6817-488e-b540-6234fcd0832b",
"ResourceId": "546db241-1e2c-43c3-be3e-09e9250c3b48",
"Quantity": 3.0
},
{
"Id": "074ac9d9-6817-488e-b540-6234fcd0832b",
"ResourceId": "546db241-1e2c-43c3-be3e-09e9250c3b48",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "46e9912a-5436-44db-a0a1-fb5134c7b857",
"Type": 0,
"ResourceId": "900920a1-0959-49f5-bed1-50369adf729a",
"Units": 3.0
},
{
"Id": "46e9912a-5436-44db-a0a1-fb5134c7b857",
"Type": 0,
"ResourceId": "900920a1-0959-49f5-bed1-50369adf729a",
"Units": 3.0
}
],
"ParentId": "55225540-b5aa-44db-bc92-91363088a5c9",
"WorkTypeParentId": "557523a4-03fa-45f0-8238-7e83422e6579",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "df2d15c7-d802-4b01-8973-7586641bdbad",
"UPN": "5d5a238a-0c04-437a-adee-9a1932a57308",
"PostDate": "2026-06-10T02:55:11.4773237+00:00",
"Comment": "sample string 4",
"CC": [
"7fd615a4-d1a2-4eb8-a3ce-7ce8b723579c",
"fb91edea-6d69-48db-896d-3edc3ff08d11"
],
"Users": [
"1abf8fbf-4766-42c7-826a-aba12873f6bf",
"e31bc90e-56ff-4c24-966e-5d980e3d7688"
]
},
{
"Id": "df2d15c7-d802-4b01-8973-7586641bdbad",
"UPN": "5d5a238a-0c04-437a-adee-9a1932a57308",
"PostDate": "2026-06-10T02:55:11.4773237+00:00",
"Comment": "sample string 4",
"CC": [
"7fd615a4-d1a2-4eb8-a3ce-7ce8b723579c",
"fb91edea-6d69-48db-896d-3edc3ff08d11"
],
"Users": [
"1abf8fbf-4766-42c7-826a-aba12873f6bf",
"e31bc90e-56ff-4c24-966e-5d980e3d7688"
]
}
],
"StartDate": "2026-06-10T02:55:11.4773237+00:00",
"DueDate": "2026-06-10T02:55:11.4773237+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"3b3285cd-3674-414f-85e0-105aedfcf355": "0d314ba9-c505-453c-a1c9-e81e98265d7c",
"9f774d5d-9a2f-4db8-86f2-2b5869087f18": "13eaca7f-0d9b-482f-bf47-8cec3e49fb71"
},
"HasUpdates": true,
"Modified": "2026-06-10T02:55:11.4773237+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-10T02:55:11.4773237+00:00"
},
"LastComment": "2026-06-10T02:55:11.4773237+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "0ba2d323-c5a0-45ec-ad81-e9a4f24b1857",
"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": "b044506e-8415-4ccb-9333-2575e6da5933",
"id": "29d01098-5cba-40eb-b954-58907a60891d",
"ConfigId": "e72f77cc-f6f0-4fee-ab16-4a2c68a830bf"
}