BEbenchling
Box Schema

Create BoxSchema

Create BoxSchema.

post/api/v3/box-schema

Request

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

Headers

EARLY-ACCESSstring

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

Request body

containerSchemaIdstring

The API ID of the container schema constraining what types of containers can be stored in boxes of this type.

descriptionstring required

A human-readable description of the schema. At most 1000 characters.

displayNamestring

Deprecated. Use name instead.

heightinteger required

The number of rows in the grid layout.

namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

prefixstring required

The prefix used for auto-generating barcodes for inventory items of this schema. Must be unique within the registry and cannot end in a digit.

systemNamestring

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.

widthinteger required

The number of columns in the grid layout.

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
descriptionstring

A description of the schema.

fieldDefinitionsstring uri
heightinteger nullable
idstring
modifiedAtstring datetime nullable
namestring
prefixstring nullable
systemNamestring

A unique, stable identifier for this schema used for programmatic access and integrations.

typestring nullable
widthinteger nullable

Changes

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