DELETE /reference_data/tables/{name}/{outer_key}/{inner_key}

Remove a value from a reference table.

Remove a value from a reference table.

Table 1. DELETE /reference_data/tables/{name}/{outer_key}/{inner_key} resource details
MIME Type

application/json

Table 2. DELETE /reference_data/tables/{name}/{outer_key}/{inner_key} request parameter details
Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

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

outer_key

path

Required

String

text/plain

Required - The outer key of the value to remove

inner_key

path

Required

String

text/plain

Required - The inner key of the value to remove

value

query

Required

String

text/plain

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

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/tables/{name}/{outer_key}/{inner_key} response codes
HTTP Response Code Unique Code Description

200

The reference table had had a value removed

404

1002

The reference table does not exist

404

1003

The record does not exist in the reference table

422

1005

A request parameter is not valid

500

1020

An error occurred while attempting to remove the reference table value

Response Description

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

Response Sample


{
    "creation_time": 42,
    "element_type": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>",
    "key_label": "String",
    "key_name_types": {
        "String": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>"
    },
    "name": "String",
    "number_of_elements": 42,
    "time_to_live": "String",
    "timeout_type": "String <one of: UNKNOWN, FIRST_SEEN, LAST_SEEN>"
}