Schemas

Get all schemas for a business unit

Schemas can be thought of as a blueprint. They define the fields that can be stored on a project and the sections that those fields belong to. When creating or updating projects, the schema is checked to ensure that all required fields are present, and that all fields have the correct data type.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer

Request

path Parameters

businessUnitId

required

string or null

query Parameters

OrderBy.FieldId	string or null The field id to order by
OrderBy.Ascending	boolean Whether the data should be sorted in ascending or descending order
ContinuationToken	string or null The value from the nextPageToken in a previous response. This should be URL encoded.
Top	integer <int32> The number of items to include. Defaults to 100 Example: Top=100

Responses

200

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

get/api/v1/businessUnits/{businessUnitId}/Schemas

Request samples

Response samples

application/json

{"results": [{"id": "0c8b3865-23a8-4b74-8075-4cc95b7cea56",
"schemaName": "projects",
"lastModified": "2022-01-01T12:01:48.000Z",
"dateCreated": "2022-01-01T12:01:48.000Z",
"businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
"fields": {"name": {"id": "name",
"alias": "name",
"name": "Project Name",
"type": 0,
"config": {"link": "id",
"heavyBid": {"mappedFieldIds": ["estimateName",
"projectName",
"name"
]
}
},
"readOnly": false,
"required": true,
"standard": true,
"protected": true,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"preconId": {"id": "preconId",
"alias": "preconId",
"name": "Pre-Con ID",
"type": 17,
"config": { },
"readOnly": false,
"required": false,
"standard": true,
"protected": true,
"hiddenInTable": true,
"hiddenInForm": true,
"lookup": false,
"adminOnly": false
},
"lastModified": {"id": "lastModified",
"alias": "lastModified",
"name": "Last Modified",
"type": 9,
"config": { },
"readOnly": true,
"required": false,
"standard": true,
"protected": true,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": true,
"adminOnly": false
},
"jobstatus": {"id": "jobstatus",
"alias": "jobstatus",
"name": "Project Status",
"type": 3,
"config": {"listValues": [{"display": "Prospective Work",
"value": "Prospective Work",
"hbValue": "Prospective Work"
},
{"display": "Change Order",
"value": "Change Order",
"hbValue": "Change Order"
},
{"display": "Estimating",
"value": "Estimating"
},
{"display": "Submitted",
"value": "Submitted",
"hbValue": "Submitted"
},
{"display": "Awarded",
"value": "Awarded",
"hbValue": "Awarded"
},
{"display": "Will Not Bid",
"value": "Will Not Bid"
}
],
"heavyBid": {"mappedFieldIds": ["status"
]
},
"customSort": true
},
"readOnly": false,
"required": false,
"standard": true,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"state": {"id": "state",
"alias": "state",
"name": "State",
"type": 4,
"config": {"heavyBid": {"mappedFieldIds": ["state"
]
}
},
"readOnly": false,
"required": false,
"standard": true,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"7d5347ba-29ae-4d19-868f-cf5d9d3e7748": {"id": "7d5347ba-29ae-4d19-868f-cf5d9d3e7748",
"alias": "customField1",
"name": "Custom Field 1",
"type": 15,
"config": {"latLong": true
},
"readOnly": false,
"required": false,
"standard": false,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
}
},
"sections": {"efac79ed-2b22-4381-897d-39bf0ef88d6f": {"id": "efac79ed-2b22-4381-897d-39bf0ef88d6f",
"name": "Project Details",
"fields": ["name",
"preconId",
"lastModified",
"lastModifiedBy",
"jobstatus",
"state",
"7d5347ba-29ae-4d19-868f-cf5d9d3e7748"
]
}
},
"orderedSections": ["efac79ed-2b22-4381-897d-39bf0ef88d6f"
],
"dataSyncPreference": "HeavyBid"
}
],
"nextPageToken": null,
"hasNextPage": false
}

Get a schema for a business unit by id

See GET for more information.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer

Request

path Parameters

id required	string or null The id of the schema to return
businessUnitId required	string

Responses

200

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

get/api/v1/businessUnits/{businessUnitId}/Schemas/{id}

Request samples

Response samples

application/json

{"id": "0c8b3865-23a8-4b74-8075-4cc95b7cea56",
"schemaName": "projects",
"lastModified": "2022-01-01T12:01:48.000Z",
"dateCreated": "2022-01-01T12:01:48.000Z",
"businessUnitId": "308e83a3-59bf-4422-9803-a98120b51770",
"fields": {"name": {"id": "name",
"alias": "name",
"name": "Project Name",
"type": 0,
"config": {"link": "id",
"heavyBid": {"mappedFieldIds": ["estimateName",
"projectName",
"name"
]
}
},
"readOnly": false,
"required": true,
"standard": true,
"protected": true,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"preconId": {"id": "preconId",
"alias": "preconId",
"name": "Pre-Con ID",
"type": 17,
"config": { },
"readOnly": false,
"required": false,
"standard": true,
"protected": true,
"hiddenInTable": true,
"hiddenInForm": true,
"lookup": false,
"adminOnly": false
},
"lastModified": {"id": "lastModified",
"alias": "lastModified",
"name": "Last Modified",
"type": 9,
"config": { },
"readOnly": true,
"required": false,
"standard": true,
"protected": true,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": true,
"adminOnly": false
},
"jobstatus": {"id": "jobstatus",
"alias": "jobstatus",
"name": "Project Status",
"type": 3,
"config": {"listValues": [{"display": "Prospective Work",
"value": "Prospective Work",
"hbValue": "Prospective Work"
},
{"display": "Change Order",
"value": "Change Order",
"hbValue": "Change Order"
},
{"display": "Estimating",
"value": "Estimating"
},
{"display": "Submitted",
"value": "Submitted",
"hbValue": "Submitted"
},
{"display": "Awarded",
"value": "Awarded",
"hbValue": "Awarded"
},
{"display": "Will Not Bid",
"value": "Will Not Bid"
}
],
"heavyBid": {"mappedFieldIds": ["status"
]
},
"customSort": true
},
"readOnly": false,
"required": false,
"standard": true,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"state": {"id": "state",
"alias": "state",
"name": "State",
"type": 4,
"config": {"heavyBid": {"mappedFieldIds": ["state"
]
}
},
"readOnly": false,
"required": false,
"standard": true,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
},
"7d5347ba-29ae-4d19-868f-cf5d9d3e7748": {"id": "7d5347ba-29ae-4d19-868f-cf5d9d3e7748",
"alias": "customField1",
"name": "Custom Field 1",
"type": 15,
"config": {"latLong": true
},
"readOnly": false,
"required": false,
"standard": false,
"protected": false,
"hiddenInTable": false,
"hiddenInForm": false,
"lookup": false,
"adminOnly": false
}
},
"sections": {"efac79ed-2b22-4381-897d-39bf0ef88d6f": {"id": "efac79ed-2b22-4381-897d-39bf0ef88d6f",
"name": "Project Details",
"fields": ["name",
"preconId",
"lastModified",
"lastModifiedBy",
"jobstatus",
"state",
"7d5347ba-29ae-4d19-868f-cf5d9d3e7748"
]
}
},
"orderedSections": ["efac79ed-2b22-4381-897d-39bf0ef88d6f"
],
"dataSyncPreference": "HeavyBid"
}

Update the alias of a field on the schema

This endpoint will change how a project field is referenced in the Projects API.

Caution: Updating the alias of an existing field will likely break existing integrations with the projects API.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer

Request

path Parameters

businessUnitId

required

string

Request Body schema: application/json

The existing alias and new alias

existingFieldAlias required	string
newFieldAlias required	string

Responses

204

Empty response indicating that the field alias was successfully updated

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

post/api/v1/businessUnits/{businessUnitId}/Schemas/updateFieldAlias

Request samples

application/json

{"existingFieldAlias": "string",
"newFieldAlias": "string"
}