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": "243af72f-f40f-44cb-a5ed-3041d0324833",
"ParentTaskId": "27ef742f-821f-45cc-aa59-5af07d45be66",
"Integration": {
"IntegrationId": "2b9d6d67-59a7-4581-9b23-990e27e816f0",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"487710d5-a2cf-46cf-b9f7-083859174ff4": 2.0,
"a78dc131-53db-4dc1-868e-1b0d97e426a3": 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. |
|
| WorkPlanId | globally unique identifier |
None. |
|
| id | globally unique identifier |
None. |
|
| ConfigId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkTypeId": "569ecd9e-6a22-4e82-81c0-0a51956684e9",
"Name": "sample string 1",
"Created": "2026-03-06T23:48:21.2915734+00:00",
"Modified": "2026-03-06T23:48:21.2915734+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f0adfdb5-ac14-4d3c-9597-a73b2eb9c6df",
"c4c6082e-0d7f-4142-b4c2-8bb2939a2568"
],
"NonLaborAssignments": [
{
"Id": "9f16d596-2481-41d8-9dff-dd79efd60e86",
"ResourceId": "1cd10f86-7ed6-4ece-8a4a-6717f4c97560",
"Quantity": 3.0
},
{
"Id": "9f16d596-2481-41d8-9dff-dd79efd60e86",
"ResourceId": "1cd10f86-7ed6-4ece-8a4a-6717f4c97560",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "d6e96c99-5133-4fdf-bea3-10d0bb1a5b90",
"Type": 0,
"ResourceId": "df99dc52-4fd6-433f-acd2-11277aa4d38e",
"Units": 3.0
},
{
"Id": "d6e96c99-5133-4fdf-bea3-10d0bb1a5b90",
"Type": 0,
"ResourceId": "df99dc52-4fd6-433f-acd2-11277aa4d38e",
"Units": 3.0
}
],
"ParentId": "4af485b3-cdfa-44fd-a34c-e5259c9d5fac",
"WorkTypeParentId": "743d655a-b6a2-4fdc-963d-c01dc7817831",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "b53a204d-a0f6-4af2-869c-2ac171f17de3",
"UPN": "6a705fd7-a7c7-4a4c-a2ce-d5cc6cd64acd",
"PostDate": "2026-03-06T23:48:21.2915734+00:00",
"Comment": "sample string 4",
"CC": [
"f50ff06e-0bf3-4800-8037-a7a9fdf6a8c7",
"fc94588f-4b65-4a4d-9419-067ecd5a6a4b"
],
"Users": [
"2f2cd57a-06e6-4077-8748-e48d127d3819",
"6ac97fad-0c81-428e-8450-b314926e7645"
]
},
{
"Id": "b53a204d-a0f6-4af2-869c-2ac171f17de3",
"UPN": "6a705fd7-a7c7-4a4c-a2ce-d5cc6cd64acd",
"PostDate": "2026-03-06T23:48:21.2915734+00:00",
"Comment": "sample string 4",
"CC": [
"f50ff06e-0bf3-4800-8037-a7a9fdf6a8c7",
"fc94588f-4b65-4a4d-9419-067ecd5a6a4b"
],
"Users": [
"2f2cd57a-06e6-4077-8748-e48d127d3819",
"6ac97fad-0c81-428e-8450-b314926e7645"
]
}
],
"StartDate": "2026-03-06T23:48:21.2915734+00:00",
"DueDate": "2026-03-06T23:48:21.2915734+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"98d824fa-9574-420d-9fba-20fd8dacdd7f": "cb43fd19-6623-4a8e-9efb-d4bdd0449fcf",
"f23f539e-1d90-4dbb-a12f-fde8d411e37e": "9159f0ef-41a2-4941-aac4-c177e550bf2a"
},
"HasUpdates": true,
"Modified": "2026-03-06T23:48:21.2915734+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-03-06T23:48:21.2915734+00:00"
},
"LastComment": "2026-03-06T23:48:21.2915734+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "bbc2c757-4a58-49e9-b883-dfb793dea2f9",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"WorkPlanId": "508e9b85-bfc2-4a6d-8e7c-e5558e95c5ba",
"id": "442911d2-92d3-4ed0-a9fa-001f3006697e",
"ConfigId": "a606deb5-abe8-4302-8e18-639fb07c5e1d"
}