Benchling · Schema

Entry

Entries are notes that users can take. They're organized by "days" (which are user-configurable) and modeled within each day as a list of "notes." Each note has a type - the simplest is a "text" type, but lists, tables, and external files are also supported. *Note:* the current Entry resource has a few limitations: - Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented. - Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate. Note: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls.

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

Properties

Name Type Description
apiURL string The canonical url of the Entry in the API.
archiveRecord object ArchiveRecord Resource if the entry is archived. This is null if the entry is not archived.
assignedReviewers array Array of users assigned to review the entry, if any.
authors array Array of UserSummary Resources of the authors of the entry. This defaults to the creator but can be manually changed.
createdAt string DateTime the entry was created at
creator object UserSummary Resource of the user who created the entry
customFields object
days array Array of day objects. Each day object has a date field (string) and notes field (array of notes, expand further for details on note types).
displayId string User-friendly ID of the entry
entryTemplateId string ID of the Entry Template this Entry was created from
fields object
folderId string ID of the folder that contains the entry
id string ID of the entry
modifiedAt string DateTime the entry was last modified
name string Title of the entry
reviewRecord object Review record if set
schema object Entry schema if set
webURL string URL of the entry
View JSON Schema on GitHub

JSON Schema

Entry.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/Entry.json",
  "title": "Entry",
  "description": "Entries are notes that users can take. They're organized by \"days\" (which are user-configurable) and modeled within each day as a list of \"notes.\" Each note has a type - the simplest is a \"text\" type, but lists, tables, and external files are also supported.\n\n*Note:* the current Entry resource has a few limitations:\n- Formatting information is not yet supported. Header formatting, bolding, and other stylistic information is not presented.\n- Data in tables is presented as text always - numeric values will need to be parsed into floats or integers, as appropriate.\n\nNote: Data in Results tables are not accessible through this API call. Results table data can be called through the Results API calls.\n",
  "properties": {
    "apiURL": {
      "description": "The canonical url of the Entry in the API.",
      "example": "https://benchling.com/api/v2/entries/etr_tv7m7B78",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArchiveRecord"
        }
      ],
      "description": "ArchiveRecord Resource if the entry is archived. This is null if the entry is not archived.\n",
      "nullable": true
    },
    "assignedReviewers": {
      "description": "Array of users assigned to review the entry, if any.\n",
      "items": {
        "$ref": "#/components/schemas/UserSummary"
      },
      "type": "array"
    },
    "authors": {
      "description": "Array of UserSummary Resources of the authors of the entry. This defaults to the creator but can be manually changed.\n",
      "items": {
        "$ref": "#/components/schemas/UserSummary"
      },
      "type": "array"
    },
    "createdAt": {
      "description": "DateTime the 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 entry",
      "readOnly": true
    },
    "customFields": {
      "$ref": "#/components/schemas/CustomFields"
    },
    "days": {
      "description": "Array of day objects. Each day object has a date field (string) and notes field (array of notes, expand further for details on note types).\n",
      "items": {
        "$ref": "#/components/schemas/EntryDay"
      },
      "type": "array"
    },
    "displayId": {
      "description": "User-friendly ID of the entry",
      "type": "string"
    },
    "entryTemplateId": {
      "description": "ID of the Entry Template this Entry was created from",
      "nullable": true,
      "type": "string"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "folderId": {
      "description": "ID of the folder that contains the entry",
      "type": "string"
    },
    "id": {
      "description": "ID of the entry",
      "type": "string"
    },
    "modifiedAt": {
      "description": "DateTime the entry was last modified",
      "type": "string"
    },
    "name": {
      "description": "Title of the entry",
      "type": "string"
    },
    "reviewRecord": {
      "description": "Review record if set",
      "nullable": true,
      "properties": {
        "comment": {
          "description": "Reviewer's Comments",
          "type": "string"
        },
        "reviewChanges": {
          "description": "A list of the Review Changes that have been made to this entry",
          "items": {
            "$ref": "#/components/schemas/ReviewChange"
          },
          "type": "array"
        },
        "reviewProcesses": {
          "description": "Review Processes associated with the Entry",
          "items": {
            "$ref": "#/components/schemas/EntryReviewProcess"
          },
          "nullable": true,
          "type": "array"
        },
        "status": {
          "description": "Review Status of the entry",
          "enum": [
            "ACCEPTED",
            "NEEDS_REVIEW",
            "REJECTED",
            "RETRACTED",
            "ACCEPTANCE_SNAPSHOT_IN_PROGRESS",
            "REVIEW_SNAPSHOT_IN_PROGRESS",
            "IN_PROGRESS",
            "ACTION_REQUIRED"
          ],
          "type": "string"
        }
      },
      "type": "object"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntrySchema"
        }
      ],
      "description": "Entry schema if set",
      "nullable": true,
      "title": "SchemaProperty",
      "type": "object"
    },
    "webURL": {
      "description": "URL of the entry",
      "type": "string"
    }
  },
  "type": "object"
}