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": "06731c84-8a36-46bf-ae1f-b112c09d4bc7",
"ParentTaskId": "d1be259e-f9ff-4a9a-9b20-bebb58119c02",
"Integration": {
"IntegrationId": "9988ce08-ed05-445e-8058-4ca412bcf5a2",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4be664e6-d230-4b0e-b803-650944691ca8": 2.0,
"509f3a99-d736-4252-b385-f5669fe09a49": 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": "7a817c7e-0c85-4597-b3d8-cfe53f36ae39",
"Name": "sample string 1",
"Created": "2026-07-15T17:53:46.6401495+00:00",
"Modified": "2026-07-15T17:53:46.6401495+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"d0754184-77be-417d-80f4-f96c8d576e92",
"827b8684-84e7-4802-b857-352debd64427"
],
"NonLaborAssignments": [
{
"Id": "51a6b2c3-f022-4178-90be-13529fac9325",
"ResourceId": "1c46f4fa-2921-4036-a00e-78a542583841",
"Quantity": 3.0
},
{
"Id": "51a6b2c3-f022-4178-90be-13529fac9325",
"ResourceId": "1c46f4fa-2921-4036-a00e-78a542583841",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "65d44e23-c26a-48cc-8a5c-d7fe35a9a7ca",
"Type": 0,
"ResourceId": "903b5f5d-5a82-4260-b2d4-dcfa3f91c7cb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "65d44e23-c26a-48cc-8a5c-d7fe35a9a7ca",
"Type": 0,
"ResourceId": "903b5f5d-5a82-4260-b2d4-dcfa3f91c7cb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "a6cba3b6-361e-4d23-a0a0-b28ee59fd9c6",
"WorkTypeParentId": "2a0a16ec-eb32-4f07-af29-bead948f71ea",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "00d535a1-6218-431c-be39-73ec26e6d7ca",
"UPN": "f1e88279-fbe8-40ae-84cc-cc90786c3061",
"PostDate": "2026-07-15T17:53:46.6401495+00:00",
"Comment": "sample string 4",
"CC": [
"ec576bf1-d8ba-4c3b-9dbc-12810ccbe785",
"6529fe1d-f40b-44ee-a4ed-1d743abf2a6c"
],
"Users": [
"b2c94722-6c5f-4026-b870-557231945ddc",
"277b6bd1-3fba-492e-ab9f-ed175ea5866c"
]
},
{
"Id": "00d535a1-6218-431c-be39-73ec26e6d7ca",
"UPN": "f1e88279-fbe8-40ae-84cc-cc90786c3061",
"PostDate": "2026-07-15T17:53:46.6401495+00:00",
"Comment": "sample string 4",
"CC": [
"ec576bf1-d8ba-4c3b-9dbc-12810ccbe785",
"6529fe1d-f40b-44ee-a4ed-1d743abf2a6c"
],
"Users": [
"b2c94722-6c5f-4026-b870-557231945ddc",
"277b6bd1-3fba-492e-ab9f-ed175ea5866c"
]
}
],
"StartDate": "2026-07-15T17:53:46.6401495+00:00",
"DueDate": "2026-07-15T17:53:46.6401495+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"54b07ad5-48f4-4dbb-aa4e-f8e25ffb77b1": "43b07754-6b6d-464f-b986-30591541b029",
"40e8fac2-ac06-4fd4-ab73-b828b08fea12": "a8260656-735b-4066-8b60-941fadc2ed4f"
},
"HasUpdates": true,
"Modified": "2026-07-15T17:53:46.6401495+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-07-15T17:53:46.6401495+00:00"
},
"LastComment": "2026-07-15T17:53:46.6401495+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "f50ac5f5-2bd2-428c-875a-647bde005842",
"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": "d807860c-fd14-4462-9856-97d7fc2c946b",
"id": "afdde561-bf09-49e9-aa92-e5d700d8a117",
"ConfigId": "84072609-c38e-4a75-ac4e-568c3755856b"
}