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": "854e1c7d-add2-4bd3-ac58-a413ff4e8382",
"ParentTaskId": "ac525ae3-6ac0-4241-822c-7b1c9c030ebd",
"Integration": {
"IntegrationId": "85ec4b03-6694-4928-9e33-a327c9537b96",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"a31f581d-25b7-4c68-b665-307d62e2b555": 2.0,
"414d8fff-76e4-4b85-ad49-d2dd8bbaeca3": 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": "8f9ebe57-7fac-42ce-aba7-49b12228cdca",
"Name": "sample string 1",
"Created": "2026-08-12T21:37:08.5005494+00:00",
"Modified": "2026-08-12T21:37:08.5005494+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"ff3819cd-b306-482b-9be2-317362a084e2",
"7625de47-e1fb-4e18-9f90-d0819396a567"
],
"NonLaborAssignments": [
{
"Id": "16031c5d-39ce-47d3-8c63-7dcf5a25f4dd",
"ResourceId": "5e71f0a6-9ccd-44cf-b086-8bb70179c2f8",
"Quantity": 3.0
},
{
"Id": "16031c5d-39ce-47d3-8c63-7dcf5a25f4dd",
"ResourceId": "5e71f0a6-9ccd-44cf-b086-8bb70179c2f8",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "23b310bd-9034-44e3-ad81-f0a321f8ac39",
"Type": 0,
"ResourceId": "5238b394-ffe9-41ce-815e-26cdf6d762fb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "23b310bd-9034-44e3-ad81-f0a321f8ac39",
"Type": 0,
"ResourceId": "5238b394-ffe9-41ce-815e-26cdf6d762fb",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "29d0a63f-741c-42b6-b69a-4ad88c79e9c0",
"WorkTypeParentId": "47527c83-0455-4438-bb79-97b562c1b9a6",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "8c0bdb52-4343-4916-a78c-b57dc786f55a",
"UPN": "01d1562a-ba9a-45cc-aa60-9f8ce94e30cb",
"PostDate": "2026-08-12T21:37:08.5005494+00:00",
"Comment": "sample string 4",
"CC": [
"427f4bce-e694-4666-bd01-a89c0f77e760",
"aa0feb04-ab2d-4d20-b2f6-5c4ac79f4b25"
],
"Users": [
"fae2d7d2-e410-49b3-9193-98dbe78ffd82",
"937c8669-ad55-4cb9-9c92-fc5990965183"
]
},
{
"Id": "8c0bdb52-4343-4916-a78c-b57dc786f55a",
"UPN": "01d1562a-ba9a-45cc-aa60-9f8ce94e30cb",
"PostDate": "2026-08-12T21:37:08.5005494+00:00",
"Comment": "sample string 4",
"CC": [
"427f4bce-e694-4666-bd01-a89c0f77e760",
"aa0feb04-ab2d-4d20-b2f6-5c4ac79f4b25"
],
"Users": [
"fae2d7d2-e410-49b3-9193-98dbe78ffd82",
"937c8669-ad55-4cb9-9c92-fc5990965183"
]
}
],
"StartDate": "2026-08-12T21:37:08.5005494+00:00",
"DueDate": "2026-08-12T21:37:08.5005494+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"e6817a79-fca5-41f2-93d1-6a09b020256f": "0a190026-1e13-4d3b-b840-19207eb2b9a4",
"c79a827a-05be-472d-8bd0-1eb2f7949fb3": "249e28d0-1193-494b-86b2-c8aac2321bef"
},
"HasUpdates": true,
"Modified": "2026-08-12T21:37:08.5005494+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-12T21:37:08.5005494+00:00"
},
"LastComment": "2026-08-12T21:37:08.5005494+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "36058e89-1428-47ca-83af-440577d6ddf6",
"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": "a1f16964-6400-4fae-a8fa-7b887708f0f9",
"id": "5445d703-3821-471a-b730-31e71ce7d1f4",
"ConfigId": "99549cd4-ce25-4a43-ab78-19f8b01df7a3"
}