Bulk get requests

GET

https://{tenant_name}.benchling.com/api/v2/requests:bulk-get

GET

/api/v2/requests:bulk-get

curl -G https://{tenant_name}.benchling.com/api/v2/requests:bulk-get \
     -H "Authorization: Bearer <token>" \
     --data-urlencode displayIds=VPR001,VPR002 \
     --data-urlencode requestIds=req_xJk20sla,req_lQJ3nMs5

{
  "requests": [
    {
      "apiURL": "https://benchling.com/api/v2/requests/req_dnn2JtWq",
      "assignees": [
        {
          "user": {
            "handle": "string",
            "id": "string",
            "name": "string"
          }
        }
      ],
      "createdAt": {},
      "creator": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "displayId": "VP1",
      "fields": {},
      "id": "req_JekfeyVS",
      "projectId": "src_29pt8Ida",
      "requestStatus": "REQUESTED",
      "requestor": {
        "handle": "string",
        "id": "string",
        "name": "string"
      },
      "sampleGroups": [
        {
          "id": "sgrp_YJKtcWV",
          "samples": {
            "Batch Example": {
              "batchId": "bat_XK0UnLyk"
            },
            "Entity Example": {
              "containerId": "ctn_urUAEBq",
              "entityId": "seq_nDtxYEs"
            }
          }
        }
      ],
      "scheduledOn": {},
      "schema": {
        "id": "string",
        "name": "string"
      },
      "tasks": [
        {
          "id": "reqtsk_PFHQ8rmb",
          "fields": {},
          "sampleGroupIds": [
            "string"
          ],
          "schema": {
            "id": "string",
            "name": "string"
          }
        }
      ],
      "webURL": "https://benchling.com/requests/req_JekfeyVS"
    }
  ]
}

Bulk get Legacy Requests by API ID or display ID

Authentication

AuthorizationBearer

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

Query parameters

requestIdsstringOptional

Comma-separated list of Legacy Request IDs. Exactly one of requestIds or displayIds must be specified.

displayIdsstringOptional

Comma-separated list of display IDs. Exactly one of requestIds or displayIds must be specified.

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

requestslist of objectsOptional

Errors

400

Bad Request Error