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": "b91a0532-5d2a-4f44-8b5a-20238de7d848",
"ParentTaskId": "fba2d4ef-a830-4227-a75a-f0df2401589e",
"Integration": {
"IntegrationId": "a8c79386-b255-4b24-ac20-f37440dc90c8",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"fa353902-1886-445e-829b-37184137214c": 2.0,
"2d3ba3ae-0fc2-4320-b9d6-fde7c2edd1c5": 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": "543c66bb-468e-4ddc-8cfd-27c348da78f4",
"Name": "sample string 1",
"Created": "2026-05-28T05:04:24.6214528+00:00",
"Modified": "2026-05-28T05:04:24.6214528+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"4c9662ae-8aac-44be-82e8-e818ecb4f06e",
"f33dcd1c-9d48-4fad-9a01-7cce3ed9a2c7"
],
"NonLaborAssignments": [
{
"Id": "18f8596d-1288-4661-9ff8-858419bd2bfe",
"ResourceId": "aef500c7-a98c-4d83-a2ff-56104e6dd66f",
"Quantity": 3.0
},
{
"Id": "18f8596d-1288-4661-9ff8-858419bd2bfe",
"ResourceId": "aef500c7-a98c-4d83-a2ff-56104e6dd66f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "b9933f67-20e2-4a39-9ea4-fbf9ee2c4962",
"Type": 0,
"ResourceId": "b541a344-ddc4-479a-b7cc-92e4ff01d742",
"Units": 3.0
},
{
"Id": "b9933f67-20e2-4a39-9ea4-fbf9ee2c4962",
"Type": 0,
"ResourceId": "b541a344-ddc4-479a-b7cc-92e4ff01d742",
"Units": 3.0
}
],
"ParentId": "27119b10-b55f-4b09-b090-19d4688e3c71",
"WorkTypeParentId": "f1ee8c44-7de0-41d3-b1a0-5d35efdeb404",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "759511e2-ebf6-4a9a-9392-d742006a3261",
"UPN": "e1244a7e-97e1-4b25-82cc-53ebdc841975",
"PostDate": "2026-05-28T05:04:24.6214528+00:00",
"Comment": "sample string 4",
"CC": [
"0e93b540-65d1-49af-9c12-a7420ff8ef48",
"6cae42c7-5109-4e54-8c1b-b940b29cf1f1"
],
"Users": [
"995145d3-485c-4002-a8d8-e24ef1e448ab",
"6ca2945f-9a0a-457a-96d9-d23c8a3ca179"
]
},
{
"Id": "759511e2-ebf6-4a9a-9392-d742006a3261",
"UPN": "e1244a7e-97e1-4b25-82cc-53ebdc841975",
"PostDate": "2026-05-28T05:04:24.6214528+00:00",
"Comment": "sample string 4",
"CC": [
"0e93b540-65d1-49af-9c12-a7420ff8ef48",
"6cae42c7-5109-4e54-8c1b-b940b29cf1f1"
],
"Users": [
"995145d3-485c-4002-a8d8-e24ef1e448ab",
"6ca2945f-9a0a-457a-96d9-d23c8a3ca179"
]
}
],
"StartDate": "2026-05-28T05:04:24.6214528+00:00",
"DueDate": "2026-05-28T05:04:24.6214528+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"84966b8d-d486-43ea-9005-a6d69b438d31": "7b0e1788-f999-4e60-91a5-97e817317dcd",
"1974a0cb-222c-49c6-8a8e-140ed65880ac": "01cb68bf-305f-4bbd-98b3-d43f894fb136"
},
"HasUpdates": true,
"Modified": "2026-05-28T05:04:24.6214528+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-28T05:04:24.6214528+00:00"
},
"LastComment": "2026-05-28T05:04:24.6214528+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "c29b9cd2-ad28-4d33-af3e-c1c29d36d58a",
"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": "1f15ebc6-090b-412b-a783-4d04c4672be5",
"id": "0220420d-c492-4a46-8ade-a0846dd63faa",
"ConfigId": "47802cb4-eefd-406f-b551-d26feec1fa1e"
}