Skip to navigation

Create WellPlate

Beta
Create WellPlate.

Authentication

AuthorizationBearer

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

Headers

EARLY-ACCESSstringOptional

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

Request

This endpoint expects an object.
schemaIdstringRequired
barcodestringOptional
Barcode of the plate
namestringOptional

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

parentStorageIdstringOptional
projectIdstringOptional
schemaFieldsmap from strings to objectsOptional
Schema field values that belong to the plate

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
Why the plate is archived
archivedbooleanOptional
Whether the plate is archived
barcodestring or nullOptional
Barcode of the plate
createdAtstringOptionalformat: "datetime"
DateTime the plate was created
idstringOptional
ID of the plate
modifiedAtstringOptionalformat: "datetime"
DateTime the plate was last modified
namestringOptional

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

parentStorageobject or nullOptional
Containing parent storage
projectobject or nullOptional
The project the plate is associated with
schemaobjectOptional
The schema of the plate
creatorobjectOptional
The user who created the plate
positionsstringOptionalformat: "uri"
The wells of the plate
schemaFieldslist of objects or nullOptional
Schema field values that belong to the plate

Errors

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