Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /reference_data/maps/{name}

Add or update an element in a reference map.

Add or update an element in a reference map.

Table 1: POST /reference_data/maps/{name} Resource Details

MIME Type

application/json

Table 2: POST /reference_data/maps/{name} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

name

path

Required

String

text/plain

Required - The name of the reference map to add or update an element in

namespace

query

Optional

String

text/plain

- Either SHARED or TENANT, default is SHARED.

key

query

Required

String

text/plain

Required - The key who's value we want to add or update

value

query

Required

String

text/plain

Required - The value to add or update in the reference map. 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 is 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/maps/{name} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The reference map has had an element added or updated

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

500

1020

An error occurred while attempting to add or update data in the reference map

Response Description

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

Response Sample