Skip to navigation

Create PlateRecord

Create one or more PlateRecords. Three creation modes are supported:

From scratch: Provide name, height, width, and any layer fields (wells, concentrationLayers, metadataLayers, etc.).

From a design template: Provide plateDesignTemplateId to clone a plate design. height and width default to the design’s dimensions. Omitting a layer field preserves the design’s layer; supplying an explicit empty list removes it.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired
barcodestringOptional
Barcode to record as a plate field in the metadata layer.
concentrationLayerslist of objectsOptional
contentslist of objectsOptional
heightintegerOptional
measurementslist of objectsOptional
metadataLayerslist of objectsOptional
originDesignIdstringOptional
parameterLayerslist of objectsOptional
plateDesignTemplateIdstringOptional
plateReaderAsmobjectOptional
plateSchemaIdstringOptional
roleLayerslist of objectsOptional

Additional, user-named well-role layers, separate from the default role assignment given by wells. At most 15 layers per plate.

storageIdstringOptional
Inventory storage ID to record as a plate field in the metadata layer.
vendorFileobjectOptional
wellslist of objectsOptional
widthintegerOptional

Response

Created
__typenamestringOptional
barcodestring or nullOptional
The plate's barcode, when one has been recorded.
createdAtstring or nullOptionalformat: "datetime"
heightintegerOptional
idstringOptional
isHiddenbooleanOptional
Whether the plate record is hidden from the plate's sidebar list.
layerslist of objectsOptional
modifiedAtstring or nullOptionalformat: "datetime"
namestringOptional
plateSchemaobject or nullOptional

The plate schema associated with this plate record. Used as the default schema when converting to an inventory plate via bulk-put-in-inventory; can be overridden per-item in that call.

storageIdstring or nullOptional
The plate's storage location identifier, when one has been recorded.
widthintegerOptional

Errors

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