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": "6c8bda7d-5b33-48e9-945b-940f39dbccbe",
"ParentTaskId": "fc1371a3-7700-4340-901b-c78517075dce",
"Integration": {
"IntegrationId": "8329f84c-eca6-492d-8148-074063e1416d",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b710a664-85fe-4d67-aba0-82cf17c02ab3": 2.0,
"2d71d185-947f-4544-a1d3-3123e7b049ac": 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": "03efa515-99b6-4a9a-a1b4-a8852848611b",
"Name": "sample string 1",
"Created": "2026-08-18T20:00:36.9564834+00:00",
"Modified": "2026-08-18T20:00:36.9564834+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"25272980-ab6f-46d8-b633-5c77e8feac2d",
"7bf9d397-f741-4087-a34b-e33d809e9928"
],
"NonLaborAssignments": [
{
"Id": "316595c7-bf7d-4fef-a52c-11cbdea29bae",
"ResourceId": "c772ee3c-e514-40e6-8752-bdafa4254bae",
"Quantity": 3.0
},
{
"Id": "316595c7-bf7d-4fef-a52c-11cbdea29bae",
"ResourceId": "c772ee3c-e514-40e6-8752-bdafa4254bae",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "f6c562c9-49b9-41ec-91ab-33aa40ddbaeb",
"Type": 0,
"ResourceId": "7dde60bb-9314-49b9-9a89-4d2481096dfe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "f6c562c9-49b9-41ec-91ab-33aa40ddbaeb",
"Type": 0,
"ResourceId": "7dde60bb-9314-49b9-9a89-4d2481096dfe",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "a239fdb4-85a5-4345-bc05-bfd74e89e248",
"WorkTypeParentId": "f32bec4e-9412-44ef-8a4b-2db349b9473f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "60561f17-1a21-4bf7-a5b0-50b566ffc6dc",
"UPN": "70c779b3-c9d4-44c3-b028-2987b2a36838",
"PostDate": "2026-08-18T20:00:36.9564834+00:00",
"Comment": "sample string 4",
"CC": [
"f8551ff3-3094-4f76-909a-1a7a54ae68ec",
"1b2232d8-8377-4ea6-aeb2-5f8d642da65e"
],
"Users": [
"c69ab337-816d-4aa6-bb3f-bb27ed9e8cbd",
"2c0e0ca5-948d-48c5-8517-e3fb51e2e64d"
]
},
{
"Id": "60561f17-1a21-4bf7-a5b0-50b566ffc6dc",
"UPN": "70c779b3-c9d4-44c3-b028-2987b2a36838",
"PostDate": "2026-08-18T20:00:36.9564834+00:00",
"Comment": "sample string 4",
"CC": [
"f8551ff3-3094-4f76-909a-1a7a54ae68ec",
"1b2232d8-8377-4ea6-aeb2-5f8d642da65e"
],
"Users": [
"c69ab337-816d-4aa6-bb3f-bb27ed9e8cbd",
"2c0e0ca5-948d-48c5-8517-e3fb51e2e64d"
]
}
],
"StartDate": "2026-08-18T20:00:36.9564834+00:00",
"DueDate": "2026-08-18T20:00:36.9564834+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9400b419-7a6a-48a7-b618-4ddc083e2b49": "2c4c7597-03e5-42af-b6e5-27a26a97d658",
"628d71cb-02a6-419d-98d5-9173d4ff463e": "0fd8ce7a-8ba5-43b7-b01c-18ede2d52c81"
},
"HasUpdates": true,
"Modified": "2026-08-18T20:00:36.9564834+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-08-18T20:00:36.9564834+00:00"
},
"LastComment": "2026-08-18T20:00:36.9564834+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "530b0bc1-abdf-4a39-bf58-f794e8adb1f7",
"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": "23d9bd22-df1e-445a-ae31-a550d9f8dc54",
"id": "2dab5bf8-01ed-4749-9f5a-5bac89ece3ee",
"ConfigId": "5aa9a519-228e-47f7-ac09-583dd92194ae"
}