POST /reference_data_collections/set_entries
Create an entry within a set
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 Entry DTO specifying the new Set properties |
{ "collection_id": 42, "delete_entry": true, "domain_id": 42, "first_seen": 42, "id": 42, "last_seen": 42, "notes": "String", "source": "String", "value": "String" } |
HTTP Response Code | Unique Code | Description |
---|---|---|
422 |
20001 |
The entry body parameter was not specified |
422 |
20002 |
The Set ID was not specified in the body parameter |
422 |
20003 |
The value was not specified |
422 |
20004 |
A Set with the specified ID was not found |
422 |
20005 |
An invalid domain ID was specified |
422 |
20006 |
The provided value does not match the collection entry type |
422 |
20007 |
The value field exceeded the allowed limit. |
422 |
20008 |
The notes field exceeded the allowed limit |
500 |
110000 |
An unspecified server error occurred |
Response Description
201 and the newly created Set Entry DTO. 200 if the entry was updated.
Response Sample
{
"collection_id": 42,
"delete_entry": true,
"domain_id": 42,
"first_seen": 42,
"id": 42,
"last_seen": 42,
"notes": "String",
"source": "String",
"value": "String"
}