POST /reference_data/tables/{name}

date_range 24-May-22

arrow_backward

arrow_forward

SUMMARY Add or update an element in a reference table.

Add or update an element in a reference table. The value to be added must be of the appropriate type: either the type that corresponds to the innerKey predefined for the reference table, or the default elementType of the reference table

Table 1: POST /reference_data/tables/{name} resource details:
POST /reference_data/tables/{name} resource details
MIME Type
application/json

Table 2: POST /reference_data/tables/{name} request parameter details:
POST /reference_data/tables/{name} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
name	path	Required	String	text/plain	Required - The name of the reference table to add or update an element in
namespace	query	Optional	String	text/plain	- Either SHARED or TENANT, default is SHARED.
outer_key	query	Required	String	text/plain	Required - The outer key for the element to add or update
inner_key	query	Required	String	text/plain	Required - The inner key for the element to add or update
value	query	Required	String	text/plain	Required - The value to add or update in the reference table. Note: Date values must be represented in milliseconds since the Unix Epoch January 1st 1970.
source	query	Optional	String	text/plain	Optional - An indication of where the data originated. The default value is 'reference data api'
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 will be 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.

Table 3: POST /reference_data/tables/{name} response codes:
POST /reference_data/tables/{name} response codes
HTTP Response Code	Unique Code	Description
200		The reference table has had an element added or updated
404	1002	The reference table does not exist
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 add or update data in the reference table

Response Description

Information about the reference table that had an element added or updated. This returns information about the reference table but not the contained data.

Response Sample

content_copy zoom_out_map
{
    "collection_id": 42,
    "creation_time": 42,
    "element_type": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>",
    "key_label": "String",
    "key_name_types": {
        "String": "String <one of: ALN, NUM, IP, PORT, ALNIC, DATE>"
    },
    "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>"
}

arrow_backward PREVIOUS GET /reference_data/tables/{name}

NEXT arrow_forward GET /reference_data/tables/{name}/dependents

REST API Version 17.0 References

ON THIS PAGE

POST /reference_data/tables/{name}

Response Description

Response Sample

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry