Update MatrixPlate

Beta

PATCH

https://{tenant_name}.benchling.com/api/v3/matrix-plate/:matrix_plate_id

PATCH

/api/v3/matrix-plate/:matrix_plate_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/matrix-plate/matrix_plate_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "__typename": "__typename",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "availableCapacity": 1,
  "barcode": "barcode",
  "createdAt": "createdAt",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "occupiedCapacity": 1,
  "parentStorage": {
    "__typename": "__typename",
    "id": "id"
  },
  "positions": [
    {
      "__typename": "__typename"
    }
  ],
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "totalCapacity": 1
}

Update MatrixPlate.

Authentication

AuthorizationBearer

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

Path parameters

matrix_plate_idstringRequired

ID of the MatrixPlate.

Request

This endpoint expects an object.

archiveReasonstringOptional

Why the plate is archived

archivedbooleanOptional

Whether the plate is archived

barcodestringOptional

Barcode of the plate

namestringOptional

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

parentStorageIdstring or nullOptional

projectIdstring or nullOptional

schemaFieldsmap from strings to objectsOptional

Response

__typenamestringOptional

creatorobjectOptional

The user who created the plate

schemaFieldslist of objects or nullOptional

archiveReasonstring or nullOptional

Why the plate is archived

archivedbooleanOptional

Whether the plate is archived

availableCapacityintegerOptional

The number of available positions in a matrix plate.

barcodestring or nullOptional

Barcode of the plate

createdAtstringOptional

DateTime the plate was created

idstringOptional

The ID of the plate.

modifiedAtstringOptional

DateTime the plate was last modified

namestringOptional

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

occupiedCapacityintegerOptional

The number of containers currently in a matrix plate.

parentStorageobject or nullOptional

Containing parent storage

positionslist of objectsOptional

The wells of the plate

projectobject or nullOptional

The project the plate is associated with

schemaobjectOptional

The schema of the plate

totalCapacityintegerOptional

The total capacity of a matrix plate (i.e. how many containers it can store).

Errors

400

Matrix Plate Update Request Bad Request Error

403

Matrix Plate Update Request Forbidden Error

404

Matrix Plate Update Request Not Found Error

409

Matrix Plate Update Request Conflict Error

429

Matrix Plate Update Request Too Many Requests Error

500

Matrix Plate Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors