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": "1245a6cb-0725-4d4c-a4f6-b26315a2ac3a",
"ParentTaskId": "5ffa07e6-0f4f-4f24-9da2-51ef5cc994f0",
"Integration": {
"IntegrationId": "4a711147-b33d-4ee8-a315-ad23f4120f2b",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d4dce23c-cc02-40a1-8bf1-05ce38f5d7db": 2.0,
"f8809e05-d4ac-4566-822d-7aabb6d93272": 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": "7a15baf6-7fa4-42d1-8f89-8cda1fb0a2e9",
"Name": "sample string 1",
"Created": "2026-07-30T22:53:27.1204882+00:00",
"Modified": "2026-07-30T22:53:27.1204882+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"87f3949f-dc7c-483b-99af-aa4cdd7e040d",
"ea395383-0df5-4f67-a5c3-f0febf86c9d2"
],
"NonLaborAssignments": [
{
"Id": "566e7bd2-d37d-43a0-a6f4-b9ba9c08057c",
"ResourceId": "05383ad5-f757-4d31-907b-11f2607d5f3c",
"Quantity": 3.0
},
{
"Id": "566e7bd2-d37d-43a0-a6f4-b9ba9c08057c",
"ResourceId": "05383ad5-f757-4d31-907b-11f2607d5f3c",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "5674a9a1-e092-492b-b1a6-222d506ef7e3",
"Type": 0,
"ResourceId": "111e1e73-1ba2-4aad-982a-53b138e3e220",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "5674a9a1-e092-492b-b1a6-222d506ef7e3",
"Type": 0,
"ResourceId": "111e1e73-1ba2-4aad-982a-53b138e3e220",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "e6f2cafc-d4e4-4961-963b-ea08fa184361",
"WorkTypeParentId": "f98ccd12-6374-4498-8cc0-afbafdfb70ad",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "a278e055-060f-4724-85b3-f468ffeeb8a4",
"UPN": "d64a7620-3d2d-4ce2-b0dd-8838ae7fdb18",
"PostDate": "2026-07-30T22:53:27.1204882+00:00",
"Comment": "sample string 4",
"CC": [
"8bc65a55-e763-4685-9860-ec04f9d3b7a0",
"48bda879-2e0e-4096-b3e4-9feafde5544a"
],
"Users": [
"a9ed1874-1edb-451a-a3b1-953b271e3e0d",
"0b6cbfdd-1f2f-47d7-bf72-f666b8ce611f"
]
},
{
"Id": "a278e055-060f-4724-85b3-f468ffeeb8a4",
"UPN": "d64a7620-3d2d-4ce2-b0dd-8838ae7fdb18",
"PostDate": "2026-07-30T22:53:27.1204882+00:00",
"Comment": "sample string 4",
"CC": [
"8bc65a55-e763-4685-9860-ec04f9d3b7a0",
"48bda879-2e0e-4096-b3e4-9feafde5544a"
],
"Users": [
"a9ed1874-1edb-451a-a3b1-953b271e3e0d",
"0b6cbfdd-1f2f-47d7-bf72-f666b8ce611f"
]
}
],
"StartDate": "2026-07-30T22:53:27.1204882+00:00",
"DueDate": "2026-07-30T22:53:27.1204882+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"ab06a609-7b13-43bb-b3b3-bcb68b817382": "97ce37e0-5f66-4de2-ad5b-331f195591a0",
"48310f45-8678-40cf-857b-e7ff3cdc255d": "7c23f500-8ffb-423d-b767-bcf313003b65"
},
"HasUpdates": true,
"Modified": "2026-07-30T22:53:27.1204882+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-30T22:53:27.1204882+00:00"
},
"LastComment": "2026-07-30T22:53:27.1204882+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "b417b38d-03ef-4dbb-8d55-93a14e3154b4",
"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": "bd3e2580-cb05-4a21-a423-a90f5aced1c0",
"id": "299ec3ed-63de-4eec-861d-b5aee918d3e0",
"ConfigId": "b6675e4d-01ba-4e8d-a0cc-fa0d40e93452"
}