POST /reference_data_collections/sets
Create a set given the properties based in the body DTO
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
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. |
Parameter | Data Type | MIME Type | Description | Sample |
---|---|---|---|---|
body |
Object |
application/json |
- The Set DTO specifying the new Set properties. Both name and entry_type are required. Namespace, tenantid, expiry_type, time_to_live and expired_log_option are optional fields. All other fields will be ignored. |
{ "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 } |
HTTP Response Code | Unique Code | Description |
---|---|---|
409 |
10006 |
A collection with the same name already exists |
422 |
10001 |
The entry_type field was not specified. |
422 |
10002 |
The name field was not specified |
422 |
10003 |
The TENANT namespace was specified but a valid tenant ID is required |
422 |
10004 |
SHARED or PRIVATE namespace does not permit tenant_id to be specified |
422 |
10005 |
The user does not have permission to create a collection in the provided namespace |
422 |
10007 |
An invalid time_to_live value was specified |
500 |
110000 |
An unspecified server error occurred |
Response Description
201 and the newly created Set 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
}