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": "a96c7340-09f5-44a0-8257-0f2149957cc6",
"ParentTaskId": "fe25294c-05fe-4c8c-b4f8-114ec214a9cc",
"Integration": {
"IntegrationId": "6e7d9937-6a99-4ec4-bc45-8a6f8b2f05b7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"f7dd5d0c-1eaa-4c35-9ef6-d5be66183910": 2.0,
"1d790a2a-06b0-4656-8e38-721172236123": 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": "588fa514-521a-4977-b759-f807f6b4203f",
"Name": "sample string 1",
"Created": "2026-06-19T15:50:56.6751724+00:00",
"Modified": "2026-06-19T15:50:56.6751724+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f4c93503-9aed-4783-ac16-dbf52584f3b2",
"bd9d16fd-3193-4f85-8247-684f7a6d2776"
],
"NonLaborAssignments": [
{
"Id": "0eb1a370-bce4-45ce-bffc-ba541607c85f",
"ResourceId": "b0ed5b7e-ccda-45dd-b66b-0d7645bdc695",
"Quantity": 3.0
},
{
"Id": "0eb1a370-bce4-45ce-bffc-ba541607c85f",
"ResourceId": "b0ed5b7e-ccda-45dd-b66b-0d7645bdc695",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "02f87f0d-ca15-43a4-88ce-dc4d937c6ca7",
"Type": 0,
"ResourceId": "a3c89d47-03b6-4af2-9776-f3ce53f7f004",
"Units": 3.0
},
{
"Id": "02f87f0d-ca15-43a4-88ce-dc4d937c6ca7",
"Type": 0,
"ResourceId": "a3c89d47-03b6-4af2-9776-f3ce53f7f004",
"Units": 3.0
}
],
"ParentId": "cbec024e-d780-494e-8dd8-7883c321f4fa",
"WorkTypeParentId": "1c25e1cb-c77d-4a74-9ede-7180d0fac9fa",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "e7a50faf-bfdf-4b02-bf76-893b49d6d305",
"UPN": "b828f119-dd47-4290-b927-2e191fc6a734",
"PostDate": "2026-06-19T15:50:56.6751724+00:00",
"Comment": "sample string 4",
"CC": [
"fd43ad86-2423-48cb-a873-7ab0e46f449c",
"5217e516-5afe-42dc-8788-0e4d56ebbae9"
],
"Users": [
"e4dd97e8-a978-4313-a307-3646b2c405bf",
"a915782a-38d8-4b9f-8b8e-9b58ec064f72"
]
},
{
"Id": "e7a50faf-bfdf-4b02-bf76-893b49d6d305",
"UPN": "b828f119-dd47-4290-b927-2e191fc6a734",
"PostDate": "2026-06-19T15:50:56.6751724+00:00",
"Comment": "sample string 4",
"CC": [
"fd43ad86-2423-48cb-a873-7ab0e46f449c",
"5217e516-5afe-42dc-8788-0e4d56ebbae9"
],
"Users": [
"e4dd97e8-a978-4313-a307-3646b2c405bf",
"a915782a-38d8-4b9f-8b8e-9b58ec064f72"
]
}
],
"StartDate": "2026-06-19T15:50:56.6751724+00:00",
"DueDate": "2026-06-19T15:50:56.6751724+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"463a9104-9a3a-4297-a60b-9f2a1eb23d0a": "cc5d3ba2-582e-4d7f-9069-8e0699e9b0a0",
"bee3c9b0-aa53-4a86-81b7-f84b167fbe75": "148e1e35-87de-44bd-bed7-142167ba0e92"
},
"HasUpdates": true,
"Modified": "2026-06-19T15:50:56.6751724+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-06-19T15:50:56.6751724+00:00"
},
"LastComment": "2026-06-19T15:50:56.6751724+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "49813d69-9947-45f3-99b1-d75af64f883c",
"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": "65a8c331-d2e2-4141-abaa-a3e75a4b75a1",
"id": "eec3a114-a9f0-46c2-8a46-78368b6e0485",
"ConfigId": "60ae1e19-08ba-4077-8554-fae98e0162d4"
}