get a container by id

GET

https://{tenant_name}.benchling.com/api/v2/containers/:container_id

GET

/api/v2/containers/:container_id

curl https://{tenant_name}.benchling.com/api/v2/containers/container_id \
     -H "Authorization: Bearer <token>"

{
  "archiveRecord": {
    "reason": "Made in error"
  },
  "barcode": "string",
  "checkoutRecord": {
    "assignee": {
      "handle": "string",
      "id": "string",
      "name": "string"
    },
    "comment": "string",
    "modifiedAt": "2024-01-15T09:30:00Z",
    "status": "AVAILABLE"
  },
  "contents": [
    {
      "batch": {
        "archiveRecord": {
          "reason": "Made in error"
        },
        "createdAt": "2024-01-15T09:30:00Z",
        "creator": {
          "handle": "string",
          "id": "string",
          "name": "string"
        },
        "defaultConcentration": {
          "units": "string",
          "value": 1.1
        },
        "entity": {
          "entityType": "dna_sequence",
          "id": "seq_ObbdtGhC",
          "type": "string"
        },
        "fields": {},
        "id": "bat_UOIr8IjL",
        "modifiedAt": "2024-01-15T09:30:00Z",
        "name": "string",
        "schema": {
          "id": "string",
          "name": "string"
        },
        "webURL": "string"
      },
      "concentration": {
        "units": "string",
        "value": 1.1
      },
      "entity": {
        "aliases": [
          "string"
        ],
        "annotations": [
          {
            "color": "#F58A5E",
            "customFields": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "end": 1,
            "name": "string",
            "notes": "Cong et al Science. 2013 Jan 3.",
            "start": 1,
            "strand": 1,
            "type": "string"
          }
        ],
        "apiURL": "https://benchling.com/api/v2/dna-sequences/seq_asQya4lk",
        "archiveRecord": {
          "reason": "Made in error"
        },
        "authors": [
          {
            "handle": "string",
            "id": "string",
            "name": "string"
          }
        ],
        "bases": "string",
        "createdAt": "2024-01-15T09:30:00Z",
        "creator": {
          "handle": "string",
          "id": "string",
          "name": "string"
        },
        "customFields": {
          "Legacy ID": {
            "value": "STR100"
          }
        },
        "dnaAlignmentIds": [
          "string"
        ],
        "entityRegistryId": "string",
        "entityType": "dna_sequence",
        "fields": {},
        "folderId": "string",
        "id": "string",
        "isCircular": true,
        "length": 1,
        "modifiedAt": "2024-01-15T09:30:00Z",
        "name": "string",
        "parts": [
          {
            "end": 1,
            "sequenceId": "seq_VfVOART1",
            "start": 1,
            "strand": 1
          }
        ],
        "primers": [
          {
            "bases": "string",
            "bindPosition": 1,
            "color": "string",
            "end": 1,
            "name": "string",
            "oligoId": "string",
            "overhangLength": 1,
            "start": 1,
            "strand": 1
          }
        ],
        "registrationOrigin": {
          "originEntryId": "string",
          "registeredAt": "2024-01-15T09:30:00Z"
        },
        "registryId": "string",
        "schema": {
          "id": "string",
          "name": "string"
        },
        "transcriptions": [
          {
            "end": 1,
            "sequenceId": "seq_VfVOART1",
            "start": 1,
            "strand": 1
          }
        ],
        "translations": [
          {
            "aminoAcids": "string",
            "coerceStartCodonToMethionine": false,
            "color": "#F58A5E",
            "customFields": [
              {
                "name": "string",
                "value": "string"
              }
            ],
            "end": 1,
            "geneticCode": "STANDARD",
            "name": "string",
            "notes": "Cong et al Science. 2013 Jan 3.",
            "regions": [
              {
                "end": 1,
                "start": 1
              }
            ],
            "start": 1,
            "strand": 1
          }
        ],
        "url": "string",
        "webURL": "string"
      }
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "creator": {
    "handle": "string",
    "id": "string",
    "name": "string"
  },
  "fields": {},
  "id": "con_ZBL9QQWD",
  "modifiedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "parentStorageId": "string",
  "parentStorageSchema": {
    "id": "string",
    "name": "string"
  },
  "projectId": "string",
  "quantity": {
    "units": "mL",
    "value": 10
  },
  "restrictedSampleParties": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "restrictionStatus": "RESTRICTED",
  "role": {
    "group": 1,
    "primaryRole": "SAMPLE",
    "subrole": "string"
  },
  "sampleOwners": [
    {
      "handle": "string",
      "id": "string",
      "name": "string"
    }
  ],
  "schema": {
    "id": "string",
    "name": "string"
  },
  "volume": {
    "units": "mL",
    "value": 10
  },
  "webURL": "string"
}

get a container by id

Authentication

AuthorizationBearer

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

Path parameters

container_idstringRequired

Query parameters

returningstringOptional

Comma-separated list of fields to return. Modifies the output shape. To return all keys at a given level, enumerate them or use the wildcard, ’*’. For more information, click here.

Response

archiveRecordobject or nullOptional

barcodestring or nullOptional

checkoutRecordobjectOptional

assignee field is set if status is “RESERVED” or “CHECKED_OUT”, or null if status is “AVAILABLE”.

comment field is set when container was last reserved, checked out, or checked into.

modifiedAt field is the date and time when container was last checked out, checked in, or reserved

contentslist of objectsOptionalRead-only

createdAtdatetimeOptionalRead-only

creatorobjectOptional

fieldsmap from strings to objectsOptional

idstringOptionalRead-only

modifiedAtdatetimeOptionalRead-only

namestringOptional

parentStorageIdstring or nullOptional

parentStorageSchemaobject or nullOptional

projectIdstring or nullOptional

quantityobjectOptional

Quantity of a container, well, or transfer. Supports mass, volume, and other quantities.

restrictedSamplePartieslist of objectsOptional

restrictionStatusenumOptional

Allowed values:

roleobject or nullOptional

sampleOwnerslist of objectsOptional

schemaobject or nullOptional

volumeobjectOptional

The deprecated “volume” type key in API responses can also contain non-volume quantities for back-compatibility purposes. Use the “quantity” type key instead.

webURLstringOptionalRead-only

Errors

400

Bad Request Error

404

Not Found Error