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": "29c341db-0327-49d8-932e-87d4d76e1927",
"ParentTaskId": "f7a2e3c8-fb3e-45ee-99b9-ad446a251e71",
"Integration": {
"IntegrationId": "d72bdf7f-82d6-4a40-b827-a4efa1b67a10",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"c42e81b3-5012-4534-b1dc-3d099d7a3951": 2.0,
"400ee29f-c52e-4443-ba48-fbb1f94b62d0": 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": "c20c65d7-2ec4-4fa1-985f-2e62b808e23e",
"Name": "sample string 1",
"Created": "2026-05-21T07:04:32.6231773+00:00",
"Modified": "2026-05-21T07:04:32.6231773+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"22a40389-958a-43cd-b110-3dd9a033e4cd",
"9519efbb-3b95-4132-b578-7d01664938d7"
],
"NonLaborAssignments": [
{
"Id": "657e44fb-4aea-4cfd-ae8f-470424093256",
"ResourceId": "6a7d800d-218b-49ee-b3aa-54847b3d83fe",
"Quantity": 3.0
},
{
"Id": "657e44fb-4aea-4cfd-ae8f-470424093256",
"ResourceId": "6a7d800d-218b-49ee-b3aa-54847b3d83fe",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "3c13b979-b212-4eb5-8fef-8b222da7ebc1",
"Type": 0,
"ResourceId": "bed2a6bd-2b50-4452-83aa-ab972e8e9d4f",
"Units": 3.0
},
{
"Id": "3c13b979-b212-4eb5-8fef-8b222da7ebc1",
"Type": 0,
"ResourceId": "bed2a6bd-2b50-4452-83aa-ab972e8e9d4f",
"Units": 3.0
}
],
"ParentId": "339b9402-efc3-473c-8232-34e8e7b3302b",
"WorkTypeParentId": "85cd696f-be4c-4683-8b39-705375f9701e",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "57d9bd43-f772-40f7-bb6e-630f90023a85",
"UPN": "23ef9f10-acde-4c18-a3bf-376103755c02",
"PostDate": "2026-05-21T07:04:32.6231773+00:00",
"Comment": "sample string 4",
"CC": [
"3a6440c8-79c6-43f6-9e68-22648bc5b98f",
"0caa30e1-6ebe-42db-9c67-7f51bcfdc7e7"
],
"Users": [
"e2817ccd-8285-412c-be65-5946eb851ee8",
"98541eaf-0af0-4e72-bc52-5933597823bc"
]
},
{
"Id": "57d9bd43-f772-40f7-bb6e-630f90023a85",
"UPN": "23ef9f10-acde-4c18-a3bf-376103755c02",
"PostDate": "2026-05-21T07:04:32.6231773+00:00",
"Comment": "sample string 4",
"CC": [
"3a6440c8-79c6-43f6-9e68-22648bc5b98f",
"0caa30e1-6ebe-42db-9c67-7f51bcfdc7e7"
],
"Users": [
"e2817ccd-8285-412c-be65-5946eb851ee8",
"98541eaf-0af0-4e72-bc52-5933597823bc"
]
}
],
"StartDate": "2026-05-21T07:04:32.6231773+00:00",
"DueDate": "2026-05-21T07:04:32.6231773+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"2b474bdc-fde6-437b-8728-ecc7890f46d9": "1373704f-3215-48b1-a6a1-9336003213f9",
"60683f6a-45bc-4550-b3a3-5f15f38fc8a7": "9d974f7a-5bbc-412b-8c83-39fb1f532216"
},
"HasUpdates": true,
"Modified": "2026-05-21T07:04:32.6231773+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-05-21T07:04:32.6231773+00:00"
},
"LastComment": "2026-05-21T07:04:32.6231773+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "3d769d10-7a4b-4f39-ae8c-b4e224ddc861",
"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": "442f5ab2-1805-4abe-a6e4-b2f097a65d66",
"id": "9b342b0b-fab9-4498-84d4-37893db86011",
"ConfigId": "6246d685-97fa-4c0a-ad5f-e0c200c01ed3"
}