Update Box

PATCH

https://{tenant_name}.benchling.com/api/v3/box/:box_id

PATCH

/api/v3/box/:box_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/box/box_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",
  "emptyContainers": 1,
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "occupiedCapacity": 1,
  "parentStorage": {
    "__typename": "__typename",
    "id": "id"
  },
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "totalCapacity": 1
}

Update Box.

Authentication

AuthorizationBearer

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

Path parameters

box_idstringRequired

ID of the Box.

Request

This endpoint expects an object.

archiveReasonstringOptional

archivedbooleanOptional

barcodestringOptional

namestringOptional

parentStorageIdstring or nullOptional

projectIdstring or nullOptional

schemaFieldsmap from strings to objectsOptional

Response

__typenamestringOptional

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

availableCapacityintegerOptional

The number of available positions in the box.

barcodestring or nullOptional

createdAtstring or nullOptional

emptyContainersinteger or nullOptional

The number of containers in the box that have no contents.

idstringOptional

modifiedAtstring or nullOptional

namestring or nullOptional

occupiedCapacityintegerOptional

The number of containers currently in the box.

parentStorageobject or nullOptional

projectobject or nullOptional

schemaobject or nullOptional

totalCapacityintegerOptional

The total capacity of the box (i.e. how many containers it can store).

Errors

400

Box Update Request Bad Request Error

403

Box Update Request Forbidden Error

404

Box Update Request Not Found Error

409

Box Update Request Conflict Error

429

Box Update Request Too Many Requests Error

500

Box Update Request Internal Server Error