Study Schema

Set field definitions on a study schema

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.

post/api/v3/study-schema/{study_schema_id}:set-field-definitions

Request

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

Path parameters

study_schema_idstring required

ID of the StudySchema.

Headers

EARLY-ACCESSstring

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

Request body

Response

Task started

pollingUristring uri
taskIdstring

Changes

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