Benchling Study Schema API is one of 203 APIs that Benchling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include StudySchema. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and a changelog.
This API exposes
10 operations
across 9 paths,
and defines 106 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, /api/v3.
The identity and technical contract details declared by the specification.
CustomEntitySchemaRef
object
2 properties
CreateDnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
CreateDateFieldDefinitionInput
object
5 properties
4 required
CreateFloatFieldDefinitionInput
object
9 properties
4 required
CustomField
object
A name-value pair for storing additional metadata on objects that support custom fields. CustomFields provide a flexible way to attach arbitrary string data to…
3 properties
AssayRequestLinkFieldDefinition
object
A schema field definition for linking to assay requests.
12 properties
EntrySchemaRef
object
2 properties
RunSchemaRef
object
2 properties
CreateBooleanFieldDefinitionInput
object
5 properties
4 required
LongTextFieldDefinition
object
A long text field definition for multi-line text values with no length restrictions.
11 properties
SchemaFieldValue
object
Represents a field value on a schematized object, pairing a fieldDefinition (describing the field's type and constraints) with its actual value (a BenchlingVal…
5 properties
ResultSchemaRef
object
2 properties
CustomEntityLinkFieldDefinition
object
A schema field definition for linking to custom entities.
14 properties
UpdateStudySchemaInput
object
10 properties
DateTimeValue
object
A type that represents datetime values.
2 properties
TranslationLinkFieldDefinition
object
A schema field definition for linking to translations (AA sequences created from RNA).
13 properties
OrganizationRef
object
2 properties
MixtureLinkFieldDefinition
object
A schema field definition for linking to mixtures.
14 properties
DropdownRef
object
2 properties
CreateRnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
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
StudySchema
object
A configuration template that defines the structure and behavior of Studies within an organization. Each StudySchema specifies the studyType, which determines…
16 properties
CreateCustomEntityLinkFieldDefinitionInput
object
8 properties
6 required
JsonValue
object
A type that represents JSON values.
2 properties
CreateIntegerFieldDefinitionInput
object
8 properties
4 required
TextAndUrlValue
object
A type that represents text (string) values with an associated URL.
3 properties
DnaOligoSchemaRef
object
2 properties
CreateStudySchemaInput
object
11 properties
4 required
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
CreateTextFieldDefinitionInput
object
5 properties
4 required
ObjectLinkValue
object
A type that represents links to other objects.
2 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
DecimalValue
object
A type that represents decimal value as strings.
3 properties
StudySchemaPaginatedList
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
PrincipalRef
object
2 properties
FloatFieldDefinition
object
A float field definition for decimal number values. Supports numeric constraints (min/max), display precision, and units.
15 properties
CreateBlobLinkFieldDefinitionInput
object
6 properties
5 required
DnaSequenceLinkFieldDefinition
object
A schema field definition for linking to DNA sequences.
14 properties
FieldsetRef
object
2 properties
CreateJsonFieldDefinitionInput
object
5 properties
4 required
SchemaFieldDefinitionRef
object
2 properties
CreateAntibodyLinkFieldDefinitionInput
object
8 properties
6 required
ObjectLinkListValue
object
A type that represents a list of links to other objects.
2 properties
TemplateCollectionRef
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
CreateMoleculeLinkFieldDefinitionInput
object
8 properties
6 required
CreateLongTextFieldDefinitionInput
object
5 properties
4 required
CreateAaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
DateValue
object
A type that represents date values.
2 properties
TranscriptionLinkFieldDefinition
object
A schema field definition for linking to transcriptions (RNA sequences created from DNA).
14 properties
BooleanValue
object
A type that represents boolean values.
2 properties
CreateAnyEntityLinkFieldDefinitionInput
object
6 properties
5 required
IntegerFieldDefinition
object
An integer field definition for whole number values. Supports numeric constraints (min/max) and units.
14 properties
CreateOligoDuplexLinkFieldDefinitionInput
object
8 properties
6 required
RnaSequenceSchemaRef
object
2 properties
CreateDateTimeFieldDefinitionInput
object
5 properties
4 required
UpdateStudySchemaInputWithPathParams
object
11 properties
1 required
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
OligoDuplexSchemaRef
object
2 properties
RnaOligoSchemaRef
object
2 properties
AnyEntityLinkFieldDefinition
object
A schema field definition for linking to any entity type.
12 properties
CreateMixtureLinkFieldDefinitionInput
object
8 properties
6 required
DnaSequenceSchemaRef
object
2 properties
OligoConjugateLinkFieldDefinition
object
A schema field definition for linking to Oligo Conjugates.
14 properties
BulkImport
object
1 property
1 required
CreateDropdownLinkFieldDefinitionInput
object
7 properties
6 required
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
CreateOligoConjugateLinkFieldDefinitionInput
object
8 properties
6 required
IntegerValue
object
A type that represents integer values.
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
EntryTemplateUnpaginatedList
object
1 property
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
EntryTemplate
object
A template used to create new DocumentLike objects with pre-populated content and structure. EntryTemplates contain boilerplate text, tables, placeholders, and…
12 properties
OligoConjugateSchemaRef
object
2 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
AsyncTaskLink
object
2 properties
ArrayValue
object
A type that represents a list of BenchlingValues, used for multi-value cells (e.g. alias columns).
2 properties
BlobLinkFieldDefinition
object
A schema field definition for linking to blobs (file attachments).
12 properties
CreateEquipmentLinkFieldDefinitionInput
object
8 properties
6 required
CreateStorableLinkFieldDefinitionInput
object
7 properties
6 required
DnaOligoLinkFieldDefinition
object
A schema field definition for linking to DNA Oligos.
14 properties
SchemaFieldDefinitionUnpaginatedList
object
1 property
ObjectRef
object
2 properties
TextValue
object
A type that represents text (string) values.
2 properties
MixtureSchemaRef
object
2 properties
UnitRef
object
2 properties
AaSequenceLinkFieldDefinition
object
A schema field definition for linking to AA sequences.
14 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Benchling publishes across the network.
