DELETE /reference_data_collections/sets/{id}

Delete a set by starting an asynchronous task

Table 1. DELETE /reference_data_collections/sets/{id} resource details
MIME Type

application/json

Table 2. DELETE /reference_data_collections/sets/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

- The ID for the Set collection

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_collections/sets/{id} response codes
HTTP Response Code Unique Code Description

403

12001

The operation is not allowed.

404

12000

The reference set does not exist.

404

12002

The Delete task does not exist.

500

110000

An unknown server error occurred.

Response Description

202 and the task status for this Delete Set request

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>"
}