BEbenchling
Matrix Plate

Get MatrixPlate by ID

Get a single MatrixPlate by ID.

get/api/v3/matrix-plate/{matrix_plate_id}

Request

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

Path parameters

matrix_plate_idstring required

ID of the MatrixPlate.

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 plate is archived

archivedboolean

Whether the plate is archived

availableCapacityinteger

The number of available positions in a matrix plate.

barcodestring nullable

Barcode of the plate

createdAtstring datetime

DateTime the plate was created

idstring

The ID of the plate.

modifiedAtstring datetime

DateTime the plate was last modified

namestring

Name of the plate; defaults to barcode if name is not provided

occupiedCapacityinteger

The number of containers currently in a matrix plate.

totalCapacityinteger

The total capacity of a matrix plate (i.e. how many containers it can store).

Changes

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