GET /reference_data_collections/sets/{id}

Get the meta data information for a specific set

Table 1. GET /reference_data_collections/sets/{id} resource details
MIME Type

application/json

Table 2. GET /reference_data_collections/sets/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

id

path

Required

Number (Integer)

text/plain

- The ID for the Set collection

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_collections/sets/{id} response codes
HTTP Response Code Unique Code Description

404

15000

The reference set does not exist.

500

110000

An unknown server error occurred.

Response Description

200 plus the Set Structure DTO

Response Sample


{
    "creation_time": 42,
    "delete_entries": true,
    "entry_type": "String <one of: ALN, ALNIC, NUM, IP, PORT, DATE>",
    "expired_log_option": "String <one of: LOG_NONE, LOG_EACH, LOG_BATCH>",
    "expiry_type": "String <one of: FIRST_SEEN, LAST_SEEN, NO_EXPIRY>",
    "global_id": "String",
    "id": 42,
    "name": "String",
    "namespace": "String <one of: PRIVATE, SHARED, TENANT>",
    "number_of_entries": 42,
    "tenant_id": 42,
    "time_to_live": 42
}