This section provides the steps for removing an existing object from a tenant. You can remove only objects that are non-archived, as this endpoint serves to change the state of an object from non-archived to archived.
HTTP responses
HTTP response status code | Interpretation |
200 OK | Object deleted successfully |
401 Unauthorized | Invalid or missing API key secret and/or tenant |
400 Bad Request | One or more validation errors occurred. Object cannot be removed. |
403 Forbidden | The user is not allowed to delete this type of objects |
Condition
To delete an object of a specific object type, you must have permissions for that object definition
To delete an existing active object, make a DELETE request to the /objects/{id} endpoint specifying:
Resource/endpoint destination URL. Replace the path parameter {id} with the ID of the object that you want to have removed from the repository.
The header for your API request
To delete the object with the id 647606da1a76b4928daf5f72, we pass a DELETE request to the URI https://public-api.eu.bluedolphin.app/v1/objects/647606da1a76b4928daf5f72.
curl -L -X DELETE 'https://public-api.eu.bluedolphin.app/v1/objects/647606da1a76b4928daf5f72' \ -H 'x-api-key: YOURAPIKEYSECRET' \ -H 'tenant: yourtenantname' \ -H 'Content-Type: application/json' \ -d ''
A successful call returns a response with a 200 OK HTTP status code and the following body:
{
"result": "OK"
}