PATCH /reference_data_collections/set_entries

Perform asynchronous bulk update - series of add and updates

Table 1. PATCH /reference_data_collections/set_entries resource details
MIME Type

application/json

Table 2. PATCH /reference_data_collections/set_entries request parameter details
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.

Table 3. PATCH /reference_data_collections/set_entries request body details
Parameter Data Type MIME Type Description Sample

body

Array<Object>

application/json

- the collection of set entries comprising the updates

[ { "collection_id": 42, "delete_entry": true, "domain_id": 42, "first_seen": 42, "id": 42, "last_seen": 42, "notes": "String", "source": "String", "value": "String" } ]

Table 4. PATCH /reference_data_collections/set_entries response codes
HTTP Response Code Unique Code Description

202

The bulk update task has been created

403

23004

The operation was not allowed

404

23003

The resource specified was not found

422

23000

The collection id was not found

422

23002

A parameter is invalid

422

23005

An invalid domain ID was specified

500

110000

Some unspecified error occurred

Response Description

202 and the task status for this Bulk Update request

Response Sample


{
    "completed": 42,
    "created": 42,
    "created_by": "String",
    "error_code": 42,
    "error_message": "String",
    "id": 42,
    "modified": 42,
    "name": "String",
    "started": 42,
    "status": "String <one of: CANCELLED, CANCELING, CANCEL_REQUESTED, COMPLETED, CONFLICT, EXCEPTION, INITIALIZING, INTERRUPTED, PAUSED, PROCESSING, QUEUED, RESUMING>"
}