BEbenchling
Well Plate Schema

Get WellPlateSchema by ID

Get a single WellPlateSchema by ID.

get/api/v3/well-plate-schema/{well_plate_schema_id}

Request

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

Path parameters

well_plate_schema_idstring required

ID of the WellPlateSchema.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Headers

EARLY-ACCESSstring

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

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.