Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /reference_data/tables

 

Create a new reference table.

Create a new reference table.

Table 1: POST /reference_data/tables Resource Details

MIME Type

application/json

Table 2: POST /reference_data/tables Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

name

query

Required

String

text/plain

Required - The name of the reference table to create

element_type

query

Required

String

text/plain

Required - The default element type for the values allowed in the reference table. This is used when values are added or updated in the reference table who's inner key was not defined in the key_name_types parameter. 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.

outer_key_label

query

Optional

String

text/plain

Optional - The label to describe the outer keys

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"

key_name_types

query

Optional

Array<Object>

application/json

Optional - A JSON formatted string. This array creates the inner key names and corresponding value types for the table

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/tables Response Codes

HTTP Response Code

Unique Code

Description

201

 

A new reference table was successfully created

409

1004

The reference table 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 table

Response Description

Information about the newly created reference table.

Response Sample