BatchItemResponse Class

Response from a single operation within a batch request.

Responses are returned in submission order. For operations added to a changeset, responses appear in the changeset's position in that order.

Example:


   for item in result.responses:
       if item.is_success:
           print(f"[OK] {item.status_code} entity_id={item.entity_id}")
       else:
           print(f"[ERR] {item.status_code}: {item.error_message}")

Constructor

BatchItemResponse(status_code: int, content_id: str | None = None, entity_id: str | None = None, data: Dict[str, Any] | None = None, error_message: str | None = None, error_code: str | None = None)

Parameters

Name Description
status_code
Required

HTTP status code for this operation (e.g. 204, 200, 400).
content_id

Content-ID value from the changeset response part, if any.

Default value: None
entity_id

GUID extracted from the OData-EntityId response header. Set for successful create (POST) operations.

Default value: None
data

Parsed JSON response body (e.g. for GET operations).

Default value: None
error_message

Error message when the operation failed.

Default value: None
error_code

Service error code when the operation failed.

Default value: None

Attributes

is_success

Return True when status_code is 2xx.

content_id 

content_id: str | None = None

data 

data: Dict[str, Any] | None = None

entity_id 

entity_id: str | None = None

error_code 

error_code: str | None = None

error_message 

error_message: str | None = None

status_code 

status_code: int