(Quick Reference)
Service: Delete an authority
Description: Returns a json response.
URL:
https://BASE_URL/api/VERSION/authorities/{id}
URL with external_id:
https://BASE_URL/api/VERSION/authorities/reference/{id}
Method: DELETE
Parameters:
Name | Description | Type | Required | Example values |
---|
id | The ID of the desired authority | Long/String | yes | 123 |
The name of authority can be used as an external ID
Success Output
Success case: response.status = 200
{
"success": "true",
"success_description": "Instance deleted successfully"
}
Failure Output
Failure case:response.status = 400
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The authority with the id 706 doesn't exist."
}