Contents

BulkResponse

The generic response envelope returned by all bulk operations.

Declaration

object BulkResponse

Properties

NameTypeDescription
resultResponse.Result

BulkResponse inherits result as a generic nullable object from the Response base schema. The array-of-items typing (for example, array of BulkItemResultKeyword) is defined by typed response subclasses such as KeywordCreateBulkResponse, not by BulkResponse itself. Each entry contains the operation outcome and, on failure, per-item error details. Read-only.

errorError

Top-level error if the entire bulk request was rejected before processing. null when the request was accepted (even with per-item failures). See Error. Read-only.

Discussion

The BulkResponse object is the standard response wrapper for bulk create, update, and delete operations. The result array is parallel to the items array in the corresponding BulkOperationRequest: element at index n in result corresponds to element at index n in the request. To correlate results back to their originating request item, use the correlationId field on each result entry.

When allowPartialSuccess is true in the request, individual item failures appear in the result array rather than the top-level error.

Example

{
  "result": [
    {
      "correlationId": 0,
      "operation": "CREATE",
      "success": true
    }
  ]
}

See Also