Benchling · Schema

Request

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks
View JSON Schema on GitHub

JSON Schema

Request.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/Request.json",
  "title": "Request",
  "allOf": [
    {
      "$ref": "#/components/schemas/RequestBase"
    },
    {
      "properties": {
        "apiURL": {
          "description": "The canonical url of the Legacy Request in the API.",
          "example": "https://benchling.com/api/v2/requests/req_dnn2JtWq",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        },
        "assignees": {
          "description": "Array of assignees",
          "items": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/RequestUserAssignee"
              },
              {
                "$ref": "#/components/schemas/RequestTeamAssignee"
              }
            ]
          },
          "readOnly": true,
          "type": "array"
        },
        "createdAt": {
          "description": "Date and time the Legacy Request was created",
          "example": "2017-04-23T01:30:50.970926",
          "format": "isoformat",
          "readOnly": true,
          "type": "string"
        },
        "creator": {
          "allOf": [
            {
              "$ref": "#/components/schemas/UserSummary"
            },
            {
              "description": "UserSummary of the user who created the Legacy Request"
            },
            {
              "readOnly": true
            }
          ]
        },
        "displayId": {
          "description": "User-friendly ID of the Legacy Request",
          "example": "VP1",
          "readOnly": true,
          "type": "string"
        },
        "fields": {
          "$ref": "#/components/schemas/Fields"
        },
        "id": {
          "description": "Unique ID for the Legacy Request",
          "example": "req_JekfeyVS",
          "readOnly": true,
          "type": "string"
        },
        "projectId": {
          "description": "The ID of the project to which the Legacy Request belongs.",
          "example": "src_29pt8Ida",
          "type": "string"
        },
        "requestStatus": {
          "$ref": "#/components/schemas/RequestStatus"
        },
        "requestor": {
          "allOf": [
            {
              "$ref": "#/components/schemas/UserSummary"
            },
            {
              "description": "UserSummary of the user making the Legacy Request"
            },
            {
              "readOnly": true
            }
          ]
        },
        "sampleGroups": {
          "items": {
            "$ref": "#/components/schemas/RequestSampleGroup"
          },
          "type": "array"
        },
        "scheduledOn": {
          "description": "Date the Legacy Request is scheduled to be executed on, in YYYY-MM-DD format.",
          "example": "2019-09-12",
          "format": "date",
          "nullable": true,
          "type": "string"
        },
        "schema": {
          "allOf": [
            {
              "$ref": "#/components/schemas/SchemaSummary"
            },
            {
              "description": "SchemaSummary for the Legacy Request",
              "example": {
                "id": "assaysch_3IF58QOf",
                "name": "Vector Production"
              },
              "readOnly": true
            }
          ],
          "title": "SchemaProperty"
        },
        "tasks": {
          "items": {
            "$ref": "#/components/schemas/RequestTask"
          },
          "type": "array"
        },
        "webURL": {
          "description": "URL of the Legacy Request",
          "example": "https://benchling.com/requests/req_JekfeyVS",
          "format": "uri",
          "readOnly": true,
          "type": "string"
        }
      }
    }
  ]
}