Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

DELETE /reference_data/map_of_sets/{name}

SUMMARY Removes a map of sets or purges its contents.

Removes a map of sets or purges its contents.

Table 1: DELETE /reference_data/map_of_sets/{name} resource details:

DELETE /reference_data/map_of_sets/{name} resource details

MIME Type

application/json

Table 2: DELETE /reference_data/map_of_sets/{name} request parameter details:

DELETE /reference_data/map_of_sets/{name} request parameter details

Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

Required - The name of the reference map of sets 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 map of sets should have its contents purged (true), keeping the reference map of sets structure. If the value is "false", or not specified the reference map of sets 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/map_of_sets/{name} response codes:

DELETE /reference_data/map_of_sets/{name} response codes

HTTP Response Code Unique Code Description

202

The reference data map of sets deletion or purge request was accepted and is in progress.

404

1002

The reference map of sets 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 map of sets.

Response Description

A status ID to retrieve the reference data map of sets 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