Custom Object in Custom Component GET API Documentation

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

                JSON
              

                      {
    "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.

Purpose

This API retrieves the list of Custom Objects associated with a specific Custom Component instance. Each custom object may contain related data such as images, documents, hazard records or other inspection-related details. The API returns links to retrieve the data stored within each custom object.

Use Case

Display all Custom Objects linked to a component in an inspection application.
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	Required	Description
`CC_UUID`	UUID	Yes	UUID of the custom component definition.
`CC_RECORD_ID`	String	Yes	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 (such as “Photos” or “Initial Hazards”), the entity type (customComponent), the relationship type (one_to_many) 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

                JSON
              

                      {
    "custom_objects": [
        {
            "uuid": "2a4fe25f-6018-47e3-83cf-25b5040218af",
            "name": "Photos",
            "entity": "customComponent",
            "type": "one_to_many",
            "values": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/HTDUFG/custom_objects/2a4fe25f-6018-47e3-83cf-25b5040218af"
        },
        {
            "uuid": "ee9caa14-85e5-4904-9694-1768aac29eb2",
            "name": "Initial Hazards",
            "entity": "customComponent",
            "type": "one_to_many",
            "values": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/HTDUFG/custom_objects/ee9caa14-85e5-4904-9694-1768aac29eb2"
        }
    ]
}
                    

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 (`one_to_many` means one component can have multiple records of this object).
`values`	String (URL)	API link to retrieve the actual records stored in this custom object.

Retrieve All Records of a Specific Custom Object: component/{CC_UUID}/{CC_RECORD_ID}/custom_objects/{CO_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response body

Retrieve Custom Object List of a Custom Component: component/{CC_UUID}/{CC_RECORD_ID}/custom_objects

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body