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": "3c793f5b-fd6c-4bc8-8e9e-1b9f5e92b082",
"ParentTaskId": "2cbcbd79-d71e-4cfd-8688-7e733eaa2a64",
"Integration": {
"IntegrationId": "86e50fa1-b7bb-4f0d-8315-281a57eec484",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"4c7f87b1-57b6-43c2-9695-ad000b92f8e9": 2.0,
"ced99622-9cb2-43a7-8db2-a1a2ac5caa13": 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": "d15d5e63-0b5f-49ee-bc4a-4d1cd52feeee",
"Name": "sample string 1",
"Created": "2026-07-02T21:11:51.8141303+00:00",
"Modified": "2026-07-02T21:11:51.8141303+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"466fb846-d76b-47a9-a05c-5c21f50580dc",
"0dd68a5b-4ece-4d33-a173-91ab25d22ec7"
],
"NonLaborAssignments": [
{
"Id": "4525190e-1755-457f-a309-cab2ffba291d",
"ResourceId": "ee8b2922-e5e6-441b-9cdd-b698e8147b95",
"Quantity": 3.0
},
{
"Id": "4525190e-1755-457f-a309-cab2ffba291d",
"ResourceId": "ee8b2922-e5e6-441b-9cdd-b698e8147b95",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "709d40b1-d308-4d3b-a622-7a0e2850a609",
"Type": 0,
"ResourceId": "7aa06a24-1c0f-4191-b468-05830a8f1341",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "709d40b1-d308-4d3b-a622-7a0e2850a609",
"Type": 0,
"ResourceId": "7aa06a24-1c0f-4191-b468-05830a8f1341",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "362448bd-da2d-41e8-87db-cbd74eebc01e",
"WorkTypeParentId": "cdd4cefd-b07e-4bee-8763-eb084f493406",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "c4388768-ca98-4682-970a-77993785a237",
"UPN": "05988adb-7da7-4071-bde3-09bcfca8422b",
"PostDate": "2026-07-02T21:11:51.8141303+00:00",
"Comment": "sample string 4",
"CC": [
"cb049488-577b-468e-b880-58cbb6abcea1",
"bbb86cc9-a8da-4f99-8ba5-422912f569ca"
],
"Users": [
"b149d230-8986-432f-9376-65096d87274a",
"510c13c0-6a54-4abb-aa19-c6bfc154ae1e"
]
},
{
"Id": "c4388768-ca98-4682-970a-77993785a237",
"UPN": "05988adb-7da7-4071-bde3-09bcfca8422b",
"PostDate": "2026-07-02T21:11:51.8141303+00:00",
"Comment": "sample string 4",
"CC": [
"cb049488-577b-468e-b880-58cbb6abcea1",
"bbb86cc9-a8da-4f99-8ba5-422912f569ca"
],
"Users": [
"b149d230-8986-432f-9376-65096d87274a",
"510c13c0-6a54-4abb-aa19-c6bfc154ae1e"
]
}
],
"StartDate": "2026-07-02T21:11:51.8141303+00:00",
"DueDate": "2026-07-02T21:11:51.8141303+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9427639a-2773-4f6a-b485-029eedb94cfd": "f2df2ed8-2b04-4e8a-89ab-c9e6f5d1c44b",
"ece8ffb5-e86d-4dbf-a1ed-26b6e8c5ed04": "4424c3a1-3882-4c07-b250-a5fdd589b59b"
},
"HasUpdates": true,
"Modified": "2026-07-02T21:11:51.8141303+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-02T21:11:51.8141303+00:00"
},
"LastComment": "2026-07-02T21:11:51.8141303+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b123ca8b-819b-4ff5-b1c1-9e760db5f418",
"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": "e35244cf-1868-43d0-b67f-3e2c49be6169",
"id": "2aac99d5-7923-479a-a003-8aa093c8f33f",
"ConfigId": "db54610a-f261-453a-9c75-b1692c19e197"
}