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": "74272ebe-968d-497b-ad2c-edcd6b160678",
"ParentTaskId": "e50cdae2-648f-4e3b-a97a-5a7c846072e4",
"Integration": {
"IntegrationId": "7b6d0dda-5a09-44f7-a773-17142d9b0b06",
"ExternalItemId": "sample string 2",
"ExternalUrl": "sample string 3",
"ReadOnlyFields": [
"sample string 1",
"sample string 2"
]
},
"Assignments": {
"812f21e3-d68f-4b3a-a9bf-d494ca48ac95": 2.0,
"d5181acf-9070-47f5-b364-32cfa33c04ba": 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": "48e7bc45-2144-4ee2-9741-61ab2599f077",
"Name": "sample string 1",
"Created": "2026-08-13T23:54:08.436686+00:00",
"Modified": "2026-08-13T23:54:08.436686+00:00",
"Author": "sample string 4",
"Editor": "sample string 5",
"AssignedTo": [
"2b6b4271-5274-484f-8dda-ae6ed84d7e0e",
"232ce8fe-7c10-4e39-8b29-a54ee6a86533"
],
"NonLaborAssignments": [
{
"Id": "66efadbe-bc32-4098-b561-3eac5ad256ed",
"ResourceId": "b3c7574d-50fc-4b50-a641-b20fc0c21c36",
"Quantity": 3.0
},
{
"Id": "66efadbe-bc32-4098-b561-3eac5ad256ed",
"ResourceId": "b3c7574d-50fc-4b50-a641-b20fc0c21c36",
"Quantity": 3.0
}
],
"Assignments": [
{
"Id": "59825ca6-802a-4c19-9ceb-cbdb1352d7a2",
"Type": 0,
"ResourceId": "d0653bd4-99fd-4fe5-9a9d-31146245626d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
},
{
"Id": "59825ca6-802a-4c19-9ceb-cbdb1352d7a2",
"Type": 0,
"ResourceId": "d0653bd4-99fd-4fe5-9a9d-31146245626d",
"Units": 3.0,
"Quantity": 4.0,
"Cost": 5.0
}
],
"ParentId": "48f958d3-7936-4b3e-8b0e-fc65a160dfc5",
"WorkTypeParentId": "b7307d35-2468-46b4-bd28-8ad2c03c928d",
"WorkTypeIndex": 9,
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"Index": 10,
"Complete": true,
"Comments": [
{
"Id": "45c959c8-8dc9-4341-8dfc-066f498141ed",
"UPN": "5421cf26-4769-46ad-b709-a7886bc7ad70",
"PostDate": "2026-08-13T23:54:08.436686+00:00",
"Comment": "sample string 4",
"CC": [
"50aa0073-88b4-4843-9a91-18b6f49fe618",
"9706d2b1-2a96-4b2a-98b1-6883d43a705d"
],
"Users": [
"d3cbedfa-a7a2-419c-af63-b19211ab6327",
"5f76da3d-b58d-430b-8838-d9d90622fddf"
]
},
{
"Id": "45c959c8-8dc9-4341-8dfc-066f498141ed",
"UPN": "5421cf26-4769-46ad-b709-a7886bc7ad70",
"PostDate": "2026-08-13T23:54:08.436686+00:00",
"Comment": "sample string 4",
"CC": [
"50aa0073-88b4-4843-9a91-18b6f49fe618",
"9706d2b1-2a96-4b2a-98b1-6883d43a705d"
],
"Users": [
"d3cbedfa-a7a2-419c-af63-b19211ab6327",
"5f76da3d-b58d-430b-8838-d9d90622fddf"
]
}
],
"StartDate": "2026-08-13T23:54:08.436686+00:00",
"DueDate": "2026-08-13T23:54:08.436686+00:00",
"TaskScheduleType": 0,
"StatusUpdate": {
"ResourceReplacements": {
"97693956-13c8-4781-a7a2-35b4fe45238f": "c21d5309-1568-45c8-9016-74eba0c3edf5",
"ebfeba69-e6dc-4407-a8ff-739af10b0227": "3a59df85-7f13-4987-8e5e-9f0e6ace53ac"
},
"HasUpdates": true,
"Modified": "2026-08-13T23:54:08.436686+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-08-13T23:54:08.436686+00:00"
},
"LastComment": "2026-08-13T23:54:08.436686+00:00",
"IsScheduled": true,
"Integration": {
"IntegrationId": "76f37fca-2848-4d68-9e35-d4b763e524ae",
"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": "5f848b4d-1026-4576-b0e3-c2f15f404efe",
"id": "8b7a4f59-d823-49cd-b909-dde26febd66f",
"ConfigId": "86b50263-3e42-4fa3-8ddf-3967b2eca086"
}