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/sets/{name}/{value}

SUMMARY Remove a value from a reference set.

Remove a value from a reference set.

Table 1: DELETE /reference_data/sets/{name}/{value} resource details:

DELETE /reference_data/sets/{name}/{value} resource details
MIME Type

application/json

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

DELETE /reference_data/sets/{name}/{value} request parameter details
Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

Required - The name of the reference set to remove a value from

namespace

query

Optional

String

text/plain

- Either SHARED or TENANT, default is SHARED.

value

path

Required

String

text/plain

Required - The value to remove from the reference set. Note: Date values must be represented in milliseconds since the Unix Epoch January 1st 1970.

domain_id

query

Optional

Number (Integer)

text/plain

Optional - This allows the domain id for the value to be specified. If null, the shared domain is used.

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}/{value} response codes:

DELETE /reference_data/sets/{name}/{value} response codes
HTTP Response Code Unique Code Description

200

The reference set that had a value removed

404

1002

The reference set does not exist

404

1003

The record does not exist in the reference set

404

1011

Domain not found

422

1005

A request parameter is not valid

422

1012

The namespace value of SHARED was expected

422

1014

The domain_id parameter must be specified

500

1020

An error occurred while attempting to remove the value from the reference set.

Response Description

Information about the reference set that had an value removed. This returns information about the reference set but not the contained data.

Response Sample