Get WellPlatePosition by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/well-plate-position/:well_plate_position_id

GET

/api/v3/well-plate-position/:well_plate_position_id

curl https://{tenant_name}.benchling.com/api/v3/well-plate-position/well_plate_position_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "contents": [
    {
      "__typename": "__typename",
      "createdAt": "createdAt",
      "modifiedAt": "modifiedAt"
    }
  ],
  "coordinates": {
    "__typename": "__typename",
    "column": 1,
    "index": 1,
    "position": "position",
    "row": 1
  },
  "createdAt": "createdAt",
  "expirationInfo": {
    "__typename": "__typename",
    "expirationDate": "expirationDate",
    "isExpired": true
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "quantity": {
    "__typename": "__typename",
    "unit": {
      "__typename": "__typename",
      "id": "id"
    },
    "value": 1.1
  },
  "role": {
    "__typename": "__typename",
    "group": 1,
    "primaryRole": "CONTROL",
    "subrole": "subrole"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single WellPlatePosition by ID.

Authentication

AuthorizationBearer

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

Path parameters

well_plate_position_idstringRequired

ID of the WellPlatePosition.

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

contentslist of objectsOptional

Well contents of the well plate.

coordinatesobjectOptional

Coordinates of the current position within the well plate.

createdAtstringOptional

When the well plate was created.

expirationInfoobjectOptional

Expiration info for the container.

idstringOptional

The ID of the container representing the well at this plate position.

modifiedAtstringOptional

When the well plate was last modified.

namestringOptional

The name of the container representing the well at this position.

quantityobject or nullOptional

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

roleobject or nullOptional

Represents the complete experimental designation of a well or container within an assay, combining a primary role (see PrimaryExperimentalRole), replicate group number, and optional subrole. The group field identifies replicate sets: wells with the same primary role and group number are treated as technical replicates for statistical analysis. The subrole field provides additional categorization for controls (e.g., POSITIVE, NEGATIVE, MAXIMUM, MINIMUM); only CONTROL primary roles may have subroles. ExperimentalRole is used in plate-based workflows to define experimental layouts (see PlateMapPosition) and annotate wells in FixedPlate and Container objects.

schemaobjectOptional

The container schema used by wells in the well plate.

Errors

400

Well Plate Position Get Request Bad Request Error

403

Well Plate Position Get Request Forbidden Error

404

Well Plate Position Get Request Not Found Error

429

Well Plate Position Get Request Too Many Requests Error

500

Well Plate Position Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors