BEbenchling
Study Schema

Poll async task status

Poll the status of the "Set field definitions on a study schema" task.

Asynchronously set field definitions on a study schema. Requires administrator permission on the schema, Studies to be enabled, and updates to be allowed for the schema's study type.

Include every existing field, including archived fields, in the desired order. Provide a field ID to update an existing field; omit the ID to create a new field. Omitted update attributes retain their existing values. To archive a field, set archived to true and provide archiveReason. Omitting a field does not delete it and causes validation to fail. Configured schema field limits apply.

get/api/v3/tasks/study-schema/set-field-definitions/{task_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

task_idstring required

ID of the asynchronous task to poll.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

OK

messagestring required
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

Changes

No recorded changes to this operation across all 1 revision of this API.