BEbenchling
Matrix Plate

Update MatrixPlate

Changed on

Update MatrixPlate.

patch/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.

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.

barcodestring

Barcode of the plate

namestring

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

parentStorageIdstring nullable
projectIdstring nullable
schemaFieldsobject
shouldRemoveBarcodesboolean

Whether to remove the barcodes of the plate and of every tube archived with it. Only allowed when archiving the plate, and can't be combined with barcode.

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

  • 3873a10bf7b8Revision changes
    • breaking

      added subschema #1 subschema #8 subschema #9 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #8 subschema #9 from the /// response property oneOf list for the response status