Retrieve Specific Custom Object Details of a Custom Component Record: component/{component_uuid}/{component_record_id}/custom_objects/{object_uuid}
Purpose
Retrieves all individual records stored within a specific custom object of a given custom component record. This allows you to view the detailed entries for that object, including attribute values, creation and update metadata, and links to each record’s API endpoint.
Use Case
- Fetch all hazard entries linked to an inspection record.
- Retrieve supporting data (example: photos, hazard details) from a custom object for processing or display.
- Paginate through multiple entries when a custom object contains a large dataset.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
CC_UUID |
UUID | Yes | UUID of the custom component definition. |
CC_RECORD_ID |
String | Yes | Unique ID of the custom component record. |
CO_UUID |
UUID | Yes | UUID of the custom object definition. |
Query Parameters
This endpoint does not require query parameters.
Request Body
This endpoint does not required any Request Body.
Response
The API returns a "custom_object" array containing all records for the specified custom object. Each record includes a UUID, creation and update details, a direct link to fetch that record individually, an optional version and an attributes array holding the record’s data as name/value pairs (example: hazard type, description and risk score). The response also contains a pagination object showing the total number of records, current limit, offset, and navigation links for previous and next pages.
Response body
{
"custom_object": [
{
"uuid": "19bfdd16-eb35-4b46-91a8-47daa4c3e8df",
"created_by": "Implementer",
"created_on": "2025-08-12T10:49:00Z",
"last_updated_by": "saeedullah",
"last_updated_on": "2025-08-12T11:05:23Z",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/19bfdd16-eb35-4b46-91a8-47daa4c3e8df",
"version": "",
"attributes": [
{
"name": "Hazard_Type",
"value": "Biological"
},
{
"name": "Hazard_Description",
"value": "repellendus Consectetur quidem ut in assumenda qui"
},
{
"name": "Risk_Score",
"value": "5"
}
]
},
{
"uuid": "e6b3e411-0aef-4807-9765-3aba53e166ab",
"created_by": "saeedullah",
"created_on": "2025-08-12T10:59:03Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/e6b3e411-0aef-4807-9765-3aba53e166ab",
"version": "",
"attributes": [
{
"name": "Hazard_Type",
"value": "Biological"
},
{
"name": "Hazard_Description",
"value": "Adipisci quaerat debitis fugiat ut perferendis dignissimos sequi exercitation velit Nam mollitia repellendus Consectetur quidem ut in assumenda qui"
},
{
"name": "Risk_Score",
"value": "6"
}
]
},
{
"uuid": "813d3fb8-291d-4b6c-8d30-af1c0a12e93a",
"created_by": "saeedullah",
"created_on": "2025-08-12T11:02:40Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/813d3fb8-291d-4b6c-8d30-af1c0a12e93a",
"version": "",
"attributes": [
{
"name": "Hazard_Type",
"value": "Biological"
},
{
"name": "Hazard_Description",
"value": "Consectetur quidem ut in assumenda qui"
},
{
"name": "Risk_Score",
"value": "5"
}
]
},
{
"uuid": "c3186b06-5d7f-45d3-b37b-a4dd8ae4938e",
"created_by": "saeedullah",
"created_on": "2025-08-12T11:02:40Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/c3186b06-5d7f-45d3-b37b-a4dd8ae4938e",
"version": "",
"attributes": [
{
"name": "Hazard_Type",
"value": "Biological"
},
{
"name": "Hazard_Description",
"value": "Adipisci quaerat debitis fugiat ut perferendis dignissimos"
},
{
"name": "Risk_Score",
"value": "8"
}
]
}
],
"pagination": {
"records": 4,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| custom_object | Array of Objects | List of records stored in the specified custom object. |
uuid |
UUID | Unique identifier of the custom object record. |
created_by |
String | Name of the user who created the record. |
created_on |
DateTime (ISO 8601) | Timestamp when the record was created. |
last_updated_by |
String | Name of the last user who updated the record (empty if never updated). |
last_updated_on |
DateTime (ISO 8601) | Timestamp of the last update (empty if never updated). |
link |
String (URL) | API endpoint to retrieve this record individually. |
version |
String | Version number of the record (if versioning is enabled). |
attributes |
Array of Objects | List of attributes (field name and value) for the record. |
| pagination | Object | Metadata about total records, limits, and navigation between pages. |
Retrieve Custom Object List of a Custom Component: /component/{component_uuid}/{component_record_id}/custom_objects
Purpose
This API retrieves the list of Custom Objects associated with a specific Custom Component record.
Use Case
- Display all Custom Objects linked to a component.
- Fetch media (example: photos) or structured records (example: hazard reports) associated with a component.
- Dynamically load additional component-related content by calling the provided values, URLs.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| component_uuid | UUID | UUID of the custom component definition. |
| component_record_id | String | Unique ID of the custom component record. |
Query Parameters
This endpoint does not require query parameters.
Request Body
This is a GET request and does not require a request body.
Response
The API returns a custom objects array containing all objects linked to a specific custom component record. Each object includes a unique uuid, a name describing the type of data it holds, the entity type, the relationship type and a values URL. This URL can be used to fetch the actual records or files stored in that object, allowing you to identify related data and retrieve it when needed.
Response Body
{
"custom_objects": [
{
"uuid": "{{custom_object_uuid_1}}",
"name": "{{custom_object_name_1}}",
"entity": "{{associated_entity_type}}",
"type": "{{relationship_type}}",
"values": "{{custom_object_values_link_1}}"
},
{
"uuid": "{{custom_object_uuid_2}}",
"name": "{{custom_object_name_2}}",
"entity": "{{associated_entity_type}}",
"type": "{{relationship_type}}",
"values": "{{custom_object_values_link_2}}"
}
]
}
| Attribute | Type | Description |
|---|---|---|
| uuid | UUID | Unique identifier for the custom object. |
| name | String | Display name of the custom object. |
| entity | String | Entity type to which the custom object belongs (example: customComponent). |
| type | String | Relationship type. |
| values | String (URL) | API link to retrieve the actual records stored in this custom object. |