Container Schema

Set field definitions on a container schema

Changed on

Asynchronously set field definitions on a container schema. Requires permission to update settings on the schema's registry.

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. Parent links and numeric ranges are not supported. Configured schema field limits apply, and the request fails if the schema has more items than the configured limit for re-syncing item field values. If the container schema defines the wells of a well plate schema, the number of required fields is limited.

post/api/v3/container-schema/{container_schema_id}:set-field-definitions

Request

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

Path parameters

container_schema_idstring required

ID of the ContainerSchema.

Headers

EARLY-ACCESSstring

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

Request body

Response

Task started

pollingUristring uri
taskIdstring

Changes