Sign in
Survey data

Changed on

Create a bulk processing job

Creates and starts a bulk processing job for one question across multiple submissions.

Supported actions:

  • automatic_google_transcription
  • automatic_google_translation

The request must include the target question_xpath, the submission root UUIDs to process, and deterministic params. params.language is required. For transcription, params.locale may also be supplied when a more specific Google Speech locale is needed.

auto_accept (boolean, optional, default false) controls review. When true, each generated transcript or translation is accepted immediately upon completion and needs no manual review.

Creation is atomic. If any selected submission is unknown, already has matching results, or already has an active matching bulk action, no job or child items are created.

The response is the created job. Its initial status is in_progress because creation immediately starts background processing.

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

Request

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

Path parameters

uid_assetstring required

UID of the parent asset

Request body

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

Automatically accept generated results upon completion.

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
skipped_uuidsstring[] required

Changes

  • v262d333d9cc44Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • v2f55f5ce273d3Revision changes
    • 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