BEbenchling
dnaSequences

Create or update a registered DNA sequence

Create or update a registered DNA sequence.

Schema field links can be populated using entity registry IDs or API IDs. In the value field of the Field resource, the object {"entityRegistryId": ENTITY_REGISTRY_ID} may be provided instead of the API ID if desired (see example value).

patch/dna-sequences/{entity_registry_id}:upsert

Request

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

Path parameters

entity_registry_idstring required

Request body

archiveRecordArchiveRecordSet

Currently, we only support setting a null value for archiveRecord, which unarchives the item

fieldsFieldsWithResolution
namestring required

Name of the DNA sequence.

registryIdstring required
schemaIdstring required

ID of the DNA sequence's schema.

aliasesstring[]

Aliases to add to the DNA sequence

authorIdsstring[]

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

basesstring required

Base pairs for the DNA sequence.

customFieldsCustomFields
folderIdstring

ID of the folder containing the DNA sequence.

isCircularboolean required

Whether the DNA sequence is circular or linear.

Response

OK

aliasesstring[]
apiURLstring uri

The canonical url of the DNA Sequence in the API.

basesstring
createdAtstring date-time
customFieldsCustomFields
dnaAlignmentIdsstring[]

API IDs of Nucleotide Alignments involving the RNA sequence

entityRegistryIdstring nullable
fieldsFields
folderIdstring nullable
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.