GET /reference_data_collections/sets

Get a list of set meta data information based on search criteria

Table 1. GET /reference_data_collections/sets resource details
MIME Type

application/json

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

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.

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

422

14000

Parameter was not valid

422

14001

An error occurred while building the filter

500

110000

An unknown server error occurred.

Response Description

200 plus a Collection of 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
    }
]