review-batch

Pause, resume or cancel a review batch

Changed on
patch/workspaces/{workspaceSlug}/practices/review-batches/{batchId}/status

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/practices/review-batches/{batchId}/status
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

batchIdstring uuid required

Headers

If-Matchstring

Request body

status'AWAITING_CONFIRMATION' | 'RUNNING' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' required

Response

OK

budgetUsdstring nullable required
createdAtstring date-time required
estimatedCostUsdstring nullable required
estimatedItemsinteger required
etagstring required
failedCountinteger required
finishedAtstring date-time nullable required
fromstring date-time nullable required
idstring uuid required
itemKindstring required
origin'BACKFILL' | 'SCHEDULE' required
pauseReason'BUDGET_EXHAUSTED' | 'REVIEW_MODEL_UNBOUND' | 'WORKSPACE_UNAVAILABLE' | 'PAUSED_BY_ADMIN' | 'null' nullable required
reviewIdsstring[] required
scheduleIdstring uuid nullable required
skippedCountinteger required
startedAtstring date-time nullable required
status'AWAITING_CONFIRMATION' | 'RUNNING' | 'PAUSED' | 'COMPLETED' | 'CANCELLED' required
submittedCountinteger required
targetItemIdsstring required
tostring date-time nullable required
versionstring required

Changes