Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /reference_data/map_of_sets/{name}

Return the reference map of sets identified by name.

Return the reference map of sets 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/map_of_sets/{name} Resource Details

MIME Type

application/json

Table 2: GET /reference_data/map_of_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 map of sets 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.

Table 3: GET /reference_data/map_of_sets/{name} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The reference map of sets has been retrieved

404

1002

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

Response Description

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

Response Sample