ON THIS PAGE
GET /reference_data/map_of_sets
SUMMARY Retrieve a list of all reference map of sets.
Retrieve a list of all reference map of sets.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
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. |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The reference map of sets list has been retrieved |
|
500 |
1020 |
An error occurred while attempting to retrieve all of the reference map of sets |
Response Description
A list of all of the reference map of sets. This returns information about the 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" } ]