Skip to content

BatchItemError

HTTP API schema

← HTTP API reference

Error for one operation of an atomic batch, correlated by the operation's `requestId`. `status` is the HTTP status the operation would have returned on its own.

BatchItemError fields

requestIdBatchOperationRequestIdRequired

requestId: Reference BatchOperationRequestId

codeErrorCodeRequired

code: Reference ErrorCode

familyErrorFamilyRequired

family: Reference ErrorFamily

statusintegerRequired

HTTP-equivalent status code of the item failure.

minimum: 400

maximum: 599

messagestringRequired

Plain-language description of the failure and the suggested next action.

resourceIdstring

The resource the failure applies to, when it is not the operation's primary target.

View source specification ↗