Plate Record

Put PlateRecords in inventory

Create a WellPlate object from each PlateRecord, populating wells from the plate record's label and content layers and any column mappings. Each item targets a plate schema (explicit or inherited from the plate record), an inventory location, and an optional project. The new plates are added to inventory and the original plate records are left unchanged.

The scratch file must be a JSONL file where each line is a JSON object with the following structure:

{"request_id": "unique-id-per-row", "input_object": {}}

The input_object fields (all camelCase) are:

  • plateRecordId (required): ID of the plate record to convert.
  • plateSchemaId: ID of the plate schema for the new inventory plate. If omitted, resolved from the plate record's own plateSchemaId; fails if neither is set.
  • name: Name for the new inventory plate. Defaults to the plate record's name.
  • barcode: Barcode assignment. Either {"barcodeMode": "USE_NAME", "useNameAsBarcode": true} or {"barcodeMode": "SPECIFY_BARCODE", "barcode": "barcode-value"}.
  • sourceId: API ID of the source entity to associate with the new plate.
  • parentStorableId: API ID of the storage location to place the new plate into.
  • columnMappings: List of {layerName, columnName, schemaFieldName} objects mapping plate record layer columns onto container-schema fields.
  • studyIds: List of study IDs to associate with the new plate.
post/api/v3/plate-record:bulk-put-in-inventory

Request

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

Request body

fileIdstring required

The API ID of the scratch file (scrfile_XXXXXXXX) containing the items to import. The referenced file must be a scratch file whose upload has completed successfully.

Response

Task started

pollingUristring uri
taskIdstring

Changes

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