Notebook Entry Tables
Reference guide to Benchling warehouse notebook entry, entry audit, entry template, and author tables.
This page is for Developer Documentation.
Notebook Entry Tables
entry
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
| archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | true = object archived |
| creator_id | Unique identifier for creator of object | Foreign key for principal.id | ent_yXrL3BjX | |
| created_at | Created date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
| display_id | Unique identifier surfaced in the actual Benchling site | Prefix-unique entry number | EXP001 or EXP20000416 | Unique Entry number |
| folder_id | Unique identifier for folder containing object | Foreign key for folder.id | lib_J3tmt8BP | If object not in folder, then folder_id = project_id.If null, then object not in folder/project |
| workflow_id | Unique identifier for workflow containing object | Foreign key for workflow.id | wfw_DMcZhu4A | |
| schema_id | Unique identifier for schema containing object | Foreign key for schema.id | ts_IOGwR6u4 | |
| entry_template_id | Unique identifier for entry template containing object | Foreign key for entry_template.id | tmpl_RlsGq4ng | |
| entry_template_version_id | Unique identifier for entry template version containing object | Foreign key for entry_template_version.id | tmplver_LKfYYNbv | |
| review_status | Current review status for object | null, NEEDS_REVIEW, REJECTED, RETRACTED, ACCEPTED, ACCEPTANCE_SNAPSHOT_IN_PROGRESS, REVIEW_SNAPSHOT_IN_PROGRESS | null, NEEDS_REVIEW, REJECTED, RETRACTED, ACCEPTED, ACCEPTANCE_SNAPSHOT_IN_PROGRESS, REVIEW_SNAPSHOT_IN_PROGRESS | null = entry not sent for review; REJECTED includes entries requiring revision; snapshot statuses are transient (only visible when blocking snapshot feature flags are enabled) |
| review_requested_at | Date of most recent review requested for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | NOTE: we prefer using requested_at on the review warehouse table |
| review_completed_at | Date when the review was completed | Timestamp without timezone | 2019-12-06T23:24:44.885478 | NOTE: we prefer using completed_at on the review warehouse table |
| review_initial_requested_at | Date when the review was first sent for review | Timestamp without timezone | 2019-12-06T23:24:44.885478 | Compared to requested_at, this captures the first time any reviewable was sent for review. NOTE: we prefer using initial_requested_at on the review warehouse table |
| review_status_changed_at | Date of review status change for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | NOTE: we prefer using review_status_changed_at on the review warehouse table |
| review_process_version_id | Unique identifier for version id of review process | Foreign key for review_process_version.id | rlc_SN0IwfBx | |
| url | URL for each object in Benchling | Browser URL | https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit |
entry_auditor
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| user_id | Unique identifier for user | Foreign key for user.id | ent_yXrL3BjX | See User Table for more information |
| entry_id | Unique identifier for Entry | Foreign key for entry.id | etr_GtcscEZq | See Entry Table for more information |
| review_process_stage_id | Unique identifier for review process stage | Foreign key for review_process_stage.id | rlcstg_ZjNgNXks | |
| review_status | The status for the review | String status | ACCEPTED, NEEDS_REVIEW, REJECTED, RETRACTED, etc. | |
| review_id | Unique identifier for review | Foreign key for review.id | rvw_JkYbw7mj | See Review table for more information |
entry_template
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | tmpl_RlsGq4ng, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | Template permissions are derived from the template collection’s ownership |
| archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
| archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | true = object archived |
| creator_id | Unique identifier for creator of object | Foreign key for principal.id | ent_yXrL3BjX | |
| created_at | Created date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
| name | Name of the entry template | Character Varying | Western Blot Template, PCR Protocol | |
| schema_id | Unique identifier for schema | Foreign key for schema.id | ts_IOGwR6u4 | Can be null if template is not schema-based |
author
| Table Row | Definition | Value Type | Example Values (if applicable) | Notes |
|---|---|---|---|---|
| id | Unique Benchling-prescribed ID for each line item in table | Format dependent on table | ent_yXrL3BjX, etr_GtcscEZq, loc_Y2v8daz0, etc | Primary key for a table |
| source_id | The project or registry that the object’s permissions comes from | Foreign key for project.id or registry ID | src_hh9ffHqV | If an object isn’t in a project, the permissions will be derived from the Registry |
| user_id | Unique identifier for user | Foreign key for principal.id | ent_yXrL3BjX | See User Table for more information |
| entry_id | Unique identifier for Entry | Foreign key for entry.id | etr_GtcscEZq | If entry has multiple authors there will be multiple rows per entry_id. See Entry Table for more information |