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": "d1233b56-6dca-4a5b-af59-364fd0ff14bd",
"ParentTaskId": "f179c24d-f300-41d2-8e99-bc15c8dbde53",
"Integration": {
"IntegrationId": "ef99c248-37b1-4d07-a581-3baf72e6018e",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"5f7e3be2-2f22-48ea-813b-afac9e5efeb1": 2.0,
"2a7cce4a-5bd1-44a3-b0ca-ff18b1b5b4ac": 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": "76f8bdd5-7a3d-455d-ac98-c5f77445ad50",
"Name": "sample string 1",
"Created": "2026-08-07T21:44:48.3651515+00:00",
"Modified": "2026-08-07T21:44:48.3651515+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d1b883ce-2e4b-41c7-95a1-93e13687c378",
"890c9d1f-5366-4008-8e42-e8c79c23732f"
],
"NonLaborAssignments": [
{
"Id": "a436779e-b177-4b93-a30b-e81d59532103",
"ResourceId": "38f9c91b-7dfe-4e59-92fd-e8e48dadd227",
"Quantity": 3.0
},
{
"Id": "a436779e-b177-4b93-a30b-e81d59532103",
"ResourceId": "38f9c91b-7dfe-4e59-92fd-e8e48dadd227",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "30fe1cc0-9cbd-46c9-b4db-25a3e7fe12b8",
"Type": 0,
"ResourceId": "ba2841c5-c2f8-466f-bfac-19321f308e7d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "30fe1cc0-9cbd-46c9-b4db-25a3e7fe12b8",
"Type": 0,
"ResourceId": "ba2841c5-c2f8-466f-bfac-19321f308e7d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "b8db5978-00b4-43c3-b8f8-b9cfa7d1f77d",
"WorkTypeParentId": "2d13b749-f0e2-49b2-811e-763dc9f5caf2",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "95c6a5d4-bca3-4e41-8e39-b262a1c8b229",
"UPN": "2dfd61b6-2d37-43a6-9d28-f38226196e4a",
"PostDate": "2026-08-07T21:44:48.3651515+00:00",
"Comment": "sample string 4",
"CC": [
"c7e2b5e0-1e1b-41d1-9b1b-93a074407fef",
"41b1f425-270a-4efd-b718-869036508710"
],
"Users": [
"a77b8653-c45d-4741-bd25-eade25bc5868",
"eee3e271-0367-4f71-bb9e-3c3e4c6dcf68"
]
},
{
"Id": "95c6a5d4-bca3-4e41-8e39-b262a1c8b229",
"UPN": "2dfd61b6-2d37-43a6-9d28-f38226196e4a",
"PostDate": "2026-08-07T21:44:48.3651515+00:00",
"Comment": "sample string 4",
"CC": [
"c7e2b5e0-1e1b-41d1-9b1b-93a074407fef",
"41b1f425-270a-4efd-b718-869036508710"
],
"Users": [
"a77b8653-c45d-4741-bd25-eade25bc5868",
"eee3e271-0367-4f71-bb9e-3c3e4c6dcf68"
]
}
],
"StartDate": "2026-08-07T21:44:48.3651515+00:00",
"DueDate": "2026-08-07T21:44:48.3651515+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"fe866a54-7cc6-432f-aaef-e8244c8581e8": "a341f639-762a-4f07-b022-4f3d656a99a7",
"2b4d8eb3-b303-48bc-b501-a9f199e48263": "9192c025-f168-4562-ba3c-a00820df495a"
},
"HasUpdates": true,
"Modified": "2026-08-07T21:44:48.3651515+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-07T21:44:48.3651515+00:00"
},
"LastComment": "2026-08-07T21:44:48.3651515+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "e44168f3-42bb-4953-87ca-184086fa403d",
"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": "230f8ce4-23fe-4150-a2ef-1a09d4d0cdd9",
"id": "39716098-c2bd-4f47-b5f5-baa0db071e10",
"ConfigId": "857b7553-2fa8-4542-ba4f-9d1e17386041"
}