PRprolific
aiTaskBuilder

Get Schema Migration Status

Changed on

Returns the current status of a schema migration job, which reprocesses a V4 dataset's datapoints against a newer schema version.

A migration job has these statuses:

  • processing — the migration is underway.

Terminal statuses:

  • complete — all datapoints were reprocessed. reprocessed_count is populated.
  • partial — some datapoints were reprocessed and some fields could not be re-normalised (and were nulled). reprocessed_count, failed_count, and errors are populated.
  • failed — the migration failed entirely. reason is populated.

Continue polling while the status is processing.

get/api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/data-collection/datasets/{dataset_id}/schema-migrations/{job_id}
  • Auth
    API key in header Authorization

Path parameters

dataset_idstring uuid required

The unique identifier of the dataset

job_idstring uuid required

The schema migration job ID

Response

Schema migration job status

dataset_idstring uuid required

The dataset being migrated.

job_idstring uuid required

The unique identifier of the schema migration job.

schema_versioninteger required

The schema version this job reprocesses datapoints up to.

created_atstring date-time required

When the migration job was created (ISO 8601, UTC).

updated_atstring date-time required

When the migration job was last updated (ISO 8601, UTC).

status'processing' | 'complete' | 'partial' | 'failed' required

Current status of the migration job.

reprocessed_countinteger

Number of datapoints reprocessed. Present when status is complete or partial.

failed_countinteger

Number of datapoints with at least one field that could not be re-normalised. Present when status is partial.

reasonstring

Human-readable reason for failure. Present when status is failed.

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-schema-migration-status removed and replaced with aiTaskBuilder_GetSchemaMigrationStatus