Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /reference_data_collections/sets/{id}

SUMMARY Update a Set given the properties based in the body DTO

Table 1: POST /reference_data_collections/sets/{id} resource details:

POST /reference_data_collections/sets/{id} resource details

MIME Type

application/json

Table 2: POST /reference_data_collections/sets/{id} request parameter details:

POST /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

header

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: POST /reference_data_collections/sets/{id} request body details:

POST /reference_data_collections/sets/{id} request body details

Parameter Data Type MIME Type Description Sample

body

Object

application/json

The Set DTO specifying the updated Set properties that can be updated include expiry_type, time_to_live and expired_log_option. All other fields will be ignored. Also, optionally, the delete_entries field can be provided to empty the Set of all entries.

{ "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 }

Table 4: POST /reference_data_collections/sets/{id} response codes:

POST /reference_data_collections/sets/{id} response codes

HTTP Response Code Unique Code Description

404

11001

Indicates the Set with the specified ID does not exist

422

11002

The body parameter is missing from the request

422

11003

An invalid time_to_live value was specified

422

11004

The resulting time_to_live and expiry_type combination is not valid

500

110000

Unexpected internal server error

Response Description

200 and the updated Set DTO

Response Sample