POST /reference_data/tables/{name}/description

Add or update description for a reference table.

Add or update description in a reference table.

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

Table 2. POST /reference_data/tables/{name}/description request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
name	path	Required	String	text/plain	Required - The name of the reference table
namespace	query	Optional	String	text/plain	Either SHARED or TENANT, default is SHARED.
description	query	Optional	String	text/plain	Required - Description of reference 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/{name}/description response codes
HTTP Response Code	Unique Code	Description
200		The reference map has description added or updated
404	1002	The reference map does not exist
422	1005	A request parameter is not valid
422	1021	Description value should be less than 2048 characters
500	1020	An error occurred while attempting to add description

Response Description

Information about the reference table

Response Sample


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