Benchling · Schema

StageEntry

A notebook entry used for execution of one or more stage runs in a legacy workflow.

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

Properties

Name Type Description
apiURL string The canonical url of the Stage Entry in the API.
authors array Array of UserSummary Resources of the authors of the stage entry. This defaults to the creator but can be manually changed.
createdAt string DateTime the stage entry was created at
creator object UserSummary Resource of the user who created the stage entry
customFields object
displayId string User-friendly ID of the stage entry
fields object
folderId string ID of the folder that contains the stage entry
id string ID of the stage entry
modifiedAt string DateTime the stage entry was last modified
name string Title of the stage entry
reviewRecord object Review record if set
schema object Entry schema if set
webURL string URL of the stage entry
workflowId string ID of the parent workflow
workflowStageId string ID of the associated workflow stage
View JSON Schema on GitHub

JSON Schema

StageEntry.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/StageEntry.json",
  "title": "StageEntry",
  "additionalProperties": false,
  "description": "A notebook entry used for execution of one or more stage runs in a legacy workflow.",
  "properties": {
    "apiURL": {
      "description": "The canonical url of the Stage Entry in the API.",
      "example": "https://benchling.com/api/v2-alpha/stage-entries/stgentr_1HEcejZq",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "authors": {
      "description": "Array of UserSummary Resources of the authors of the stage entry. This defaults to the creator but can be manually changed.\n",
      "items": {
        "$ref": "#/components/schemas/UserSummary"
      },
      "type": "array"
    },
    "createdAt": {
      "description": "DateTime the stage entry was created at",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserSummary"
        }
      ],
      "description": "UserSummary Resource of the user who created the stage entry",
      "readOnly": true
    },
    "customFields": {
      "$ref": "#/components/schemas/CustomFields"
    },
    "displayId": {
      "description": "User-friendly ID of the stage entry",
      "type": "string"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "folderId": {
      "description": "ID of the folder that contains the stage entry",
      "type": "string"
    },
    "id": {
      "description": "ID of the stage entry",
      "type": "string"
    },
    "modifiedAt": {
      "description": "DateTime the stage entry was last modified",
      "type": "string"
    },
    "name": {
      "description": "Title of the stage entry",
      "type": "string"
    },
    "reviewRecord": {
      "description": "Review record if set",
      "nullable": true,
      "type": "object"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntrySchema"
        }
      ],
      "description": "Entry schema if set",
      "nullable": true,
      "title": "SchemaProperty",
      "type": "object"
    },
    "webURL": {
      "description": "URL of the stage entry",
      "type": "string"
    },
    "workflowId": {
      "description": "ID of the parent workflow",
      "example": "wfw_7COQmok7",
      "type": "string"
    },
    "workflowStageId": {
      "description": "ID of the associated workflow stage",
      "example": "wfwstg_EZuryAiW",
      "type": "string"
    }
  },
  "type": "object"
}