Survey data

Update a bulk processing job

Cancels a single bulk processing job for an asset. This endpoint currently only supports cancellation.

Request body:

{
  "status": "cancelled"
}

Cancellation is idempotent. Cancelling an already-cancelled job returns the current cancelled job. Completed jobs cannot be cancelled.

When a job is cancelled, pending and in-progress child items are marked cancelled; terminal child items are not modified. The response is the updated job, including cancelled_by.

patch/api/v2/assets/{uid_asset}/advanced-features/bulk-actions/{action_uid}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

action_uidstring required

UID of the bulk action job

uid_assetstring required

UID of the parent asset

Request body

status'cancelled'
  • cancelled - cancelled

Response

uidstring required
status'pending' | 'in_progress' | 'complete' | 'cancelled' required
  • pending - pending
  • in_progress - in_progress
  • complete - complete
  • cancelled - cancelled
action_id'automatic_google_transcription' | 'automatic_google_translation' required
  • automatic_google_transcription - automatic_google_transcription
  • automatic_google_translation - automatic_google_translation
question_xpathstring required
submission_uuidsstring[] required
auto_acceptboolean required
progressinteger required
date_createdstring date-time required
date_modifiedstring date-time required

Changes

    • info

      added the required property to the response with the status

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • info

      removed from the response property allOf list for the response status