BEbenchling
DNA Oligo Schema

Update DnaOligoSchema

Update DnaOligoSchema.

patch/api/v3/dna-oligo-schema/{dna_oligo_schema_id}

Request

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

Path parameters

dna_oligo_schema_idstring required

ID of the DnaOligoSchema.

Headers

EARLY-ACCESSstring

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

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

availableRegistrationNamingOptionsUpdateDnaOligoSchemaInputAvailableRegistrationNamingOptionsItems[]
descriptionstring

Updated description. When provided, must be at most 1000 characters.

displayNamestring

Deprecated. Use name instead.

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

Updated icon displayed in the UI for entities registered from this schema. Optional; when omitted, the existing value is unchanged.

includeRegistryIdInChipsboolean
isContainableboolean
itemIdPrefixstring

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

namestring

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

showResiduesboolean

Updated setting for whether DNA residues are displayed in the UI. Optional; when omitted, the existing value is unchanged.

systemNamestring

Updated SQL identifier for the warehouse table name. When provided, 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. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

useRegistryIdForItemDisplayLabelboolean

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
availableRegistrationNamingOptionsDnaOligoSchemaAvailableRegistrationNamingOptionsItems[]
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' | 'PRIMER_PAIR' | '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 DNA residues are displayed in the UI.

systemNamestring
useRegistryIdForItemDisplayLabelboolean
validationRulesstring uri

Changes

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