Create a Legacy Request

POST

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

POST

/api/v2/requests

curl -X POST https://{tenant_name}.benchling.com/api/v2/requests \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "schemaId": "assaysch_3IF58QOf",
  "fields": {},
  "projectId": "src_29pt8Ida",
  "sampleGroups": [
    {
      "samples": {
        "Batch Example": {
          "batchId": "bat_XK0UnLyk"
        },
        "Entity Example": {
          "containerId": "ctn_urUAEBq",
          "entityId": "seq_nDtxYEs"
        }
      }
    }
  ]
}'

{
  "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"
}

Create a Legacy Request

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

schemaIdstringRequired

ID of the Legacy Request's schema.

assigneeslist of objectsOptional

Array of assignees

fieldsmap from strings to objectsOptional

The Legacy Request's fields

projectIdstringOptional

The ID of the project to which the Legacy Request belongs.

requestorIdstring or nullOptional

ID of the user making the Legacy Request. If unspecified, the requestor is the request creator.

sampleGroupslist of objectsOptional

scheduledOndateOptional

Date the Legacy Request is scheduled to be executed on, in YYYY-MM-DD format.

Response

Created

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Legacy Request in the API.

assigneeslist of objectsOptionalRead-only

Array of assignees

createdAtstringOptionalRead-onlyformat: "isoformat"

Date and time the Legacy Request was created

creatorobjectOptional

UserSummary of the user who created the Legacy Request

displayIdstringOptionalRead-only

User-friendly ID of the Legacy Request

fieldsmap from strings to objectsOptional

idstringOptionalRead-only

Unique ID for the Legacy Request

projectIdstringOptional

The ID of the project to which the Legacy Request belongs.

requestStatusenumOptional

Allowed values:

requestorobjectOptional

UserSummary of the user making the Legacy Request

sampleGroupslist of objectsOptional

scheduledOndate or nullOptional

Date the Legacy Request is scheduled to be executed on, in YYYY-MM-DD format.

schemaobjectOptional

SchemaSummary for the Legacy Request

taskslist of objectsOptional

webURLstringOptionalRead-onlyformat: "uri"

URL of the Legacy Request

Errors

400

Bad Request Error