Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /reference_data_collections/set_entries

SUMMARY Get a list of set entries which match a search criteria.

Table 1: GET /reference_data_collections/set_entries resource details:

GET /reference_data_collections/set_entries resource details

MIME Type

application/json

Table 2: GET /reference_data_collections/set_entries request parameter details:

GET /reference_data_collections/set_entries request parameter details

Parameter Type Optionality Data Type MIME Type Description

entry_type

query

Optional

String

text/plain

Optional - One of {ALN, ALNIC, IP, NUM, PORT, DATE}. Use this to only include entries of the passed type, so that filtering and sorting on the value field, if any, will be type aware. This filter is applied first, before any other.

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.

sort

query

Optional

String

text/plain

Optional - This parameter is used to sort the elements in a list.

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.

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.

Table 3: GET /reference_data_collections/set_entries response codes:

GET /reference_data_collections/set_entries response codes

HTTP Response Code Unique Code Description

422

24004

A filter on the value field contains an expression that cannot be converted to the requested entry type

422

24003

Unexpected value for the entry type parameter

422

24002

A parameter was not valid

422

24001

A filter criterion was not valid

500

110000

An unspecified error occurred

Response Description

200 plus a Collection of Set Entry Structure DTO

Response Sample