Docs

Bulk operations API reference

Complete reference documentation for the Bulk operations resource.

Bulk operations

A Bulk Operation is a set of changes applied across 0 or more records triggered via a call to the Knock API and performed asynchronously. The BulkOperation record represents the state of the operation, including recording the number of rows that have been modified during the operation.

Please note here: the estimated_total_rows field may have a different value to the processed_rows field due to the asynchronous nature of the operation.

Endpoints

GET/v1/bulk_operations/{id}

Get bulk operation

Retrieves a bulk operation (if it exists) and displays the current state of it.

Endpoint

GET/v1/bulk_operations/{id}

Tier 4

Path parameters

string(uuid)

The ID of the bulk operation to retrieve.

Returns

BulkOperation

A bulk operation entity.

__typename

string

The typename of the schema.

completed_at

string(date-time)

Timestamp when the bulk operation was completed.

error_count

integer

The number of failed operations.

error_items

object[]

A list of items that failed to be processed.

collection

string

The collection this object belongs to.

string

Required

Unique identifier for the object.

estimated_total_rows

integer

The estimated total number of rows to process.

failed_at

string(date-time)

Timestamp when the bulk operation failed.

string(uuid)

Unique identifier for the bulk operation.

inserted_at

string(date-time)

Timestamp when the resource was created.

name

string

The name of the bulk operation.

processed_rows

integer

The number of rows processed so far.

progress_path

string(uri)

The URI to the bulk operation's progress.

started_at

string(date-time)

Timestamp when the bulk operation was started.

status

enum(string)

The status of the bulk operation.

queuedprocessingcompletedfailed

success_count

integer

The number of successful operations.

updated_at

string(date-time)

The timestamp when the resource was last updated.

BulkOperation

A bulk operation entity.

Attributes

__typename

string

The typename of the schema.

completed_at

string(date-time)

Timestamp when the bulk operation was completed.

error_count

integer

The number of failed operations.

error_items

object[]

A list of items that failed to be processed.

collection

string

The collection this object belongs to.

string

Required

Unique identifier for the object.

estimated_total_rows

integer

The estimated total number of rows to process.

failed_at

string(date-time)

Timestamp when the bulk operation failed.

string(uuid)

Unique identifier for the bulk operation.

inserted_at

string(date-time)

Timestamp when the resource was created.

name

string

The name of the bulk operation.

processed_rows

integer

The number of rows processed so far.

progress_path

string(uri)

The URI to the bulk operation's progress.

started_at

string(date-time)

Timestamp when the bulk operation was started.

status

enum(string)

The status of the bulk operation.

queuedprocessingcompletedfailed

success_count

integer

The number of successful operations.

updated_at

string(date-time)

The timestamp when the resource was last updated.