Skip to navigation

Transfer PlateRecord content

Create destination plate record(s) by transferring content out of existing source plates. Each move is recorded as a destination_transfer on the child and a source_transfer on the source. The source plates are historical records and are never rewritten; instead the result also carries a copy of each source holding what remained after the transfer, which is empty when any drawn-from well could not say how much it had left.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
heightintegerRequired
Number of rows in each destination plate record.
namestringRequired

Base name for destination plate record(s). If multiple are created, numeric suffixes are appended.

transferobjectRequired

Transfer specification describing explicit operations or a layout-derived transfer.

widthintegerRequired
Number of columns in each destination plate record.
destinationBarcodeslist of stringsOptional

Optional barcode to stamp on each destination plate record, one entry per destination plate in destination-index order. Length must equal the number of destination plates.

metadataLayerslist of objectsOptional
Metadata layers to apply to each created destination plate record.
plateSchemaIdstringOptional
ID of the plate schema to apply to each destination plate record. If omitted, no plate schema is attached.

Response

OK
createdPlateslist of objectsOptional
The destination plate records created by the transfer.
decrementedSourcePlateslist of objectsOptional

Copies of the source plates the transfer drew from, holding what remained after it. The source plates themselves are historical records and are never rewritten. Empty when any drawn-from source well could not say how much it had left, since a partial list would read as the full set of what remains.

createdPlateIdslist of stringsOptionalDeprecated
Use createdPlates instead, and select the id subfield.

Errors

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