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": "d1748502-60f2-4cc5-94f0-ad30324e3f4c",
"ParentTaskId": "bd1a8383-3f2e-4689-a04c-513c9d4e2cbf",
"Integration": {
"IntegrationId": "f4b51773-0ae9-4122-a3b4-d1a9a72073fe",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"69d0ba64-4398-4447-bdf1-f9b4d5091a92": 2.0,
"1f89d220-1523-4a53-9df5-d3d90b90a1b2": 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": "e8c86cf3-d7ec-4be8-94bc-27440615a13d",
"Name": "sample string 1",
"Created": "2026-07-19T10:48:44.7303778+00:00",
"Modified": "2026-07-19T10:48:44.7303778+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"fdc7ac88-a85a-4ff7-b61f-a4b6529be8dc",
"51d25b1d-bebf-481f-bc64-253877d0b6cc"
],
"NonLaborAssignments": [
{
"Id": "46124626-2e12-4b3c-aeb1-2a23dd1dc83b",
"ResourceId": "f09de511-22a4-417d-9ea4-22bd8c2c3ae9",
"Quantity": 3.0
},
{
"Id": "46124626-2e12-4b3c-aeb1-2a23dd1dc83b",
"ResourceId": "f09de511-22a4-417d-9ea4-22bd8c2c3ae9",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "df4b9b2f-6838-4570-bde8-5b756257ba2d",
"Type": 0,
"ResourceId": "f2c742a3-f04f-4e53-8acf-60f906c4d585",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "df4b9b2f-6838-4570-bde8-5b756257ba2d",
"Type": 0,
"ResourceId": "f2c742a3-f04f-4e53-8acf-60f906c4d585",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "e7d58f8e-ebe3-4d6f-98b4-a989e212c858",
"WorkTypeParentId": "48316500-4414-44b9-8e7d-5f11e2a66de1",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "944ec2d8-579b-40f8-a5c3-6c8b5f8e925c",
"UPN": "4136812d-5ef8-4044-a45c-4582cb29452e",
"PostDate": "2026-07-19T10:48:44.7303778+00:00",
"Comment": "sample string 4",
"CC": [
"08ddc6e0-c990-463c-9be8-fbdd723f0ea4",
"1eb725ee-9fff-4ec7-ac46-a72698b80372"
],
"Users": [
"674a0d0e-d127-410b-be5f-8b6e83db51c4",
"b121c37b-d668-4852-8abd-506f2cd9d450"
]
},
{
"Id": "944ec2d8-579b-40f8-a5c3-6c8b5f8e925c",
"UPN": "4136812d-5ef8-4044-a45c-4582cb29452e",
"PostDate": "2026-07-19T10:48:44.7303778+00:00",
"Comment": "sample string 4",
"CC": [
"08ddc6e0-c990-463c-9be8-fbdd723f0ea4",
"1eb725ee-9fff-4ec7-ac46-a72698b80372"
],
"Users": [
"674a0d0e-d127-410b-be5f-8b6e83db51c4",
"b121c37b-d668-4852-8abd-506f2cd9d450"
]
}
],
"StartDate": "2026-07-19T10:48:44.7303778+00:00",
"DueDate": "2026-07-19T10:48:44.7303778+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"9dd4aa31-8c38-4454-b118-2ebcb571fc00": "d532d179-b746-4f64-a127-12b7cec4cfc8",
"70c332ac-959d-4b45-99dc-5ab130be7e93": "7a963026-6b16-452f-b9d5-b3c6e95a91a7"
},
"HasUpdates": true,
"Modified": "2026-07-19T10:48:44.7303778+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-07-19T10:48:44.7303778+00:00"
},
"LastComment": "2026-07-19T10:48:44.7303778+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "4bebade2-9142-4db6-9d26-1556a04420f8",
"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": "a084683e-5a83-4e34-9bf1-42595ed1369d",
"id": "8358abd0-fb0d-428e-b5fd-aacb40767ce4",
"ConfigId": "583eb5a1-bc6b-43e9-89dc-ff547cc0c76d"
}