The identity and technical contract details declared by the specification.
CustomEntitySchemaRef
object
2 properties
AutomationInputFileRowConfig
object
Configures how a set of rows is generated for a lab automation input file. Each row config specifies a data source via LookupConfig, an optional destination, c…
4 properties
AssayRequestLinkFieldDefinition
object
A schema field definition for linking to assay requests.
12 properties
PlateLayout
object
Specifies the well-mapping layout used when generating input file rows for plate-based transfers. The layout type controls how sample positions on a source pla…
2 properties
AutomationOutputFileResultSchemaInfo
object
Configuration for creating assay results when processing an automation output file. Specifies the result schema and field mappings that control how file data i…
3 properties
RunSchemaRef
object
2 properties
ExtraHeadersTransformationProperties
object
Properties for an EXTRAHEADERS transform, specifying the row range that contains non-standard header rows to skip during file processing.
3 properties
AutomationInputFileNamePart
object
Represents a single segment of a generated input file name. Parts are concatenated in order to build the file name and can contain static text, date/time stamp…
4 properties
LongTextFieldDefinition
object
A long text field definition for multi-line text values with no length restrictions.
11 properties
PivotTransform
object
A data transform that reshapes long-format data into wide format by pivoting unique values from a keys column into separate columns.
3 properties
MultipleValuesFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by checking whether a column's value is in (ISIN) or not in (NOTIN) a set of allowed values.
4 properties
ResultSchemaRef
object
2 properties
CustomEntityLinkFieldDefinition
object
A schema field definition for linking to custom entities.
14 properties
ExtraHeadersTransform
object
A data transform that handles files with extra header rows above the standard column header. Strips the specified header rows so downstream processing sees cle…
3 properties
MergeTransformationProperties
object
Properties for a MERGE transform, specifying the columns to combine, the output column name, and the delimiter placed between merged values.
4 properties
TranslationLinkFieldDefinition
object
A schema field definition for linking to translations (AA sequences created from RNA).
13 properties
FolderRef
object
2 properties
ExtraFootersTransformationProperties
object
Properties for an EXTRAFOOTERS transform, specifying how many trailing rows to remove from the bottom of the file.
2 properties
OrganizationRef
object
2 properties
MixtureLinkFieldDefinition
object
A schema field definition for linking to mixtures.
14 properties
RunSchemaPaginatedList
object
2 properties
DropdownRef
object
2 properties
PivotTransformationProperties
object
Properties for a PIVOT transform, specifying the index columns to group by, the keys column whose values become new column headers, and the values column to sp…
4 properties
CustomTransformationProperties
object
Properties for a CUSTOM transform, identifying the Benchling App that performs the transformation via its API ID.
2 properties
BaseFieldDefinition
object
A basic schema field definition for primitive data types. Used for fields with types like TEXT, INTEGER, FLOAT, BOOLEAN, DATE, DATETIME, JSON, and LONGTEXT. Ea…
11 properties
AutomationOutputFileEntitySchemaInfo
object
Configuration for registering or updating entities when processing an automation output file. Specifies the entity schema, destination folder, naming strategy,…
7 properties
DnaOligoSchemaRef
object
2 properties
OligoDuplexLinkFieldDefinition
object
A schema field definition for linking to Oligo Duplexes.
14 properties
DropdownLinkFieldDefinition
object
A schema field definition that links to a dropdown for value selection. The linkDefinition field references the Dropdown configuration that defines the availab…
13 properties
EntryLinkFieldDefinition
object
A schema field definition for linking to notebook entries.
12 properties
AutomationOutputFileInventorySchemaInfo
object
Configuration for creating or updating inventory items (plates, boxes, or containers) when processing an automation output file. Specifies the destination sche…
5 properties
ArithmeticTransformationProperties
object
Properties for an ARITHMETIC transform, defining the operator, operands, and the name of the result column. Supports addition, subtraction, multiplication, and…
5 properties
ArithmeticTransform
object
A data transform that performs arithmetic operations between two variables (columns or constants) and writes the result to a new column.
3 properties
SchemaLinkFieldDefinition
object
A schema field definition for link types that reference other Benchling objects. Extends basic field properties with link-specific constraints.
12 properties
InternalServerError
object
6 properties
5 required
AddColumnTransform
object
A data transform that adds a new column to the file with values resolved via a LookupConfig. Used in input file generation to enrich data with looked-up values.
3 properties
EntitySchemaRef
object
2 properties
RnaOligoLinkFieldDefinition
object
A schema field definition for linking to RNA Oligos.
14 properties
AaSequenceSchemaRef
object
2 properties
StorableLinkFieldDefinition
object
A schema field definition for linking to storable inventory items.
12 properties
RnaSequenceLinkFieldDefinition
object
A schema field definition for linking to RNA sequences.
14 properties
FloatFieldDefinition
object
A float field definition for decimal number values. Supports numeric constraints (min/max), display precision, and units.
15 properties
ArithmeticTransformColumnVariable
object
A variable in an arithmetic transform that references values from a named column in the file.
3 properties
AutomationInputFileConfigUnpaginatedList
object
1 property
MeltTransform
object
A data transform that unpivots wide-format data into long format by converting selected value columns into rows, each identified by a variable name.
3 properties
DnaSequenceLinkFieldDefinition
object
A schema field definition for linking to DNA sequences.
14 properties
FieldsetRef
object
2 properties
SchemaFieldDefinitionRef
object
2 properties
SystemCategoryLinkFieldDefinition
object
A schema field definition for linking to entities that implement a system category (static schema interface).
12 properties
MoleculeLinkFieldDefinition
object
A schema field definition for linking to molecules.
14 properties
FieldsetLinkFieldDefinition
object
A schema field definition for linking to entities that implement a fieldset (custom schema interface).
14 properties
AutomationOutputFileTransformationFieldInfo
object
Maps a schema field to a data source when processing an automation output file. Specifies how to populate the field: directly from a file column, from the prim…
6 properties
MeltTransformationProperties
object
Properties for a MELT transform, specifying identifier columns to keep fixed, value columns to unpivot, and optional names for the new variable and value colum…
5 properties
CustomTransform
object
A data transform that delegates processing to an external Benchling App. The app is identified by its API ID in the transformation properties.
3 properties
TranscriptionLinkFieldDefinition
object
A schema field definition for linking to transcriptions (RNA sequences created from DNA).
14 properties
AutomationOutputFileConfig
object
Defines the configuration for processing output files from laboratory automation instruments and converting them into Benchling data. An AutomationOutputFileCo…
18 properties
IntegerFieldDefinition
object
An integer field definition for whole number values. Supports numeric constraints (min/max) and units.
14 properties
RnaSequenceSchemaRef
object
2 properties
AddColumnTransformationProperties
object
Properties for an ADDCOLUMN transform, specifying the name of the new column to add.
2 properties
FindReplaceTransform
object
A data transform that substitutes values in the file by finding occurrences and replacing them. Replacement values can be specified inline or resolved via a Lo…
2 properties
JsonFieldDefinition
object
A JSON field definition for storing structured JSON data.
11 properties
DateFieldDefinition
object
A date field definition for date-only values (without time).
11 properties
AutomationTransformConfig
object
OligoDuplexSchemaRef
object
2 properties
RnaOligoSchemaRef
object
2 properties
AnyEntityLinkFieldDefinition
object
A schema field definition for linking to any entity type.
12 properties
AutomationOutputFileConfigUnpaginatedList
object
1 property
NumberValueFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by comparing a column's numeric value using relational operators (EQ, NE, LE, LT, GE, GT).
4 properties
DnaSequenceSchemaRef
object
2 properties
OligoConjugateLinkFieldDefinition
object
A schema field definition for linking to Oligo Conjugates.
14 properties
LocationRef
object
2 properties
ExtraFootersTransform
object
A data transform that removes trailing footer rows from a file. Useful for instrument output files that append summary or metadata rows after the data.
3 properties
DnaPartLinkFieldDefinition
object
A schema field definition for linking to DNA parts.
13 properties
SchemaFieldDefinition
object
BooleanFieldDefinition
object
A boolean field definition for true/false values.
11 properties
MoleculeSchemaRef
object
2 properties
AssayRunLinkFieldDefinition
object
A schema field definition for linking to assay runs.
13 properties
StringValueFilterTransformationProperties
object
Properties for a FILTER transform that filters rows by comparing a column's string value using equality or inequality.
4 properties
ArithmeticTransformConstantVariable
object
A variable in an arithmetic transform that holds a fixed numeric constant.
3 properties
AutomationInputFileRowConfigColumn
object
Defines a single column within an input file row configuration. Each column has a lookup configuration that determines the values to populate and a display nam…
2 properties
GeneralError
object
5 properties
5 required
EquipmentSchemaRef
object
2 properties
TextFieldDefinition
object
A text field definition for short, single-line text values.
11 properties
RemoveQuotesTransform
object
A data transform that strips quote characters from all values in the file. Takes no additional configuration parameters.
3 properties
AutomationInputFileDestinationInfo
object
Describes a destination target for rows in a lab automation input file. Contains a lookup configuration for resolving destination samples and an optional displ…
2 properties
EquipmentLinkFieldDefinition
object
A schema field definition for linking to Equipment.
14 properties
DateTimeFieldDefinition
object
A datetime field definition for date and time values with timezone support.
11 properties
AssayResultLinkFieldDefinition
object
A schema field definition for linking to assay results.
13 properties
AutomationOutputFileNamedColumnType
object
Associates a column name with its data type in an automation output file configuration. Used instead of plain column name strings when the column type must be…
3 properties
OligoConjugateSchemaRef
object
2 properties
AutomationInputFileConfig
object
Defines the configuration for generating input files that drive laboratory automation instruments. An AutomationInputFileConfig specifies how to pull sample da…
12 properties
AaPartLinkFieldDefinition
object
A schema field definition for linking to AA parts.
13 properties
AntibodyLinkFieldDefinition
object
A schema field definition for linking to Antibodies.
13 properties
DuplicateTransformationProperties
object
Properties for a DUPLICATE transform, specifying the source column to copy and the name for the new duplicate column.
3 properties
BlobLinkFieldDefinition
object
A schema field definition for linking to blobs (file attachments).
12 properties
MergeTransform
object
A data transform that concatenates values from multiple columns into a single output column, separated by a configurable delimiter.
3 properties
RunSchema
object
Defines the structure and automation configuration for a category of Runs in Benchling's lab automation system. A RunSchema specifies field definitions for run…
15 properties
DnaOligoLinkFieldDefinition
object
A schema field definition for linking to DNA Oligos.
14 properties
SchemaFieldDefinitionUnpaginatedList
object
1 property
ObjectRef
object
2 properties
NullFilterTransformationProperties
object
Properties for a FILTER transform that filters rows based on null or non-null values in a specified column.
3 properties
MixtureSchemaRef
object
2 properties
FilterTransform
object
A data transform that removes rows from the file based on column value conditions. Supports null checks, string/number comparisons, and set membership filters.
3 properties
PlateShapeTransform
object
A data transform that extracts plate-shaped data from a file by locating the well grid at specified coordinates and optionally removing all surrounding cells.
3 properties
SplitTransform
object
A data transform that divides values in a single column into multiple output columns by splitting on a delimiter.
3 properties
UnitRef
object
2 properties
SplitTransformationProperties
object
Properties for a SPLIT transform, specifying the column to split, the delimiter to split on, and the names for the resulting output columns.
4 properties
PlateShapeTransformationProperties
object
Properties for a PLATESHAPE transform, specifying the plate schema for expected dimensions, the cell coordinates of well A1, and whether to discard data outsid…
5 properties
AaSequenceLinkFieldDefinition
object
A schema field definition for linking to AA sequences.
14 properties
DuplicateTransform
object
A data transform that copies an existing column to a new column with a different name.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Benchling publishes across the network.
