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": "080388a8-f48b-4f0b-a0bd-60d403308839",
"ParentTaskId": "9b944196-6959-4f07-b54a-c521c4b12704",
"Integration": {
"IntegrationId": "3baddf8e-a9e5-4be2-b5fe-cbc834078580",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"8c8717ea-e2f1-4808-9c72-6048c52ac694": 2.0,
"52bdc0b9-4fd2-4517-9373-6a0789dae9bf": 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": "3bd9f133-9ee2-41b4-b74b-82ca9059adb6",
"Name": "sample string 1",
"Created": "2026-05-27T22:40:30.2171327+00:00",
"Modified": "2026-05-27T22:40:30.2171327+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"3d8d3998-7bfc-4832-ab79-ffd9898298de",
"022ab1ce-dd8d-4b0a-bd9f-ed6fbebc7e81"
],
"NonLaborAssignments": [
{
"Id": "3f56602e-a7b3-4cd9-b9c4-d0675577dee1",
"ResourceId": "3f8fab63-2866-40a7-be5f-bc7850772fcc",
"Quantity": 3.0
},
{
"Id": "3f56602e-a7b3-4cd9-b9c4-d0675577dee1",
"ResourceId": "3f8fab63-2866-40a7-be5f-bc7850772fcc",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "4388575b-46fd-4a19-a11f-2f562c3f1c29",
"Type": 0,
"ResourceId": "70bcd02a-bde6-4e64-95df-8cab4c6c0373",
"Units": 3.0
},
{
"Id": "4388575b-46fd-4a19-a11f-2f562c3f1c29",
"Type": 0,
"ResourceId": "70bcd02a-bde6-4e64-95df-8cab4c6c0373",
"Units": 3.0
}
],
"ParentId": "441fdd36-3b0e-45f3-b411-f43e8a84ec8a",
"WorkTypeParentId": "83f45946-3975-4106-852a-e2eeca9df20f",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "deb16a6b-90c4-4a5b-8b77-8f0084b141e0",
"UPN": "2f7a80f1-4ec4-4906-aea6-bb1b0aef23d4",
"PostDate": "2026-05-27T22:40:30.2171327+00:00",
"Comment": "sample string 4",
"CC": [
"d2879d2a-bc3a-4a01-b9a0-7e1defc9cd52",
"b47123d6-9f8e-455a-a265-a85c67413533"
],
"Users": [
"7dbf2d45-f6ec-4ee8-a117-134a2180a52a",
"41b188bc-ae5e-4f8d-93fa-ecac79bd489f"
]
},
{
"Id": "deb16a6b-90c4-4a5b-8b77-8f0084b141e0",
"UPN": "2f7a80f1-4ec4-4906-aea6-bb1b0aef23d4",
"PostDate": "2026-05-27T22:40:30.2171327+00:00",
"Comment": "sample string 4",
"CC": [
"d2879d2a-bc3a-4a01-b9a0-7e1defc9cd52",
"b47123d6-9f8e-455a-a265-a85c67413533"
],
"Users": [
"7dbf2d45-f6ec-4ee8-a117-134a2180a52a",
"41b188bc-ae5e-4f8d-93fa-ecac79bd489f"
]
}
],
"StartDate": "2026-05-27T22:40:30.2171327+00:00",
"DueDate": "2026-05-27T22:40:30.2171327+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"cb4bb838-7917-462f-88a4-fa86bfd2999b": "bed3c04d-aa0f-4516-8040-ad7f1d864c8f",
"3d7af537-25f9-491e-bbd1-5bd2e20c4261": "92e8c2b1-fdd3-4a10-8177-05002373d768"
},
"HasUpdates": true,
"Modified": "2026-05-27T22:40:30.2171327+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-05-27T22:40:30.2171327+00:00"
},
"LastComment": "2026-05-27T22:40:30.2171327+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "d0e6ad05-3e1d-46e5-ac51-2e514d6437f2",
"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": "09c7e7f4-f26c-4d12-b040-9d6b42e2ad08",
"id": "7ad5083a-b20e-44fa-b965-4488bd0fa447",
"ConfigId": "5163a033-1b44-4e6a-b844-d68e92efc2d7"
}