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": "c03a7588-7aae-4d9a-ab08-a8706ab09bf1",
"ParentTaskId": "69941061-9138-49b4-99b4-2c6686123229",
"Integration": {
"IntegrationId": "1624bee8-5553-4ec1-bf4a-d70040e9dda7",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"397a0aa9-7cce-4843-bcc2-d4b3fa17b7c2": 2.0,
"c72175f7-41ce-4b54-94c2-6aac89784a98": 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": "176e8926-8853-4d0e-b25b-d73a01b4a9a4",
"Name": "sample string 1",
"Created": "2026-08-27T22:32:10.1714984+00:00",
"Modified": "2026-08-27T22:32:10.1714984+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"35fb8904-dd69-44a9-986e-eb0266dd6fa0",
"746d83db-59c4-48a7-83a6-e0ad5638ad0f"
],
"NonLaborAssignments": [
{
"Id": "4c935ae3-4c41-4678-8dd8-3b020071df1c",
"ResourceId": "fc80dca2-ba88-4861-b78d-cea5cfd7c85f",
"Quantity": 3.0
},
{
"Id": "4c935ae3-4c41-4678-8dd8-3b020071df1c",
"ResourceId": "fc80dca2-ba88-4861-b78d-cea5cfd7c85f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3f6b5b85-5b85-4625-8f80-b9e2fcfaa65b",
"Type": 0,
"ResourceId": "e5efeef2-c80b-41c3-89a8-61248b154816",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "3f6b5b85-5b85-4625-8f80-b9e2fcfaa65b",
"Type": 0,
"ResourceId": "e5efeef2-c80b-41c3-89a8-61248b154816",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "02b457a6-1729-488b-a29a-ebb2cf12387f",
"WorkTypeParentId": "2cdc85e6-e73b-4f4d-b8d1-63be00e7f981",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "ab9872b1-de69-4989-bbf3-7bb496a6b788",
"UPN": "c40f62bc-deea-4d0c-95b6-e50d826b75a7",
"PostDate": "2026-08-27T22:32:10.1714984+00:00",
"Comment": "sample string 4",
"CC": [
"c2b0e920-12f0-4f18-9584-fac9e74c18e8",
"25f99df7-da71-4878-801f-a7178cafb13d"
],
"Users": [
"2c67b42a-26a0-4a2b-bdc8-227865dc761c",
"c1f5a108-37a0-4b1d-bd31-c0cf8eab6855"
]
},
{
"Id": "ab9872b1-de69-4989-bbf3-7bb496a6b788",
"UPN": "c40f62bc-deea-4d0c-95b6-e50d826b75a7",
"PostDate": "2026-08-27T22:32:10.1714984+00:00",
"Comment": "sample string 4",
"CC": [
"c2b0e920-12f0-4f18-9584-fac9e74c18e8",
"25f99df7-da71-4878-801f-a7178cafb13d"
],
"Users": [
"2c67b42a-26a0-4a2b-bdc8-227865dc761c",
"c1f5a108-37a0-4b1d-bd31-c0cf8eab6855"
]
}
],
"StartDate": "2026-08-27T22:32:10.1714984+00:00",
"DueDate": "2026-08-27T22:32:10.1714984+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9c33fa25-b949-44c8-8fe1-ef11081cdaf9": "754d45a7-7fdb-4c9e-88a6-d3d4583dec3a",
"98300ad7-95ce-40c6-9a31-c69c9fd56f42": "9fc89f88-9d1f-4375-a2d4-06ebb246ff82"
},
"HasUpdates": true,
"Modified": "2026-08-27T22:32:10.1714984+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-27T22:32:10.1714984+00:00"
},
"LastComment": "2026-08-27T22:32:10.1714984+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "bfcf6aaa-4c26-4fe5-8c63-0afaac6b11a6",
"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": "88bdba09-c410-4967-aa9d-b92b3d521168",
"id": "d35aff5d-7e59-409d-91e3-2866bb33af5a",
"ConfigId": "c79061d0-8b92-4582-80c4-e2823e0e3fc3"
}