BEbenchling
Matrix Plate Schema

Update MatrixPlateSchema

Update MatrixPlateSchema.

patch/api/v3/matrix-plate-schema/{matrix_plate_schema_id}

Request

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

Path parameters

matrix_plate_schema_idstring required

ID of the MatrixPlateSchema.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

containerSchemaIdstring nullable

The API ID of the container schema constraining what types of containers can be inserted into plates of this type.

descriptionstring

Updated description. When provided, must be at most 1000 characters.

displayNamestring

Deprecated. Use name instead.

heightinteger

The number of rows in the grid layout.

namestring

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

prefixstring

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

Updated SQL identifier for the warehouse table name. When provided, 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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

widthinteger

The number of columns in the grid layout.

Response

OK

__typenamestring
archiveReasonstring nullable

Why the schema was archived.

archivedboolean

Whether the schema is archived.

createdAtstring datetime

When the schema was created.

descriptionstring

A description of the schema.

fieldDefinitionsstring uri

The fields inherited by plates of this schema.

heightinteger

The number of rows in plates of this schema.

idstring

The ID of the schema.

modifiedAtstring datetime

When the schema was last modified.

namestring

The name of the schema.

prefixstring

The prefix of barcodes autogenerated for plates of this schema.

systemNamestring

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

widthinteger

The number of columns in plates of this schema.

Changes

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