Benchling Custom Entity Schema API
Operations for CustomEntitySchema
Benchling Custom Entity 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 CustomEntitySchema. 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 14 operations across 13 paths, and defines 165 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, /api/v3.
14 operations
13 paths
165 schemas
6 GET3 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Benchling Custom Entity Schema API declares
3 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicApiKeyAuth).
It accepts HTTP basic authentication (basicClientIdSecretAuth).
It supports OAuth 2.0 (oAuth) using the clientCredentials flow.
By default, every request must be authenticated.
basicApiKeyAuth— Use issued API key for standard access to the APIbasicClientIdSecretAuth— Auth used as part of client credentials OAuth flow prior to receiving a bearer token.oAuth— OAuth2 Client Credentials flow intended for service access
Paths & Operations 14
Across 13 paths, the API surfaces 14 operations — 6 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
CustomEntitySchema 14
Operations for CustomEntitySchema
POST
/custom-entity-schema
Create CustomEntitySchema
GET
/custom-entity-schema/items
List CustomEntitySchema items
GET
/custom-entity-schema/{custom_entity_schema_id}
Get CustomEntitySchema by ID
PATCH
/custom-entity-schema/{custom_entity_schema_id}
Update CustomEntitySchema
GET
/custom-entity-schema/{custom_entity_schema_id}/field-definitions/items
List SchemaFieldDefinition items
GET
/custom-entity-schema/{custom_entity_schema_id}/fieldsets/items
List Fieldset items
POST
/custom-entity-schema/{custom_entity_schema_id}:apply-fieldset
Apply a fieldset to the schema
POST
/custom-entity-schema/{custom_entity_schema_id}:set-field-definitions
Set field definitions on the schema
POST
/custom-entity-schema:batch-create
Batch create CustomEntitySchema
PATCH
/custom-entity-schema:batch-update
Batch update CustomEntitySchema
POST
/custom-entity-schema:bulk-create
Bulk create CustomEntitySchema
PATCH
/custom-entity-schema:bulk-update
Bulk update CustomEntitySchema
GET
/tasks/custom-entity-schema/apply-fieldset/{task_id}
Poll async task status
GET
/tasks/custom-entity-schema/set-field-definitions/{task_id}
Poll async task status
Schemas 165
The contract defines 165 schemas that model the data the API accepts and returns. The most detailed are CustomEntitySchema (22 properties), UpdateCustomEntitySchemaInputWithPathParams (17 properties), Fieldset (16 properties), UpdateCustomEntitySchemaInput (16 properties). Each schema is shown below with its type and property counts.
CustomEntitySchemaRef
object
2 properties
TextNameTemplatePartConfigurationInput
object
1 property
1 required
CreateDnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
CreateDateFieldDefinitionInput
object
5 properties
4 required
ProteinFormatChainPosition
object
Defines each instance of a polypeptide chain within a ProteinFormat, specifying the chain type and its constituent domains. Each chain position has a unique re…
4 properties
UpdateIntegerFieldDefinitionInput
object
11 properties
5 required
CreateFloatFieldDefinitionInput
object
9 properties
4 required
CreateDnaOligoLinkFieldDefinitionInput
object
8 properties
6 required
AssayRequestLinkFieldDefinition
object
A schema field definition for linking to assay requests.
12 properties
UpdateEquipmentLinkFieldDefinitionInput
object
11 properties
7 required
RunSchemaRef
object
2 properties
UpdateTextFieldDefinitionInput
object
8 properties
5 required
UpdateOligoConjugateLinkFieldDefinitionInput
object
11 properties
7 required
UpdateFieldsetLinkFieldDefinitionInput
object
10 properties
7 required
EntitySchemaBaseRef
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
ResultSchemaRef
object
2 properties
EntitySchemaApplyFieldsetWarning
object
A warning raised when attempting to apply a fieldset to an entity schema.
4 properties
CustomEntityLinkFieldDefinition
object
A schema field definition for linking to custom entities.
14 properties
UpdateStorableLinkFieldDefinitionInput
object
10 properties
7 required
TranslationLinkFieldDefinition
object
A schema field definition for linking to translations (AA sequences created from RNA).
13 properties
UpdateDateFieldDefinitionInput
object
8 properties
5 required
OrganizationRef
object
2 properties
TextNameTemplatePartConfiguration
object
Configuration for a literal text name template part.
2 properties
MixtureLinkFieldDefinition
object
A schema field definition for linking to mixtures.
14 properties
CreateRnaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
ContainerNameTemplatePartInput
object
2 properties
1 required
EntitySchemaApplyFieldsetInput
object
2 properties
1 required
DropdownRef
object
2 properties
CreateCustomEntityLinkFieldDefinitionInput
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
FieldNameTemplatePartConfiguration
object
Configuration for a schema field name template part.
2 properties
UpdateCustomEntityLinkFieldDefinitionInput
object
11 properties
7 required
CreateIntegerFieldDefinitionInput
object
8 properties
4 required
ProteinFormatDomainPosition
object
Defines a domain position within a1 ProteinFormat, specifying the domain type and identity of each physical domain in the protein format. Each domain position…
4 properties
DnaOligoSchemaRef
object
2 properties
CustomEntitySchemaSetFieldDefinitionsInput
object
1 property
1 required
FieldsetUnpaginatedList
object
1 property
OligoDuplexLinkFieldDefinition
object
A schema field definition for linking to Oligo Duplexes.
14 properties
FieldNameTemplatePartConfigurationInput
object
1 property
1 required
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
AaSubElementConfigurationInput
object
1 property
1 required
ContainerNameTemplatePart
object
A part in a container name template.
3 properties
AaChainConfigurationInput
object
1 property
1 required
CreateTextFieldDefinitionInput
object
5 properties
4 required
ProteinChainNameTemplatePartConfiguration
object
Configuration for a protein chain name template part.
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
SystemCategoryConfigurationInputBase
object
UpdateOligoDuplexLinkFieldDefinitionInput
object
11 properties
7 required
SystemCategoryConfiguration
object
InternalServerError
object
6 properties
5 required
EntityNameTemplate
object
A name template for entities.
3 properties
EntityNameTemplatePart
object
A part in an entity name template.
3 properties
ContainerNameTemplateInput
object
1 property
1 required
RnaOligoLinkFieldDefinition
object
A schema field definition for linking to RNA Oligos.
14 properties
CreateEntryLinkFieldDefinitionInput
object
6 properties
5 required
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
UpdateRnaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
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
CreateEntitySchemaConstraintInput
object
1 property
UpdateAssayRunLinkFieldDefinitionInput
object
10 properties
7 required
DnaSequenceLinkFieldDefinition
object
A schema field definition for linking to DNA sequences.
14 properties
UpdateCustomEntitySchemaInputWithPathParams
object
17 properties
1 required
AntigenConfigurationInput
object
1 property
1 required
FieldsetRef
object
2 properties
ProteinFormatDomain
object
A domain in a protein format, representing the slot where an amino acid sequence can be used in an entity of this format. Domains are uniquely identified by th…
5 properties
SchemaFieldDefinitionRef
object
2 properties
CreateAntibodyLinkFieldDefinitionInput
object
8 properties
6 required
UpdateMoleculeLinkFieldDefinitionInput
object
11 properties
7 required
DnaDomainConfigurationInput
object
1 property
1 required
UpdateEntryLinkFieldDefinitionInput
object
9 properties
6 required
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
CreateLongTextFieldDefinitionInput
object
5 properties
4 required
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
DnaPairConfigurationInput
object
1 property
1 required
CreateAaSequenceLinkFieldDefinitionInput
object
8 properties
6 required
TranscriptionLinkFieldDefinition
object
A schema field definition for linking to transcriptions (RNA sequences created from DNA).
14 properties
CreateAnyEntityLinkFieldDefinitionInput
object
6 properties
5 required
AaPairConfigurationInput
object
1 property
1 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
CustomEntitySchema
object
22 properties
EntityNameTemplateInput
object
2 properties
2 required
RnaSequenceSchemaRef
object
2 properties
UpdateAssayRequestLinkFieldDefinitionInput
object
10 properties
7 required
AaDomainConfigurationInput
object
1 property
1 required
CreateDateTimeFieldDefinitionInput
object
5 properties
4 required
JsonFieldDefinition
object
A JSON field definition for storing structured JSON data.
11 properties
Fieldset
object
A tenant-defined schema interface (also known as a "Fieldset") that groups related fields to be shared across multiple schemas. Fieldsets are created and manag…
16 properties
EntityNameTemplatePartInput
object
2 properties
1 required
DateFieldDefinition
object
A date field definition for date-only values (without time).
11 properties
OligoDuplexSchemaRef
object
2 properties
RnaOligoSchemaRef
object
2 properties
ProteinDomainNameTemplatePartConfiguration
object
Configuration for a protein domain name template part.
2 properties
UpdateAaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
Constraint
object
Defines uniqueness requirements for entities within a schema. Constraints ensure that registered entities have unique values across specified fields (see field…
3 properties
ProteinFormatChain
object
A chain in a protein format, representing the slot where a polypeptide chain can be used in an entity of this format. Chains are uniquely identified by their l…
5 properties
AnyEntityLinkFieldDefinition
object
A schema field definition for linking to any entity type.
12 properties
CreateMixtureLinkFieldDefinitionInput
object
8 properties
6 required
CreateAssayRunLinkFieldDefinitionInput
object
7 properties
6 required
UpdateFloatFieldDefinitionInput
object
12 properties
5 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
UpdateBlobLinkFieldDefinitionInput
object
9 properties
6 required
UpdateBooleanFieldDefinitionInput
object
8 properties
5 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
UpdateDateTimeFieldDefinitionInput
object
8 properties
5 required
CreateOligoConjugateLinkFieldDefinitionInput
object
8 properties
6 required
CreateFieldsetLinkFieldDefinitionInput
object
7 properties
6 required
UpdateAntibodyLinkFieldDefinitionInput
object
11 properties
7 required
CreateRnaOligoLinkFieldDefinitionInput
object
8 properties
6 required
CreateCustomEntitySchemaInput
object
15 properties
3 required
CreateAssayResultLinkFieldDefinitionInput
object
7 properties
6 required
GeneralError
object
5 properties
5 required
ProteinDomainNameTemplatePartConfigurationInput
object
1 property
1 required
EquipmentSchemaRef
object
2 properties
UpdateSystemCategoryLinkFieldDefinitionInput
object
10 properties
7 required
TextFieldDefinition
object
A text field definition for short, single-line text values.
11 properties
UpdateDropdownLinkFieldDefinitionInput
object
10 properties
7 required
BaseSystemCategoryConfiguration
object
Default configuration for system categories that require no additional configuration beyond the system category identifier.
2 properties
EquipmentLinkFieldDefinition
object
A schema field definition for linking to Equipment.
14 properties
CreateAssayRequestLinkFieldDefinitionInput
object
7 properties
6 required
AssayResultLinkFieldDefinition
object
A schema field definition for linking to assay results.
13 properties
DateTimeFieldDefinition
object
A datetime field definition for date and time values with timezone support.
11 properties
EntitySchemaApplyFieldsetOutput
object
Return shape for the applyfieldset API on entity schemas.
2 properties
CreateSystemCategoryLinkFieldDefinitionInput
object
7 properties
6 required
UpdateDnaSequenceLinkFieldDefinitionInput
object
11 properties
7 required
SchemaSetFieldDefinitionsOutput
object
Return shape for the setfielddefinitions API on schemas.
2 properties
DnaSubElementConfigurationInput
object
1 property
1 required
UpdateDnaOligoLinkFieldDefinitionInput
object
11 properties
7 required
UpdateAnyEntityLinkFieldDefinitionInput
object
9 properties
6 required
OligoConjugateSchemaRef
object
2 properties
UpdateAssayResultLinkFieldDefinitionInput
object
10 properties
7 required
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
BlobLinkFieldDefinition
object
A schema field definition for linking to blobs (file attachments).
12 properties
UpdateRnaOligoLinkFieldDefinitionInput
object
11 properties
7 required
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
UpdateLongTextFieldDefinitionInput
object
8 properties
5 required
SchemaFieldDefinitionUnpaginatedList
object
1 property
ProteinChainNameTemplatePartConfigurationInput
object
1 property
1 required
DnaChainConfigurationInput
object
1 property
1 required
UpdateMixtureLinkFieldDefinitionInput
object
11 properties
7 required
MixtureSchemaRef
object
2 properties
UpdateCustomEntitySchemaInput
object
16 properties
ContainerNameTemplate
object
A name template for containers.
2 properties
UnitRef
object
2 properties
AaSequenceLinkFieldDefinition
object
A schema field definition for linking to AA sequences.
14 properties
CustomEntitySchemaPaginatedList
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Benchling 12
Other APIs Benchling publishes across the network.
Benchling AA Sequences API
Benchling Apps API
Benchling Assay Results API
Benchling Assay Runs API
Benchling Audit API
Benchling Authentication API
Benchling Blobs API
Benchling Boxes API
Benchling Codon Usage Tables API
Benchling Connect API
Benchling Containers API
Benchling Custom Entities API
#CustomEntitySchema
Where this information came from
This is an independent, third-party profile of Benchling Custom Entity Schema API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.