Benchling · Schema

ExternalFileNotePart

An attached user-uploaded file

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

JSON Schema

ExternalFileNotePart.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/ExternalFileNotePart.json",
  "title": "ExternalFileNotePart",
  "allOf": [
    {
      "$ref": "#/components/schemas/BaseNotePart"
    },
    {
      "properties": {
        "externalFileId": {
          "description": "The ID of the external file. Use the 'Get an external file' endpoint to retrieve metadata about it.\n",
          "type": "string"
        },
        "links": {
          "description": "Array of links referenced in the caption via an @-mention, hyperlink, or the drag-n-dropped preview attached to the note.\n",
          "items": {
            "$ref": "#/components/schemas/EntryLink"
          },
          "type": "array"
        },
        "text": {
          "description": "The caption of the file attachment.",
          "type": "string"
        },
        "type": {
          "enum": [
            "external_file"
          ],
          "type": "string"
        }
      },
      "type": "object"
    }
  ],
  "description": "An attached user-uploaded file"
}