Benchling · Schema

AsyncTask

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name Type Description
errors object
message string Present only when status is FAILED. Contains information about the error.
response object Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.
status string The current state of the task.
View JSON Schema on GitHub

JSON Schema

AsyncTask.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/AsyncTask.json",
  "title": "AsyncTask",
  "properties": {
    "errors": {
      "oneOf": [
        {
          "description": "Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.\n",
          "items": {
            "type": "object"
          },
          "type": "array"
        },
        {
          "description": "Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.\n",
          "type": "object"
        }
      ]
    },
    "message": {
      "description": "Present only when status is FAILED. Contains information about the error.",
      "type": "string"
    },
    "response": {
      "description": "Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.",
      "type": "object"
    },
    "status": {
      "description": "The current state of the task.",
      "enum": [
        "RUNNING",
        "SUCCEEDED",
        "FAILED"
      ],
      "type": "string"
    }
  },
  "required": [
    "status"
  ],
  "type": "object"
}