Benchling · Schema

AppCanvasBase

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

JSON Schema

AppCanvasBase.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/AppCanvasBase.json",
  "title": "AppCanvasBase",
  "allOf": [
    {
      "$ref": "#/components/schemas/AppCanvasUiBlockList"
    },
    {
      "properties": {
        "archiveRecord": {
          "nullable": true,
          "properties": {
            "reason": {
              "$ref": "#/components/schemas/AppCanvasesArchiveReason"
            }
          },
          "type": "object"
        },
        "data": {
          "description": "Additional data to associate with the canvas. Can be useful for persisting data associated with the canvas but won't be rendered to the user. If specified, it must be valid JSON in string format less than 5kb in total.\n",
          "example": "{\"key\": \"value\"}",
          "nullable": true,
          "type": "string"
        },
        "enabled": {
          "description": "Overall control for whether the canvas is interactable or not. If `false`, every block is disabled and will override the individual block's `enabled` property. If `true` or absent, the interactivity status will defer to the block's `enabled` property.\n",
          "type": "boolean"
        },
        "featureId": {
          "description": "Identifier of the feature defined in Benchling App Manifest this canvas corresponds to.",
          "nullable": false,
          "type": "string"
        },
        "resourceId": {
          "description": "Identifier of the resource object to attach canvas to.",
          "nullable": false,
          "type": "string"
        },
        "sessionId": {
          "description": "Identifier of a session. If specified, app status messages from the session will be reported in the canvas.\n",
          "example": "sesn_SwKtkgB5",
          "nullable": true,
          "type": "string"
        }
      }
    }
  ],
  "type": "object"
}