rnaSequences

Create an RNA sequence

Create an RNA sequence

post/rna-sequences

Request

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

Request body

aliasesstring[]

Aliases to add to the RNA sequence

authorIdsstring[]

IDs of users to set as the RNA sequence's authors.

basesstring

Base pairs for the RNA sequence.

customFieldsCustomFields
fieldsFields
folderIdstring

ID of the folder containing the entity. Can be left empty when registryId is present.

helmstring

Representation of the RNA sequence in HELM syntax, including any chemical modifications

isCircularboolean

Whether the RNA sequence is circular or linear. RNA sequences can only be linear

namestring

Name of the RNA sequence.

schemaIdstring

ID of the RNA sequence's schema.

customNotationstring

Representation of the sequence or oligo in the custom notation specified by customNotationId

customNotationIdstring

ID of the notation used to interpret the string provided in the customNotation field

entityRegistryIdstring

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

namingStrategy'NEW_IDS' | 'IDS_FROM_NAMES' | 'DELETE_NAMES' | 'SET_FROM_NAME_PARTS' | 'REPLACE_NAMES_FROM_PARTS' | 'KEEP_NAMES' | 'REPLACE_ID_AND_NAME_FROM_PARTS'

Specifies the behavior for automatically generated names when registering an entity.

  • NEW_IDS: Generate new registry IDs
  • IDS_FROM_NAMES: Generate registry IDs based on entity names
  • DELETE_NAMES: Generate new registry IDs and replace name with registry ID
  • SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias
  • REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template
  • KEEP_NAMES: Keep existing entity names as registry IDs
  • REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template
registryIdstring

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the /registries endpoint

Required in order for entities to be created directly in the registry.

Response

Created

aliasesstring[]
alignmentIdsstring[]

API IDs of Nucleotide Alignments involving the RNA sequence

apiURLstring uri

The canonical url of the RNA Sequence in the API.

basesstring
createdAtstring date-time
customFieldsCustomFields
customNotationstring nullable

Representation of the RNA Sequence in the custom notation specified in the request. Null if no notation was specified.

customNotationNamestring nullable

Name of the custom notation specified in the request. Null if no notation was specified.

entityRegistryIdstring nullable
fieldsFields
folderIdstring nullable
helmstring nullable

Representation of the RNA Sequence in HELM syntax, including any chemical modifications.

idstring
isCircularboolean
lengthinteger
modifiedAtstring date-time
namestring
registryIdstring nullable
urlstring

The path of the web URL, omitting the tenant domain

webURLstring

Changes

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