Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

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

SUMMARY Add or update data in a reference set.

Add or update data in a reference set.

Table 1: POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} resource details:

POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} resource details

MIME Type

application/json

Table 2: POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} request parameter details:

POST /reference_data/sets/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 set 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/sets/bulk_load/{namespace}/{name}/{domain_id} request body details:

POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} request body details

Parameter Data Type MIME Type Description Sample

data

Array

application/json

Required - The JSON formated data to add or update in the reference set

["String", "String", "String", "String", "String", "String", "String", "String", "String", "String", "String"]

Table 4: POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} response codes:

POST /reference_data/sets/bulk_load/{namespace}/{name}/{domain_id} response codes

HTTP Response Code Unique Code Description

200

The reference set has had data added or updated

400

1001

An error occurred parsing the JSON formatted message body

404

1002

The reference set 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 while attempting to add or update data in the reference set

Response Description

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

Response Sample