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": "70d545bf-c787-426a-983f-3397b3d9b18e",
"ParentTaskId": "f0570ea6-2f3d-4e0f-8612-363d3d9349dc",
"Integration": {
"IntegrationId": "d13ccd76-f694-49d4-9f00-02a219ddda23",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"526263c5-2a3c-4f22-988f-09e213e48bc6": 2.0,
"022c8170-9198-45eb-b8d7-e56d6cfb9e8b": 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": "bd8f60f1-9a74-4b1a-b8ac-a21cdee09bd3",
"Name": "sample string 1",
"Created": "2026-08-11T19:25:48.6685579+00:00",
"Modified": "2026-08-11T19:25:48.6685579+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"0e4e3afd-80e8-4266-8033-5018ca163bf4",
"61af8895-837a-4767-b9d3-99f461b7af41"
],
"NonLaborAssignments": [
{
"Id": "bcb4a1e5-88d8-4d0c-bd0e-f34405b8b96e",
"ResourceId": "b057bdfa-7f5f-4eea-9b71-2cea70d89a2a",
"Quantity": 3.0
},
{
"Id": "bcb4a1e5-88d8-4d0c-bd0e-f34405b8b96e",
"ResourceId": "b057bdfa-7f5f-4eea-9b71-2cea70d89a2a",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "0469c10c-12fd-4a76-9463-946e48de022b",
"Type": 0,
"ResourceId": "13206cb0-a5a2-4d77-ba8b-215c8088b9db",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "0469c10c-12fd-4a76-9463-946e48de022b",
"Type": 0,
"ResourceId": "13206cb0-a5a2-4d77-ba8b-215c8088b9db",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "00bf14b0-acb5-44ab-b441-dc4bb3ba40f6",
"WorkTypeParentId": "3e5df261-ecee-4f4a-9e1b-e31aab7a8edc",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "4bce9a20-4e6e-45d3-af61-9eb211a68c7f",
"UPN": "9cbdb634-fc8d-4404-9ce5-72c6f29ce44b",
"PostDate": "2026-08-11T19:25:48.6685579+00:00",
"Comment": "sample string 4",
"CC": [
"a34fe859-ed37-4016-a8b4-441a91946622",
"7be53504-f4d9-459d-8324-188c34af2236"
],
"Users": [
"a426190d-5e45-4a3b-8287-4f7db51cfcf1",
"dfc06c24-c62d-49d8-8214-5937903a65f7"
]
},
{
"Id": "4bce9a20-4e6e-45d3-af61-9eb211a68c7f",
"UPN": "9cbdb634-fc8d-4404-9ce5-72c6f29ce44b",
"PostDate": "2026-08-11T19:25:48.6685579+00:00",
"Comment": "sample string 4",
"CC": [
"a34fe859-ed37-4016-a8b4-441a91946622",
"7be53504-f4d9-459d-8324-188c34af2236"
],
"Users": [
"a426190d-5e45-4a3b-8287-4f7db51cfcf1",
"dfc06c24-c62d-49d8-8214-5937903a65f7"
]
}
],
"StartDate": "2026-08-11T19:25:48.6841659+00:00",
"DueDate": "2026-08-11T19:25:48.6841659+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"f5454bd0-3841-4f58-9a67-af5fe0c6c724": "9a87c033-f8ad-4792-b03d-63ccc26f4257",
"3be2d032-2c59-4e03-99a3-d7b7aefcbbb7": "1a01125c-a489-4f29-b198-30580d61aa46"
},
"HasUpdates": true,
"Modified": "2026-08-11T19:25:48.6841659+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-11T19:25:48.6841659+00:00"
},
"LastComment": "2026-08-11T19:25:48.6841659+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a18348a7-24b1-4213-8ff4-2aa08eb53d1b",
"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": "aeb23d94-e99c-41ec-9aac-368c04c809a1",
"id": "3cf64704-1e3a-470a-b93b-121e047a77d2",
"ConfigId": "ffdd7bc2-1a01-464a-a965-2e96bef6c6c0"
}