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": "ab1e67a2-4996-496b-bb17-0d142fc26757",
"ParentTaskId": "5410a87c-192f-4f75-a584-57dc9320f269",
"Integration": {
"IntegrationId": "1e2a4495-7634-49a6-8f4f-a1f327d96a11",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"890dd421-8061-4952-835d-f89d0dae880f": 2.0,
"ec41daf7-0110-47d6-9bd2-1373fd0b60da": 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": "2a7cdbd1-2144-45e0-986d-61506f21d752",
"Name": "sample string 1",
"Created": "2026-08-25T08:40:47.5435683+00:00",
"Modified": "2026-08-25T08:40:47.5435683+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"051ef71d-13db-41e1-8c7f-bea5420be86a",
"e07e8c5b-28bc-45a0-9f62-dd7eaff1a650"
],
"NonLaborAssignments": [
{
"Id": "d5ab9072-acda-4d12-84dd-21fc5d6c8e19",
"ResourceId": "df9a10cf-36e3-48ac-aba0-87d88ab41ec6",
"Quantity": 3.0
},
{
"Id": "d5ab9072-acda-4d12-84dd-21fc5d6c8e19",
"ResourceId": "df9a10cf-36e3-48ac-aba0-87d88ab41ec6",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1fa8f2e3-7952-418e-b84d-99ff55a62ee8",
"Type": 0,
"ResourceId": "2713a075-c591-41f4-9574-fef80897cf9a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "1fa8f2e3-7952-418e-b84d-99ff55a62ee8",
"Type": 0,
"ResourceId": "2713a075-c591-41f4-9574-fef80897cf9a",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "8d386262-1e9e-4569-805e-eb5da3516334",
"WorkTypeParentId": "0f6b27f9-70f1-488f-9a57-90f3f7244732",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "f10d75ee-8db6-4b71-a783-7724a527b29e",
"UPN": "2c2dc17d-9d06-443b-b8d9-bdceb0a541b6",
"PostDate": "2026-08-25T08:40:47.5435683+00:00",
"Comment": "sample string 4",
"CC": [
"c9170ed5-1086-485e-bcf5-b4fd0c2c2901",
"a206b902-2d83-4d19-a320-4a09efc29059"
],
"Users": [
"a3441e88-0dc0-4770-b543-dd104d3a2f8e",
"1688a758-95e7-49ea-91ca-6437df62c66c"
]
},
{
"Id": "f10d75ee-8db6-4b71-a783-7724a527b29e",
"UPN": "2c2dc17d-9d06-443b-b8d9-bdceb0a541b6",
"PostDate": "2026-08-25T08:40:47.5435683+00:00",
"Comment": "sample string 4",
"CC": [
"c9170ed5-1086-485e-bcf5-b4fd0c2c2901",
"a206b902-2d83-4d19-a320-4a09efc29059"
],
"Users": [
"a3441e88-0dc0-4770-b543-dd104d3a2f8e",
"1688a758-95e7-49ea-91ca-6437df62c66c"
]
}
],
"StartDate": "2026-08-25T08:40:47.5435683+00:00",
"DueDate": "2026-08-25T08:40:47.5435683+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9f511392-da6a-44b9-b183-3500b2ea5378": "2c3f0233-f7c3-46ef-b263-e0e8b0841fc2",
"475f34c2-bf08-439d-859b-c9bfa6ddc36b": "9bd81a73-9e83-49bd-97b1-847eabf58d12"
},
"HasUpdates": true,
"Modified": "2026-08-25T08:40:47.5435683+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-25T08:40:47.5435683+00:00"
},
"LastComment": "2026-08-25T08:40:47.5435683+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "1ce4b775-706e-452d-9743-160968da9a7e",
"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": "061e0e1c-960e-4f7d-b5e4-ab35ba2f6f7c",
"id": "87e357c4-2b97-4b74-a50e-b6fa5f1e9f01",
"ConfigId": "232ee341-7659-497c-b661-827333e17be0"
}