GET /reference_data/maps/{name}

Retrieve the reference map identified by name.

Retrieve the reference map identified by name. If provided, limit specifies the number of records to return starting at record specified by offset. If not specified, then the first 20 records will be returned.

Table 1. GET /reference_data/maps/{name} resource details
MIME Type
application/json

Table 2. GET /reference_data/maps/{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 to retrieve
namespace	query	Optional	String	text/plain	Either SHARED or TENANT, default is SHARED.
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.
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.

Table 3. GET /reference_data/maps/{name} response codes
HTTP Response Code	Unique Code	Description
200		The reference map has been retrieved
404	1002	The reference map does not exist
422	1005	A request parameter is not valid
422	1012	The namespace value of SHARED was expected
500	1020	An error occurred while attempting to retrieve the reference map

Response Description

The reference map identified by the name specified in the request. The portion of the reference map's data returned is dependent on the limit and offset specified in the request.

Response Sample


{
    "collection_id": 42,
    "creation_time": 42,
    "data": {
        "String": {
            "domain_id": 42,
            "first_seen": 42,
            "last_seen": 42,
            "source": "String",
            "value": "String"
        }
    },
    "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"
}