SORTING WARNING
Sorting using the Dev Portal will not work. Please configure sorting appropriately in your application using the correct syntax below.
sorting
GET /businessUnits/{businessUnitId}/projects?orderBy.fieldId=name%26orderBy.ascending=true
FILTER WARNING
Filtering using the Dev Portal will not work. Please configure filtering appropriately in your application using the correct syntax below.
filtering a string field
GET /businessUnits/{businessUnitId}/projects?filters[0].fieldId=name%26filters[0].contains=project
filtering a numeric field
GET /businessUnits/{businessUnitId}/projects?filters[0].fieldId=52fec515-2012-4d2d-b8ae-17c3b274bb84%26filters[0].lowerBound=100
filtering a date field
GET /businessUnits/{businessUnitId}/projects?filters[0].fieldId=8230a513-065b-4928-a64b-57cef4de1a31%26filters[0].lowerBound=2021-01-01T00:00:00.00000Z
paging
GET /businessUnits/{businessUnitId}/projects?continuationToken=continuationToken%26top=100
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
{- "results": [
- {
- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false
}
], - "nextPageToken": null,
- "hasNextPage": false
}
The fields property is dependent on the Project schema. Any missing required fields or incorrectly formatted fields will result in a 400.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
The new project to create. Must contain a fields property with any required fields specified in the project schema for the current business unit.
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8"
}
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false,
- "warnings": [
- {
- "fieldId": "string",
- "fieldName": "string",
- "message": "string",
- "warningValue": null
}
]
}
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false
}
This will replace the existing project with whatever is passed in the request body. Any missing values in the request body will be erased. For partial updates look at the Patch method
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
The new project to replace the old one with
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8"
}
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false,
- "warnings": [
- {
- "fieldId": "string",
- "fieldName": "string",
- "message": "string",
- "warningValue": null
}
]
}
This is a PARTIAL implementation of the JsonPatch protocol - See https://tools.ietf.org/html/rfc6902 for more information.
Setting an object property within an array is NOT supported (e.g. "path": "fields/estimates/2/selectedEstimate")
Instead, use a replace on the full array element (e.g. "path": "fields/estimates/2")
Examples of valid operations:
Replace a string:
PATCH /businessUnits/{businessUnitId}/projects/{id}
[
{
"path": "fields/name",
"op": "add",
"value": "New Project Name"
}
]
Replace an entire array:
PATCH /businessUnits/{businessUnitId}/projects/{id}
[
{
"path": "fields/bidResults",
"op": "add",
"value": [{"name": "Competitor 1", "amount": 38204, "winner": true}]
}
]
Add an element to end of array:
PATCH /businessUnits/{businessUnitId}/projects/{id}
[
{
"path": "fields/bidResults/-",
"op": "add",
"value": {"name": "Competitor 1", "amount": 38204, "winner": true}
}
]
Replace the first element in an array:
PATCH /businessUnits/{businessUnitId}/projects/{id}
[
{
"path": "fields/bidResults/0",
"op": "replace",
"value": {"name": "Competitor 1", "amount": 38204, "winner": true}
}
]
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
[- {
- "path": "string",
- "op": "string",
- "from": "string",
- "value": null
}
]
{- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false,
- "warnings": [
- {
- "fieldId": "string",
- "fieldName": "string",
- "message": "string",
- "warningValue": null
}
]
}
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
Empty response indicating that the delete was successful
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
Similar to the POST and PUT endpoints, but allows for multiple projects to be created or updated in a single request. See POST for more information.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
an array of projects to create
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
[- {
- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8"
}
]
{- "success": [
- {
- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false
}
], - "failed": [
- {
- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false
}
], - "invalid": [
- {
- "entry": {
- "id": "c33d6196-ecae-4bca-8d90-93f6951ba9b6",
- "lastModifiedByUserId": "17f96543-9898-4be2-b6c7-e6723bbb1389",
- "lastModifiedByClientId": "string",
- "lastModifiedBySystemUser": true,
- "dateCreated": "2022-01-01T12:01:48.000Z",
- "lastModified": "2022-01-01T12:01:48.000Z",
- "deleted": false,
- "businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
- "fields": {
- "name": "Project 123"
}, - "fieldsMetadata": {
- "fieldId": {
- "isLocked": true
}
}, - "locationId": "65f43597-43dd-4380-8930-91e0045f8aa8",
- "archived": false
}, - "errors": [
- {
- "fieldId": "string",
- "fieldName": "string",
- "message": "string",
- "invalidValue": null
}
], - "warnings": [
- {
- "fieldId": "string",
- "message": "string",
- "warningValue": null
}
], - "index": 0
}
]
}
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.
[- "string"
]
{- "success": [
- "string"
], - "failed": [
- "string"
]
}