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": "1cb86063-55f5-4b98-99d0-e859a5a41d3b",
"ParentTaskId": "6ea9bdef-6e02-400a-a1f8-b3bcf5542cd1",
"Integration": {
"IntegrationId": "2cb4025d-7438-48be-9063-8c09805d423c",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"1bcecf77-76ac-4bb5-aacc-8a701a2aac61": 2.0,
"2516945f-a679-44b5-b3bd-7794c25f509c": 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": "2cd2e0d6-4021-4792-ab7f-83b5ca04ea43",
"Name": "sample string 1",
"Created": "2026-06-24T10:00:00.8271211+00:00",
"Modified": "2026-06-24T10:00:00.8271211+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2ed9518e-0537-4837-8d2a-6b69a3997622",
"0852be8b-ea62-4419-a7dc-576c000a939f"
],
"NonLaborAssignments": [
{
"Id": "7026478b-80b4-4f10-8797-d47e8f027ab8",
"ResourceId": "9a8efd20-28b1-4b13-be5a-d66de7c36206",
"Quantity": 3.0
},
{
"Id": "7026478b-80b4-4f10-8797-d47e8f027ab8",
"ResourceId": "9a8efd20-28b1-4b13-be5a-d66de7c36206",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "1313df68-6612-4106-9f36-a5384c6e2ec9",
"Type": 0,
"ResourceId": "21c38d2c-830c-4192-92b1-4de89be71c54",
"Units": 3.0
},
{
"Id": "1313df68-6612-4106-9f36-a5384c6e2ec9",
"Type": 0,
"ResourceId": "21c38d2c-830c-4192-92b1-4de89be71c54",
"Units": 3.0
}
],
"ParentId": "6b4d0325-d5da-4516-b133-e7a2aa78e88c",
"WorkTypeParentId": "5ce67bde-8814-4434-8116-7fd306f05d90",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "69a35e8a-50f4-4e19-8ab1-d65110415feb",
"UPN": "0d777656-acb6-485e-8da0-eb8e2182ac22",
"PostDate": "2026-06-24T10:00:00.8271211+00:00",
"Comment": "sample string 4",
"CC": [
"bec44efd-60e0-4bdc-8448-e08fd1b21fcc",
"2db28b35-7e23-473f-84b2-420150d8b656"
],
"Users": [
"288bdfe4-d105-402d-93f9-3096c5e397ab",
"00cd82ee-dade-4ef7-a620-d281f4ec15a7"
]
},
{
"Id": "69a35e8a-50f4-4e19-8ab1-d65110415feb",
"UPN": "0d777656-acb6-485e-8da0-eb8e2182ac22",
"PostDate": "2026-06-24T10:00:00.8271211+00:00",
"Comment": "sample string 4",
"CC": [
"bec44efd-60e0-4bdc-8448-e08fd1b21fcc",
"2db28b35-7e23-473f-84b2-420150d8b656"
],
"Users": [
"288bdfe4-d105-402d-93f9-3096c5e397ab",
"00cd82ee-dade-4ef7-a620-d281f4ec15a7"
]
}
],
"StartDate": "2026-06-24T10:00:00.8271211+00:00",
"DueDate": "2026-06-24T10:00:00.8271211+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"d6ddf48c-84ca-4c6d-ab1f-2510c8ac403d": "6b017ed4-0576-487d-8ae8-1c925bf13a81",
"76ce05e1-cdad-4c97-8ef1-683a18e1b2f6": "a43ba8f4-1e75-4892-8542-35f5b8264c91"
},
"HasUpdates": true,
"Modified": "2026-06-24T10:00:00.8271211+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-06-24T10:00:00.8271211+00:00"
},
"LastComment": "2026-06-24T10:00:00.8271211+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "a8dd1709-c668-481a-96d5-2feaa7262b7e",
"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": "5822a07f-399a-4ecc-b65c-5fd36c99a4b3",
"id": "47d5f532-09b4-4ede-af61-19342f3f1aef",
"ConfigId": "dfc48f4a-192e-44c7-804d-3daaf60efa27"
}