Registry
Table Overview
Name | $raw Filters | Description |
---|---|---|
schema | Lists all schemas | |
field_definition | Lists all fields across schemas | |
entity_schema | Lists all entity schemas | |
entity | archived$ column is not True | Lists all entities across entity schemas, including those not registered |
registration_origin | Lists notebook entries that objects are registered in | |
registry_entity | archived$ column is not True | Lists all registered entities across entity schemas |
entity_alias | Lists all aliases of entities | |
dropdown | archived$ column is not True | Lists dropdown lists |
dropdown_option | archived$ column is not True | Lists dropdown list options |
An example Entity schema is shown at the end of this page.
schema
schema
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 |
schema_type | Schema type selected for schema of object | Text | entity, assay_result, assay_run, request, location, box, container, plate, batch | See Schema table for more information |
name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc |
field_definition
field_definition
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 |
archived$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
schema_id | Unique identifier for schema containing object | Foreign key for schema.id | ts_IOGwR6u4 | See Schema table for more information |
position | Field number in schema | Integer | 0, 1, 5, etc | 0 = 1st field.1 = 2nd field...etc |
name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
type | Selected type of entities for a schema object | dna_sequence, aa_sequence, custom_entity, entry | dna_sequence, aa_sequence, custom_entity, entry | Oligo schema are listed as dna_sequence types.See Schema table for more information |
display_name | Display name of schema in Benchling | Text | "Cell Line" | |
numeric_min | Minimum numeric value given for object | Integer | 0, 1, 5, etc | Precision limited by number of significant figures |
numeric_max | Maximum numeric value given for object | Integer | 0, 1, 5, etc | Precision limited by number of significant figures |
is_multi | Single or multi option identifier | TRUE, FALSE | TRUE, FALSE | |
is_required | Identifier whether field is required or not | TRUE, FALSE | TRUE, FALSE | |
dropdown_id | Unique id of dropdown table | Foreign key for dropdown.id | sfs_ZVmOP8Ed | dropdown_id also found in the URL for the dropdown in the Registry settings page |
target_schema_id | ID of target schema that points to the relationship link | Foreign key for entity_schema.id | ts_XDQ0OW6s |
entity_schema
entity_schema
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 |
schema_type | Schema type selected for schema of object | Text | entity, assay_result, assay_run, request, location, box, container, plate, batch | See Schema table for more information |
name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
archived$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
archive_purpose$ | Archival reason for object in Benchling | Text | null, Made in Error, Retired, Other, etc | null = object not archived |
entity_type | Selected type of entities for a schema object | dna_sequence, aa_sequence, custom_entity, entry | dna_sequence, aa_sequence, custom_entity, entry | Oligo schema are listed as dna_sequence types.See Schema table for more information |
registry_id | Unique identifier for an Organization's Registry | Foreign Key for registry ID | src_rdw6rOsL | 1 Registry per Organization |
prefix | Prefix selected for each schema object | Text | "p" | Prefix will always come before Registry ID for registered objects |
entity
entity
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 |
archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | true = object archived |
name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
file_registry_id | Unique Benchling Registry ID associated with each registered entity | Text | "p001" | |
creator_id | Unique identifier for creator of object | Foreign key for principal.id | ent_yXrL3BjX | |
created_at | Created date for object (when the entity was originally created) | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
schema_id | Unique identifier for schema containing object | Foreign key for schema.id | ts_IOGwR6u4 | |
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 |
project_id | Unique identifier for project containing object | Foreign key for project.id | src_PDSy77zE | If null, then object isn't contained within a project |
modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
type | Selected type of entities for a schema object | dna_sequence, aa_sequence, custom_entity, entry | dna_sequence, aa_sequence, custom_entity, entry | Oligo schema are listed as dna_sequence types |
validation_status | Registration validation status of object | PASSED, FAILED | PASSED, FAILED | |
url | URL for each object in Benchling | Browser URL | https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit | |
is_registered | Denotes whether this object is registered | Boolean | True |
registration_origin
registration_origin
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 registry | Foreign key to registry ID | src_hh9ffHqV | |
entity_id | The entity | Foreign key to entity.id | bfi_EVf5Yd8r | |
registered_at | Timestamp when entity was registered | Timestamp without timezone | 2023-07-26T21:46:53.670489 | |
origin_entry_id | Unique identifier for Entry | Foreign key to entry.id | etr_EuoDTxy1 |
registry_entity
registry_entity
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 |
archived$ | Archival state for object in Benchling | Boolean | TRUE, FALSE | true = object archived |
name | Name of object in Benchling | Character Varying | Transfection Entry, QC Results, Therapeutic Cell Line, etc | |
file_registry_id | Unique Benchling Registry ID associated with each registered entity | Text | "p001" | |
creator_id | Unique identifier for creator of object | Foreign key for principal.id | ent_yXrL3BjX | |
created_at | Created date for object (when the entity was originally created) | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
schema_id | Unique identifier for schema containing object | Foreign key for schema.id | ts_IOGwR6u4 | |
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 |
project_id | Unique identifier for project containing object | Foreign key for project.id | src_PDSy77zE | If null, then object isn't contained within a project |
modified_at | Most recent modified date for object | Timestamp without timezone | 2019-12-06T23:24:44.885478 | |
type | Selected type of entities for a schema object | dna_sequence, aa_sequence, custom_entity, entry | dna_sequence, aa_sequence, custom_entity, entry | Oligo schema are listed as dna_sequence types |
validation_status | Registration validation status of object | PASSED, FAILED | PASSED, FAILED | |
url | URL for each object in Benchling | Browser URL | https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit |
entity_alias
entity_alias
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 |
entity_id | The entity for which this is an alias | Foreign key for entity.id | ent_yXrL3BjX | |
alias | Identifier serving as the entity alias | Text | My Memorable Alias |
dropdown
dropdown
Table Row | Definition | Value Type | Example values (if applicable) | Notes |
---|---|---|---|---|
id | Unique Benchling-prescribed ID for each line item in table | Character Varying | sfs_jBu9uUnv, etc. | Primary key for a table |
name | Name of dropdown in Benchling | Character Varying | Color, Analytes, etc. | |
archived$ | Archival state for dropdown in Benchling | Boolean | TRUE, FALSE | true = object archived |
archived_purpose$ | Archival reason for dropdown in Benchling | Character Varying | null, Made in Error, Retired, Other, etc | null = object not archived |
dropdown_option
dropdown_option
Table Row | Definition | Value Type | Example values (if applicable) | Notes |
---|---|---|---|---|
id | Unique Benchling-prescribed ID for each line item in table | Character Varying | sfso_2v93jfF9, etc. | Primary key for a table |
dropdown_id | Reference to parent dropdown.id | Character Varying | sfs_jBu9uUnv, etc. | Refers to dropdown.id |
name | Name of dropdown option in Benchling | Character Varying | Red, Blue, Analyte 1, etc. | |
position | Relative position of dropdown option in the dropdown | Integer | 0, 3, etc. | Ranges from 0 to (# options in dropdown - 1) |
archived$ | Archival state for dropdown in Benchling | Boolean | TRUE, FALSE | true = object archived |
archived_purpose$ | Archival reason for dropdown in Benchling | Character Varying | null, Made in Error, Retired, Other, etc | null = object not archived |
EXAMPLE Entity Table
Table Row | Definition | Value Type | Example values (if applicable) | Notes |
---|---|---|---|---|
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 |
schema | Unique Schema name for object | Text | "Fermentation Results" | |
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 user.id | ent_yXrL3BjX | |
created_at$ | Created date for object (when the entity was originally created) | 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 | |
file_registry_id$ | Unique Benchling Registry ID associated with each registered entity | Text | "p001" | |
schema_id$ | Unique identifier for schema containing object | Foreign key for schema.id | ts_IOGwR6u4 | |
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 |
project_id$ | Unique identifier for project containing object | Foreign key for project.id | src_PDSy77zE | If null, then object isn't contained within a project |
url$ | url for each object in Benchling | Browser URL | https://demo.benchling.com/#biotech-org/f/lib_J3tmt8BP-Entry%20Namet/etr_gRogHFOb-untitled/edit | |
type$ | Selected type of entities for a schema object | dna_sequence, aa_sequence, custom_entity, entry | dna_sequence, aa_sequence, custom_entity, entry, rna_oligo | Oligo schema are listed as dna_sequence types |
is_registered$ | Is entity currently registered | Boolean | TRUE, FALSE | True = Entity has been registered |
Color (EXAMPLE) | Individual Schema Field | Text | "green" | Value dependent on field type. See field table for more information. |
Plasmid (EXAMPLE) | Individual Schema Field | Foreign key for plasmid entity | seq_HXnZhUkT | Value dependent on field type. See field table for more information. |
Length (EXAMPLE) | Individual Schema Field | Floating Point | 4.567 | Value dependent on field type. See field table for more information. |
Updated 1 day ago
What’s Next