Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

GET /reference_data/sets/{name}

SUMMARY Retrieve the reference set identified by name.

Retrieve the reference set identified by name. If provided, limit specifies the number of records to return starting at record specified by offset. If not specified, then the first 20 records will be returned.

Table 1: GET /reference_data/sets/{name} resource details:

GET /reference_data/sets/{name} resource details
MIME Type

application/json

Table 2: GET /reference_data/sets/{name} request parameter details:

GET /reference_data/sets/{name} request parameter details
Parameter Type Optionality Data Type MIME Type Description

name

path

Required

String

text/plain

Required - The name of the reference set to retrieve

namespace

query

Optional

String

text/plain

Either SHARED or TENANT, default is SHARED.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

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.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Table 3: GET /reference_data/sets/{name} response codes:

GET /reference_data/sets/{name} response codes
HTTP Response Code Unique Code Description

200

The reference set has been retrieved

404

1002

The reference set does not exist.

422

1005

A request parameter is not valid

422

1012

The namespace value of SHARED was expected

500

1020

An error occurred while attempting to retrieve the reference set

Response Description

The reference set identified by the name specified in the request. The portion of the set's data returned is dependent on the limit and offset specified in the request.

Response Sample