Delete Custom Component: /component/{component_uuid}/{component_record_id}
Purpose
This API deletes a specific component record identified by its unique component UUID and component record ID. It removes the targeted record from the system, ensuring that the data associated with that component instance is permanently erased. This endpoint is useful for administrators or authorized users who need to clean up, correct, or manage component data by deleting outdated or incorrect records.
Use Case
This API is used to delete a single component record within a given custom component, identified by its UUID and record ID. It is particularly valuable in workflows requiring data removal due to errors, data cleanup tasks, or when a record is no longer relevant. Developers and system administrators can integrate this endpoint to provide record deletion capabilities within administrative interfaces or automated maintenance scripts. Proper permissions and authentication are required to perform this operation to prevent unauthorized data loss.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| component_uuid | String | Unique identifier of the custom component. |
| component_record_id | String | Unique identifier of the component record to delete. |
Query Parameters
No query parameters are required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
This endpoint does not return a response body. Upon successful execution, the specified component record is deleted and an HTTP 204 No Content status code is returned. If the deletion fails due to issues such as an invalid component UUID, invalid record ID, or insufficient permissions, the API returns an error response containing descriptive messages and backend details to assist with troubleshooting and resolution.