Create Custom Object Instances for a Custom Component: component/{CC_UUID}/{CC_RECORD_ID}/custom_objects/{CO_UUID}
POST
https://dev-api.exsited.com/api/v3component/{CC_UUID}/{CC_RECORD_ID}/custom_objects/{CO_UUID}
Try It Out
Purpose
This API creates new instance(s) of a specified custom object for a given custom component record. A custom object instance stores structured data defined by attributes (name/value pairs) and can have a one-to-one or one-to-many relationship with the parent record.
Use Case
Use this endpoint when you want to attach custom, structured data (example: hazard information, photos, checklist items) to a specific record in a custom component. For example, during a site inspection, you might store hazard details for each inspection form using this API.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
CC_UUID |
UUID | Yes | Unique identifier of the custom component. |
CC_RECORD_ID |
String | Yes | Unique ID of the specific record in the custom component. |
CO_UUID |
UUID | Yes | Unique identifier of the custom object you want to create instances for. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
One to One
One to Many
{
"custom_object_instances": {
"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" }
]
}
}
{
"custom_object_instances": [
{
"attributes": [
{ "name": "Hazard_Type", "value": "Biological" },
{ "name": "Hazard_Description", "value": "Adipisci quaerat debitis fugiat ut perferendis dignissimos" },
{ "name": "Risk_Score", "value": "8" }
]
},
{
"attributes": [
{ "name": "Hazard_Type", "value": "Biological" },
{ "name": "Hazard_Description", "value": "Consectetur quidem ut in assumenda qui" },
{ "name": "Risk_Score", "value": "5" }
]
}
]
}
| Attribute | Type | Description |
|---|---|---|
custom_object_instances |
Object / Array | The instance(s) of the custom object being created. |
attributes |
Array | List of name/value pairs storing the actual data for this instance. |
name |
String | Attribute name (must match the defined custom object’s schema). |
value |
String | Attribute value. |
Response
The response contains the created instance(s) with metadata and the stored attributes.
Response Body
One to One
One to Many
{
"custom_object_instances": {
"uuid": "edc3e329-4942-4389-84b4-62c3d97e2c67",
"id": "CO-0053",
"name": "Initial Hazards",
"entity": "customComponent",
"entity_id": "29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23",
"created_by": "saeedullah",
"created_on": "2025-08-13T08:08:31Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/edc3e329-4942-4389-84b4-62c3d97e2c67",
"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" }
]
}
}{
"custom_object_instances": [
{
"uuid": "014555f8-9286-4918-b47b-78c3dc6d825d",
"id": "CO-0055",
"name": "Initial Hazards",
"entity": "customComponent",
"entity_id": "29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23",
"created_by": "saeedullah",
"created_on": "2025-08-13T08:16:22Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/014555f8-9286-4918-b47b-78c3dc6d825d",
"version": "",
"attributes": [
{ "name": "Hazard_Type", "value": "Biological" },
{ "name": "Hazard_Description", "value": "Consectetur quidem ut in assumenda qui" },
{ "name": "Risk_Score", "value": "5" }
]
},
{
"uuid": "06ecc62e-7120-4ce5-984c-c8a8a0558a13",
"id": "CO-0054",
"name": "Initial Hazards",
"entity": "customComponent",
"entity_id": "29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23",
"created_by": "saeedullah",
"created_on": "2025-08-13T08:16:22Z",
"last_updated_by": "",
"last_updated_on": "",
"link": "https://dev-api.exsited.com/api/v2/component/29d56e2b-4a03-4884-946d-22856b742ae8/9B7G23/custom_objects_instances/06ecc62e-7120-4ce5-984c-c8a8a0558a13",
"version": "",
"attributes": [
{ "name": "Hazard_Type", "value": "Biological" },
{ "name": "Hazard_Description", "value": "Adipisci quaerat debitis fugiat ut perferendis dignissimos" },
{ "name": "Risk_Score", "value": "8" }
]
}
]
}| Attribute | Type | Description |
|---|---|---|
custom_object_instances |
Object / Array | Created custom object instance(s). |
uuid |
UUID | Unique identifier of the custom object instance. |
id |
String | System-generated identifier for the instance. |
name |
String | Display name of the custom object. |
entity |
String | Entity type (example: customComponent). |
entity_id |
String | Identifier of the parent custom component record. |
created_by |
String | User who created the record. |
created_on |
DateTime (ISO 8601) | Timestamp when the record was created. |
last_updated_by |
String | User who last updated the record. |
last_updated_on |
DateTime (ISO 8601) | Timestamp of the last update. |
link |
String (URL) | API endpoint to fetch the record individually. |
version |
String | Version number (if versioning is enabled). |
attributes |
Array | List of name/value attribute pairs containing the stored data. |