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": "805bdad3-649e-4053-ae34-c37ba4af48f3",
"ParentTaskId": "29853f26-9e52-4ed4-8fbc-9f1a91ddf679",
"Integration": {
"IntegrationId": "caaf3d86-aee9-4a25-be09-34a1be4feece",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"d1e1f667-fe18-485a-99b1-5a09fd15abc3": 2.0,
"8ebee561-2f28-48fc-b807-c4af8d293d80": 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": "b190167b-ae05-4c42-be8a-3129b8de2122",
"Name": "sample string 1",
"Created": "2026-07-21T11:19:24.3780285+00:00",
"Modified": "2026-07-21T11:19:24.3780285+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"f6c13434-52ee-44ed-b8ef-305d9508d82c",
"67cb2e93-d86f-4f09-86b4-26e24008748f"
],
"NonLaborAssignments": [
{
"Id": "31a2aba1-67b8-4dad-bce8-9c282906dc5d",
"ResourceId": "07c9dc3b-d86c-43ef-aed5-25ed03f8c06f",
"Quantity": 3.0
},
{
"Id": "31a2aba1-67b8-4dad-bce8-9c282906dc5d",
"ResourceId": "07c9dc3b-d86c-43ef-aed5-25ed03f8c06f",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "fa11a179-3fac-4913-98e7-5d9e429f28b9",
"Type": 0,
"ResourceId": "f23d1c4a-b174-4a69-a3ea-723171f7946e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "fa11a179-3fac-4913-98e7-5d9e429f28b9",
"Type": 0,
"ResourceId": "f23d1c4a-b174-4a69-a3ea-723171f7946e",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "d18c5c3c-43b5-4741-a152-0e8d84d1faf2",
"WorkTypeParentId": "d047e666-fcba-42f8-96c4-9a0950b122c5",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "2ca6963e-c598-474d-9f99-db4fb4313201",
"UPN": "d5e25781-a612-4465-bef6-b86e2e0ffb1f",
"PostDate": "2026-07-21T11:19:24.3780285+00:00",
"Comment": "sample string 4",
"CC": [
"e5f268b1-6521-4987-9b68-e3de7103ee81",
"53e8552f-c2f9-4bf4-b92b-63d08b0af3df"
],
"Users": [
"7a5632c8-c17f-49cd-befb-ab4d2823b28d",
"f282dbac-75eb-4beb-965e-99366d702ea9"
]
},
{
"Id": "2ca6963e-c598-474d-9f99-db4fb4313201",
"UPN": "d5e25781-a612-4465-bef6-b86e2e0ffb1f",
"PostDate": "2026-07-21T11:19:24.3780285+00:00",
"Comment": "sample string 4",
"CC": [
"e5f268b1-6521-4987-9b68-e3de7103ee81",
"53e8552f-c2f9-4bf4-b92b-63d08b0af3df"
],
"Users": [
"7a5632c8-c17f-49cd-befb-ab4d2823b28d",
"f282dbac-75eb-4beb-965e-99366d702ea9"
]
}
],
"StartDate": "2026-07-21T11:19:24.3780285+00:00",
"DueDate": "2026-07-21T11:19:24.3780285+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"67d238ed-543c-48a7-83e5-e68426c457d2": "211fe7e7-9d0c-4990-9da7-f7050029f6a4",
"85482a20-e809-4d03-a1cb-1c3aad2ac62c": "a0e81fde-d541-4df2-ba8d-678dea2eab93"
},
"HasUpdates": true,
"Modified": "2026-07-21T11:19:24.3780285+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-21T11:19:24.3780285+00:00"
},
"LastComment": "2026-07-21T11:19:24.3780285+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "92a22f83-d184-47e4-bfc4-b52eff372d70",
"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": "a1ea250c-dced-4ddc-81b9-5300aef70849",
"id": "c7d82610-9904-46ff-87d6-726417200cbc",
"ConfigId": "60bbbd17-eca3-4768-9c83-6f48d5ab3f73"
}