POST /reference_data/maps

Create a new reference map.

Table 1. POST /reference_data/maps resource details
MIME Type
application/json

Table 2. POST /reference_data/maps request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
name	query	Required	String	text/plain	Required - The name of the reference map to create
key_label	query	Optional	String	text/plain	Optional - The label to describe the keys
value_label	query	Optional	String	text/plain	Optional - The label to describe the data values
element_type	query	Required	String	text/plain	Required - The element type for the values allowed in the reference map. The allowed values are: ALN (alphanumeric), ALNIC (alphanumeric ignore case), IP (IP address), NUM (numeric), PORT (port number) or DATE. Note that date values need to be represented in milliseconds since the Unix Epoch January 1st 1970.
timeout_type	query	Optional	String	text/plain	Optional - The allowed values are "FIRST_SEEN", "LAST_SEEN" and "UNKNOWN". The default value is "UNKNOWN". This indicates if the time_to_live interval is based on when the data was first seen or last seen.
time_to_live	query	Optional	String	text/plain	Optional - The time to live interval, for example: "1 month" or "5 minutes"
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. POST /reference_data/maps response codes
HTTP Response Code	Unique Code	Description
201		A new reference map was successfully created
409	1004	The reference map could not be created, the name provided is already in use. Please change the name and try again.
422	1005	A request parameter is not valid
500	1020	An error occurred while attempting to create the reference map

Response Description

Information about the newly created reference map.

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"
}