POST /reference_data/maps/bulk_load/{namespace}/{name}/{domain_id}

Adds or updates data in a reference map.

Adds or updates data in a reference map.

Table 1. POST /reference_data/maps/bulk_load/{namespace}/{name}/{domain_id} resource details
MIME Type

application/json

Table 2. POST /reference_data/maps/bulk_load/{namespace}/{name}/{domain_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

namespace

path

Required

String

text/plain

Required - Either SHARED or TENANT.

name

path

Required

String

text/plain

Required - The name of map to add or update data in.

domain_id

path

Required

String

text/plain

Required - Specify the numeric domain_id tag for the data or SHARED for Admin users. Must be a domain ID for which the caller has access.

fields

header

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/bulk_load/{namespace}/{name}/{domain_id} request body details
Parameter Data Type MIME Type Description Sample

data

Array

application/json

Required - The JSON-formatted data to add or update in the reference map.

{"key1":"Data1", "key2":"Data2", "key3":"Data3", "key4":"Data4", "key5":"Data5", "key6":"Data6"}

Table 4. POST /reference_data/maps/bulk_load/{namespace}/{name}/{domain_id} response codes
HTTP Response Code Unique Code Description

200

Data was successfully added or updated in the reference map.

400

1001

An error occurred parsing the JSON-formatted message body.

404

1002

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

422

1015

The namespace parameter must be either SHARED or TENANT

500

1020

An error occurred during the attempt to add or update data in the reference map.

Response Description

Information about the reference map where data was added or updated. This returns information about the reference map but not the data that it contains.

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