Delete Records
Delete Single Records
|
Method
|
DELETE
|
|
URL
|
/v2/<object_full_identifier>/<UUID>
|
|
Parameters
|
permanent_delete
|
|
Response Content Type
|
application/json
|
Input Example
DELETE https://<server>/v2/io_showcase/84a33b7e-833a-47da-95ed-8da49ee9eeb0
The following REST request body is ignored when sent:
{
"io_name" : "showcase new2" ,
"io_supported_languages" : null ,
"io_search_filter_language" : null ,
"io_showcase_number" : "233.3" ,
"io_release" : "759db0ad-ab90-441c-a7b7-8e2028b26edc" ,
"io_showcase_quantity" : "30 dd574d5a-c7bf-11e0-b724-001ec950a80f" ,
.
.
}
"io_name" : "showcase new2" ,
"io_supported_languages" : null ,
"io_search_filter_language" : null ,
"io_showcase_number" : "233.3" ,
"io_release" : "759db0ad-ab90-441c-a7b7-8e2028b26edc" ,
"io_showcase_quantity" : "30 dd574d5a-c7bf-11e0-b724-001ec950a80f" ,
.
.
}
Response
If successful, the response is Status Code 200.
|
Parameter
|
Description
|
Data Type
|
Example
|
|---|---|---|---|
|
permanent_delete
|
By default, the platform performs logical record deletion. Use this parameter to specify whether permanent (physical) deletion is required. Be aware that after permanent deletion, records cannot be undeleted.
If not specified, default logical deletion is performed, except for records that belong to objects configured with Physical Delete set to true.
|
Boolean
|
Delete the record permanently (physically):
DEL: /v2/<object_full_identifier>/<UUID>?permanent_delete=true
|
Delete Multiple Records
|
Method
|
DELETE
|
|
URL
|
/v2/<object_full_identifier>
|
|
Parameters
|
uuids, permanent_delete
|
|
Response Content Type
|
application/json
|
Max supports multiple-record deletion within a single DEL request. Invoke the DEL endpoint by using the uuids query string parameter to specify a comma-separated list of all the UUIDs of the records to be deleted.
DELETE https://<server_name>/v2/io_showcase?uuids=uuid1,uuid2,....,uuidn
The REST request is ignored when sent.
Response
If all specified records are successfully deleted, the response is Status Code 200.
 |
This request is transactional. If any record deletions fail, the full transaction is rolled back, and the corresponding error code and message are retrieved.
|
|
Parameter
|
Description
|
Data Type
|
Example
|
|---|---|---|---|
|
uuids
|
The UUIDs of the records to delete.
|
String of a list of comma-separated UUIDs of the records to delete.
|
To delete three records:
DEL: /v2/<object_full_identifier>?uuids=uuid1,uuid2,uuid3
|
|
permanent_delete
|
By default, the platform performs logical record deletion. Set this parameter to specify whether a permanent (physical) record deletion is required. Be aware that after permanent record deletion, it records cannot be undeleted.
If not specified, default logical deletion is performed, except for records that belong to objects with Physical Delete set to true.
|
boolean
|
To delete two records permanently (physically):
DEL: /v2/<object_full_identifier>?uuids=uuid1,uuid2&permanent_delete=true
|
Error Response Messages
|
HTTP Status Code
|
Error Type
|
Error Message
|
|---|---|---|
|
400
|
missing_parameter_error
|
The request did not contain a valid uuid to delete the record
|
|
400
|
invalid_parameter_error
|
The request did not provide a valid Record ID: <UUID>
|
|
400
|
operation_error
|
Error Deleting Records. Exception={...}
|
|
404
|
entity_not_found_error
|
Entity not found UUID: ...
|
|
500
|
server_error
|
Server error
|
Input Example
The following example shows how to delete two records of the Showcase object with UUIDs 42f64596-c42f-4ba2-8138-cc40188d2a88 and 41f19ff6-2738-4000-8bfd-a18950caa1d1:
https://<server_name>/v2/io_showcase?uuids=42f64596-c42f-4ba2-8138-cc40188d2a88,41f19ff6-2738-4000-8bfd-a18950caa1d1 (Method Delete)
For more information: