Update a Custom Object Instance: component/{CC_UUID}/{CC_RECORD_ID}/custom_objects_instances/{COI_UUID}
PATCH
https://dev-api.exsited.com/api/v3component/{CC_UUID}/{CC_RECORD_ID}/custom_objects_instances/{COI_UUID}
Try It Out
Purpose
This API updates the attributes of an existing custom object instance that belongs to a specific custom component record. It allows you to modify stored data such as hazard details, scores or other attributes without creating a new instance.
Use Case
Useful for field inspections, hazard assessments or any workflow where existing recorded data must be corrected, refined or updated. For example, changing a hazard description after re-evaluation or updating a risk score following further analysis.
Path Parameters
Parameter | Type | Description |
---|---|---|
CC_UUID |
UUID | Unique identifier of the custom component. |
CC_RECORD_ID |
String | Unique record ID of the specific custom component instance. |
COI_UUID |
UUID | Unique identifier of the custom object instance to be updated. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
JSON
{
"custom_object_instances": {
"attributes": [
{
"name": "Hazard_Type",
"value": "Biological"
},
{
"name": "Hazard_Description",
"value": "repellendus Consectetur quidem ut in assumenda qui"
},
{
"name": "Risk_Score",
"value": "8"
}
]
}
}
Response
When successful, the API returns the updated custom object instance with its metadata and new attribute values.
Response Body
JSON
{
"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": "saeedullah",
"last_updated_on": "2025-08-13T09:08:14Z",
"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": "repellendus Consectetur quidem ut in assumenda qui"
},
{
"name": "Risk_Score",
"value": "8"
}
]
}
}
Attribute | Type | Description |
---|---|---|
uuid |
UUID | Unique identifier for the custom object instance. |
id |
String | Readable ID of the custom object instance. |
name |
String | Display name of the custom object instance. |
entity |
String | The entity type (e.g., customComponent ). |
entity_id |
String | Combined ID of the related custom component and record. |
created_by |
String | User who originally created the object instance. |
created_on |
DateTime | ISO 8601 timestamp of creation. |
last_updated_by |
String | User who last updated the instance. |
last_updated_on |
DateTime | ISO 8601 timestamp of the last update. |
link |
URL | API link to retrieve this specific object instance. |
version |
String | Version number (if versioning is enabled). |
attributes |
Array | List of key-value pairs representing stored data fields. |