Skip to navigation
Benchling APIMatrix Plate Schema

Create MatrixPlateSchema

Beta
Create MatrixPlateSchema.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
descriptionstringRequired

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

heightintegerRequired
The number of rows in the grid layout.
organizationIdstringRequired
The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.
prefixstringRequired

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.

widthintegerRequired
The number of columns in the grid layout.
containerSchemaIdstringOptional
The API ID of the container schema constraining what types of containers can be inserted into plates of this type.
fieldDefinitionslist of objectsOptional
The fields inherited by plates of this schema.
namestringOptional

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

systemNamestringOptional

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.

displayNamestringOptionalDeprecated
Deprecated. Use name instead.

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
Why the schema was archived.
archivedbooleanOptional
Whether the schema is archived.
containerSchemaobject or nullOptional
The container schema used for positions in plates of this schema.
createdAtstringOptional
When the schema was created.
descriptionstringOptional
A description of the schema.
fieldDefinitionsstringOptionalformat: "uri"
The fields inherited by plates of this schema.
heightintegerOptional
The number of rows in plates of this schema.
idstringOptional
The ID of the schema.
modifiedAtstringOptional
When the schema was last modified.
namestringOptional
The name of the schema.
prefixstringOptional
The prefix of barcodes autogenerated for plates of this schema.
registryobjectOptional
The schema's registry.
systemNamestringOptional
A unique, stable identifier for this schema used for programmatic access and integrations.
widthintegerOptional
The number of columns in plates of this schema.

Errors

400
Matrix Plate Schema Create Request Bad Request Error
403
Matrix Plate Schema Create Request Forbidden Error
404
Matrix Plate Schema Create Request Not Found Error
409
Matrix Plate Schema Create Request Conflict Error
429
Matrix Plate Schema Create Request Too Many Requests Error
500
Matrix Plate Schema Create Request Internal Server Error