Retrieve Custom Component Details: /component/{component_uuid}
Purpose
This API retrieves detailed information about a specific custom component, identified by its unique component_uuid. The response includes metadata and associated resources linked to the component, such as the list of forms it contains, available attributes, and related configuration details. This endpoint is useful for viewing the structure and content of a custom component, enabling administrators and developers to understand its composition and dependencies. It supports tasks such as reviewing the component setup, validating configurations, and ensuring the correct forms and attributes are associated with the intended component.
Use Case
This API is useful for retrieving all forms, attributes, and related configuration data tied to a specific custom component in the system. It can be used by administrators to audit existing components, confirm that required forms are properly linked, and verify attribute availability. Developers can leverage it to dynamically display component details in dashboards or configuration interfaces, or to validate integration logic that relies on component data. In troubleshooting scenarios, this endpoint helps identify missing or misconfigured forms and attributes, ensuring that the custom component functions as expected.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
component_uuid | String | Unique ID of a a custom component |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| records | Integer | Total number of records returned in the current result set. |
| limit | Integer | Maximum number of records returned per page. |
| offset | Integer | Number of records skipped before starting to collect results. |
| previousPage | String | URL or token for the previous page of results (if applicable). |
| nextPage | String | URL or token for the next page of results (if applicable |
Request Body
No request body is required for this endpoint.
Response
This API returns detailed information about a specific custom component, including all forms linked to that component, their associated attributes, and any custom objects within those forms. For each form, the API provides metadata such as form UUID, form name, status, version, creation and update details, workflow status, and the list of attributes with their corresponding values. The custom_objects array lists all custom objects connected to the form, including their UUID, name, and an API link to retrieve their detailed data. The response also includes a pagination object to support paginated results, providing records, limit, offset, and navigation details for previous_page and next_page. In case of errors such as invalid component UUID, insufficient permissions, or internal service failure, the API returns a structured error response containing diagnostic information to assist in troubleshooting.
Response Body
{
"Patient Medical Record": [
{
"status": "ACTIVE",
"id": "XXXXXX",
"parents": [
{
"type": "account",
"id": "ACCOUNT-ID"
}
],
"custom_form": {
"uuid": "FORM-UUID",
"name": "Custom Form Name"
},
"created_by": "Creator Name",
"created_on": "YYYY-MM-DDTHH:MM:SSZ",
"last_updated_by": "Updater Name",
"last_updated_on": "YYYY-MM-DDTHH:MM:SSZ",
"uuid": "RECORD-UUID",
"version": "1",
"attributes": [
{
"name": "Attribute_Name_1",
"value": "Value 1"
},
{
"name": "Attribute_Name_2",
"value": "Value 2"
}
],
"attribute_groups": [],
"custom_objects": [
{
"uuid": "OBJECT-UUID-1",
"name": "Custom Object Name 1",
"link": "https://api.example.com/custom_objects/OBJECT-UUID-1"
},
{
"uuid": "OBJECT-UUID-2",
"name": "Custom Object Name 2",
"link": "https://api.example.com/custom_objects/OBJECT-UUID-2"
}
],
"workflow_status": "Workflow Stage"
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "NULL"
}
}Retrieve Custom Component Details By ID: /component/{component_uuid}/{id}
Purpose
This API retrieves detailed information about a single record within a custom component, identified by the component's unique component_uuid and the specific record id. The response includes metadata and associated data such as the form details, attributes, custom objects, and workflow status related to that particular record. This endpoint is useful for viewing the full data of a single custom component record, enabling administrators and developers to inspect, validate, or display detailed information of a specific record within the component.
Use Case
This API is useful for retrieving all details associated with a single record of a custom component. It supports administrators who need to audit or review a specific record, developers building interfaces that display individual component record details, and integration scenarios requiring precise retrieval of a particular form submission and its related objects. In troubleshooting, it helps verify attribute values, custom object linkage, and workflow state for a given record to ensure data accuracy and integrity.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
component_uuid | String | Unique identifier for the custom component |
id | String | Unique identifier for the specific record within the component |
Query Parameters
No query parameters are required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
Returns detailed information about a single custom component record, including metadata such as record ID, form UUID and name, status, version, creation and update details, workflow status, and a list of attributes with their values. The response also includes any custom objects linked to this record, providing their UUID, name, and API link for further detail. The API responds with a JSON object representing the single record. In case of errors such as invalid component UUID or record ID, insufficient permissions, or internal service issues, the API returns a structured error response containing diagnostic information to assist in troubleshooting.
Response Body
{
"Patient Medical Record": {
"status": "STATUS_VALUE",
"id": "RECORD_ID",
"parents": [
{
"type": "PARENT_TYPE",
"id": "PARENT_ID"
}
],
"custom_form": {
"uuid": "CUSTOM_FORM_UUID",
"name": "Custom Form Name"
},
"created_by": "CREATOR_NAME",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATER_NAME",
"last_updated_on": "LAST_UPDATE_TIMESTAMP",
"uuid": "RECORD_UUID",
"version": "VERSION_NUMBER",
"attributes": [
{
"name": "ATTRIBUTE_NAME_1",
"value": "ATTRIBUTE_VALUE_1"
},
{
"name": "ATTRIBUTE_NAME_2",
"value": "ATTRIBUTE_VALUE_2"
}
/* additional attributes as needed */
],
"attribute_groups": [],
"custom_objects": [
{
"uuid": "CUSTOM_OBJECT_UUID_1",
"name": "Custom Object Name 1",
"link": "https://api.example.com/custom_objects/CUSTOM_OBJECT_UUID_1?limit=10&offset=0"
},
{
"uuid": "CUSTOM_OBJECT_UUID_2",
"name": "Custom Object Name 2",
"link": "https://api.example.com/custom_objects/CUSTOM_OBJECT_UUID_2?limit=10&offset=0"
}
/* additional custom objects as needed */
],
"workflow_status": "WORKFLOW_STATUS_VALUE"
}
}Retrieve Custom Component List: /settings/components
Purpose
This API retrieves all custom components available in the Exsited system. Custom components are reusable building blocks that can be associated with various resources, each having attributes like UUID, status, name, display name, description, usage scope, and relationship type. The response includes an array of components along with pagination details such as total records, limit, offset, and navigation links for previous and next pages. This endpoint supports scenarios where a complete list of available custom components is needed for configuration, display, or selection purposes.
Use Case
Use this API when you need to display or manage all custom components within the Exsited system, such as populating dropdowns, configuring component usage, or reviewing available component definitions.
Path Parameters
No path parameters required for this endpoint.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| records | Integer | Total number of records returned in the current result set. |
| limit | Integer | Maximum number of records returned per page. |
| offset | Integer | Number of records skipped before starting to collect results. |
| previousPage | String | URL or token for the previous page of results (if applicable). |
| nextPage | String | URL or token for the next page of results (if applicable |
Request Body
No request body is required for this endpoint.
Response
The API response contains a components array, where each object represents a component with details such as its unique identifier (uuid), current status (e.g., ACTIVE), name, display_name, description, the use_in array specifying the associated resource, and the relation type (e.g., one.to.many). In this example, five components are returned: "Lodge Template," "Custom Account," "Patient Medical Record," "Inspection Service Package," and "Vendor Details." Along with the components, the response includes a pagination object providing metadata such as the total records count, limit, offset, and navigation details for previous_page and next_page.
Response Body
{
"components": [
{
"uuid": "component-uuid-1234",
"status": "ACTIVE",
"name": "Sample Component",
"display_name": "Sample Component",
"description": "Sample description",
"use_in": [
{
"resource": "sample_resource"
}
],
"relation": "one.to.many"
}
],
"pagination": {
"records": 1,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": null
}
}Retrieve Custom Component in PDF: component/{CC_UUID}/{CC_RECORD_ID}/pdf
Purpose
This API generates a downloadable PDF file containing all the data and attributes of a specific custom component record. It is commonly used for reporting, archiving, or sharing inspection results in a standardized document format.
Use Case
This endpoint is used when you need a formatted, printable, and shareable PDF version of a Component record. Typical use cases include generating inspection reports, exporting compliance forms, attaching documentation for audits, or sharing signed records with stakeholders. It allows users to download a professional copy of the data captured inside the Component for archiving or external communication.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| CC_UUID | string | Yes | UUID of the Component definition that identifies which Component is targeted. |
| CC_RECORD_ID | string | Yes | Unique identifier of the specific Component record whose PDF needs to be retrieved. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
The response is a PDF file containing the complete details of the requested component record, including all form fields, associated objects, entered values, and metadata, formatted in a structured and printable layout for reporting or record-keeping purposes.
Response Body
Here is a sample pdf file. It will be generated based on the pdf configuration.
