Benchling · Schema

EntryLink

Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a Benchling resource via @-mentions and drag-n-drop.

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

Properties

Name	Type	Description
id	string	For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for "link" types.
type	string	The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'd
webURL	string	Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for "link" types. Note: locations do not currently

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/EntryLink.json",
  "title": "EntryLink",
  "description": "Links are contained within notes to reference resources that live outside of the entry. A link can target an external resource via an http(s):// hyperlink or a Benchling resource via @-mentions and drag-n-drop.\n",
  "properties": {
    "id": {
      "description": "For linked Benchling resources, this will be the ID of that resource (e.g., 'seq_RhYGVnHF'). Omitted for \"link\" types.\n",
      "type": "string"
    },
    "type": {
      "description": "The type of resource being linked. For hyperlinks: 'link'. For linked Benchling resources, one of: 'user', 'request', 'entry', 'stage_entry', 'protocol', 'workflow', 'custom_entity', 'aa_sequence', 'dna_sequence', 'batch', 'box', 'container', 'location', 'plate', 'sql_dashboard'; and (for legacy support) 'insights_dashboard', 'folder'.\n",
      "enum": [
        "link",
        "user",
        "request",
        "entry",
        "stage_entry",
        "protocol",
        "workflow",
        "custom_entity",
        "aa_sequence",
        "dna_sequence",
        "batch",
        "box",
        "container",
        "location",
        "plate",
        "insights_dashboard",
        "folder",
        "sql_dashboard"
      ],
      "type": "string"
    },
    "webURL": {
      "description": "Canonical URL of the linked Benchling resource (if you have at least READ authorization for that resource), or the explicit URL provided as hyperlink for \"link\" types. Note: locations do not currently have a URL.\n",
      "nullable": true,
      "type": "string"
    }
  },
  "type": "object"
}