Get Location by ID

GET

https://{tenant_name}.benchling.com/api/v3/location/:location_id

GET

/api/v3/location/:location_id

curl https://{tenant_name}.benchling.com/api/v3/location/location_id \
     -H "Authorization: Bearer <token>"

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

Get a single Location by ID.

Authentication

AuthorizationBearer

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

Path parameters

location_idstringRequired

ID of the Location.

Query parameters

returningstringOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstringOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

__typenamestringOptional

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

allowNonLocationChildrenbooleanOptional

Whether this location can store plates, boxes, and containers.

allowedInventorySchemaslist of objectsOptional

The plate, box, and container schemas that can be stored in this location. If allowsNonLocationChildren is true and this list is empty, all schemas are allowed.

archiveReasonstring or nullOptional

archivedbooleanOptional

availableCapacityinteger or nullOptional

The number of available positions in this location. Null if totalCapacity is not set.

barcodestring or nullOptional

createdAtstring or nullOptional

idstringOptional

modifiedAtstring or nullOptional

namestring or nullOptional

occupiedCapacityinteger or nullOptional

The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set.

parentStorageobject or nullOptional

schemaobject or nullOptional

totalCapacityinteger or nullOptional

The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.

validationStatusenumOptional

Whether this location is passing all validation checks.

Allowed values:

Errors

400

Location Get Request Bad Request Error

403

Location Get Request Forbidden Error

404

Location Get Request Not Found Error

429

Location Get Request Too Many Requests Error

500

Location Get Request Internal Server Error