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": "c9379f58-73a3-455f-b194-3942fa3124cc",
"ParentTaskId": "52f8d9a3-0677-442c-955b-d35a5cd99d82",
"Integration": {
"IntegrationId": "57fca851-89e7-4f39-a29d-065cdd529368",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"b8a33b58-dddf-4c65-ab9d-78c787cffe51": 2.0,
"66373787-0f44-40bd-98a1-c63110f3d84d": 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": "180c92ab-955e-4dd9-b731-52a2d5d7394f",
"Name": "sample string 1",
"Created": "2026-08-26T21:39:14.8039399+00:00",
"Modified": "2026-08-26T21:39:14.8039399+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"b1b03e62-dfd7-4b5f-8691-ff9bf4293f0e",
"a0fdfd16-202e-44e3-83e7-d5fa3f5cb9a7"
],
"NonLaborAssignments": [
{
"Id": "4d285645-d0d7-4e2c-b215-4029c15e5a94",
"ResourceId": "78bec519-e0d8-4965-b7f0-a632f531ccb5",
"Quantity": 3.0
},
{
"Id": "4d285645-d0d7-4e2c-b215-4029c15e5a94",
"ResourceId": "78bec519-e0d8-4965-b7f0-a632f531ccb5",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "83eb433a-c91a-4333-8f95-2d5c37d27ce0",
"Type": 0,
"ResourceId": "e8d2d426-dd57-4397-a1ca-f77c7e0189b9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "83eb433a-c91a-4333-8f95-2d5c37d27ce0",
"Type": 0,
"ResourceId": "e8d2d426-dd57-4397-a1ca-f77c7e0189b9",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "f0a22e8f-9e89-4964-9772-b9244affde14",
"WorkTypeParentId": "48c64ad5-6e6b-4dcf-b604-503ee3e1106d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "957b59aa-1ed9-4e39-b297-ff5f0fa88515",
"UPN": "822a5131-5436-4ad4-aac1-3a488ea0e654",
"PostDate": "2026-08-26T21:39:14.8039399+00:00",
"Comment": "sample string 4",
"CC": [
"6e5f3793-9075-4038-9b2f-27dd4d3f3d66",
"b115e833-7eb9-4f4e-9925-11a4c509ef66"
],
"Users": [
"523061b5-1b0e-49ed-a6d6-b4bbf25b0986",
"e099c7e4-bca2-420e-b3cd-030c2961778a"
]
},
{
"Id": "957b59aa-1ed9-4e39-b297-ff5f0fa88515",
"UPN": "822a5131-5436-4ad4-aac1-3a488ea0e654",
"PostDate": "2026-08-26T21:39:14.8039399+00:00",
"Comment": "sample string 4",
"CC": [
"6e5f3793-9075-4038-9b2f-27dd4d3f3d66",
"b115e833-7eb9-4f4e-9925-11a4c509ef66"
],
"Users": [
"523061b5-1b0e-49ed-a6d6-b4bbf25b0986",
"e099c7e4-bca2-420e-b3cd-030c2961778a"
]
}
],
"StartDate": "2026-08-26T21:39:14.8039399+00:00",
"DueDate": "2026-08-26T21:39:14.8039399+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"80989aaf-26c0-4b70-ad54-d887de4feeef": "8c738f1f-db6c-4e2d-bb37-2e24a9086721",
"1db4194e-0b89-456e-880f-960f76ee491c": "55871463-f3e9-4ed0-9346-a3bc107b54eb"
},
"HasUpdates": true,
"Modified": "2026-08-26T21:39:14.8039399+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-26T21:39:14.8039399+00:00"
},
"LastComment": "2026-08-26T21:39:14.8039399+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "385ffa82-7276-4756-9022-3febbdc186e3",
"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": "69de295b-935f-49ad-9ab0-127c8ac80655",
"id": "5ab7701a-d348-4383-b4ea-72d4052202bf",
"ConfigId": "273be17d-047a-4eae-b5b8-e2f1180200ac"
}