Batches

Get batch status

Changed on

Get the current status and progress of a batch job.

Returns the batch identifier, workflow identifier, status, asset and execution counters (including execution IDs), timestamps, and hypermedia links to cancel or list executions.

get/batch/{batchId}/status

Request

  • Base URL: https://run-workflow.adobe.io
  • URL: https://run-workflow.adobe.io/batch/{batchId}/status
  • Auth: HTTP bearer and API key in header x-api-key

Path parameters

batchIdstring required

Batch identifier.

Headers

api-version'1.0'

Public API contract version for batch operations (/batch/…, GET /batches). The supported value is 1.0. If omitted, the service assumes 1.0. Unsupported values return 400 with status: "error".

x-gw-ims-org-idstring required

IMS organization ID for the authenticated caller. Scopes every request to that organization.

x-gw-ims-user-idstring required

IMS user ID for the authenticated caller.

Response

Success

batchIdstring required

Unique batch identifier.

workflowIdstring required

Identifier of the workflow run for this batch.

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

Current batch status.

createdAtstring date-time required

Batch creation timestamp.

updatedAtstring date-time required

Last update timestamp.

completedAtstring date-time nullable

Completion timestamp when the batch has finished, or null if still in progress.

Changes

  • db6f373f16f0Revision changes
    • breaking

      added the new required header request parameter x-gw-ims-org-id

    • breaking

      added the new required header request parameter x-gw-ims-user-id

    • info

      the endpoint scheme security BearerAuth AND ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      added the non-success response with the status

  • 995d308ddc56Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      api tag Batches added

    • info

      added the new optional header request parameter api-version

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property / to the response with the status