DELETE /reference_data/sets/{name}

Removes a reference set or purges its contents.

Table 1. DELETE /reference_data/sets/{name} resource details
MIME Type
application/json

Table 2. DELETE /reference_data/sets/{name} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
name	path	Required	String	text/plain	Required - The name of the set to remove or purge.
namespace	query	Optional	String	text/plain	- Default is SHARED for admin users and TENANT for tenant users. If purge_only is "true", the default is SHARED for all users.
purge_only	query	Optional	String	text/plain	Optional - The allowed values are "false" or "true". The default value is false. Indicates if the reference set should have its contents purged (true), keeping the reference set structure. If the value is "false", or not specified the reference set is removed completely.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. DELETE /reference_data/sets/{name} response codes
HTTP Response Code	Unique Code	Description
202		The reference data set's deletion or purge request was accepted and is in progress.
404	1002	The reference set does not exist.
422	1005	A request parameter is not valid.
422	1012	The namespace value of SHARED was expected.
422	1015	The collection could not be deleted.
500	1020	An error occurred during the attempt to remove or purge values from the reference set.

Response Description

A status ID to retrieve the reference data set's deletion or purge status with at /api/system/task_management/tasks/{status_id}. You can also find the url in the Location header

Response Sample


{
    "completed": 42,
    "created": 42,
    "created_by": "String",
    "id": 42,
    "message": "String",
    "modified": 42,
    "name": "String",
    "started": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}