BEbenchling
RNA Oligo Schema

Create RnaOligoSchema

Create RnaOligoSchema.

post/api/v3/rna-oligo-schema

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

availableRegistrationNamingOptionsCreateRnaOligoSchemaInputAvailableRegistrationNamingOptionsItems[]

Naming strategies allowed when registering entities of this schema. Optional; when omitted, defaults to the organization's enabled labeling strategies, then fieldset configuration is applied.

descriptionstring required

A human-readable description of the schema. At most 1000 characters.

displayNamestring

Deprecated. Use name instead.

fieldsetsstring[]

API IDs of fieldsets to apply to the schema at creation. Optional. Fieldset-provided fields and configuration are merged into the schema.

iconId'BASIC_FOLDER_ITEM' | 'LINEAR' | 'OLIGO' | 'OLIGO_V2' | 'SEQUENCE'

Icon displayed in the UI for entities registered from this schema. Optional; when omitted, defaults to OLIGO_V2.

includeRegistryIdInChipsboolean

Whether registry IDs appear in UI chips for entities of this schema. Optional; when omitted, defaults to false.

isContainableboolean

Whether entities of this schema can be placed in inventory containers. Optional; when omitted, defaults to false.

itemIdPrefixstring required

Prefix used for registry IDs (entityRegistryId) of entities registered from this schema. Required when no prefix-providing fieldset is applied in fieldsets. When set directly, must be unique within the organization after normalization. An applied fieldset that provides a prefix takes precedence and this value is not used for prefix-uniqueness validation.

namestring

The user-facing name of the schema. Must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

organizationIdstring required

The API ID of the organization this schema belongs to. The organization must exist and be accessible to the caller.

showResiduesboolean required

Whether RNA residues are displayed in the UI for entities registered from this schema.

systemNamestring

The SQL identifier used as the warehouse table name. If not provided, one is auto-generated from the display name. Must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization.

useRegistryIdForItemDisplayLabelboolean

Whether the registry ID is used as the display label for registered entities. Optional; when omitted, defaults to false.

Response

Created

__typenamestring
archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsRnaOligoSchemaAvailableRegistrationNamingOptionsItems[]
containableType'NONE' | 'ENTITY' | 'BATCH'
createdAtstring datetime
descriptionstring
fieldDefinitionsstring uri

Field definitions configured on this schema.

fieldsetsstring uri
iconId'BASIC_FOLDER_ITEM' | 'LINEAR' | 'OLIGO' | 'OLIGO_V2' | 'SEQUENCE'

Icon displayed in the UI for entities registered from this schema.

idstring
includeRegistryIdInChipsboolean
itemIdPrefixstring

Prefix used for registry IDs (entityRegistryId) of entities registered from this schema.

modifiedAtstring datetime
namestring
showResiduesboolean

Controls whether RNA residues are displayed in the UI.

systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.