ON THIS PAGE
DELETE /reference_data/map_of_sets/{name}/{key}
SUMMARY Remove a value from a reference map of sets.
Remove a value from a reference map of sets.
MIME Type |
---|
application/json |
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 a value from |
namespace |
query |
Optional |
String |
text/plain |
- Either SHARED or TENANT, default is SHARED. |
key |
path |
Required |
String |
text/plain |
Required - The key of the value to remove |
value |
query |
Required |
String |
text/plain |
Required - The value to remove from the reference map of sets. 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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The reference map of sets has had a value removed |
|
404 |
1002 |
The reference map of sets does not exist |
404 |
1003 |
The record does not exist in the reference map of sets |
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 reference map of sets value |
Response Description
Information about the reference map of sets that had a value removed. This returns information about the reference map of sets but not the contained data.
Response Sample
{ "collection_id": 42, "creation_time": 42, "element_type": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>", "key_label": "String", "name": "String", "namespace": "String <one of: PRIVATE, SHARED, TENANT>", "number_of_elements": 42, "time_to_live": "String", "timeout_type": "String <one of: UNKNOWN, FIRST_SEEN, LAST_SEEN>", "value_label": "String" }