Request
This endpoint expects an object.
aliaseslist of stringsOptional
Array of aliases
allowCustomFieldDeletionbooleanOptional
When true, custom fields present on the entity but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.
annotationslist of objectsOptional
Annotations on the DNA sequence, not including translations or primers. Annotations on parts are
not included.
archiveReasonstringOptional
authorIdslist of stringsOptional
basesstringOptional
Bases of the forward strand of the DNA sequence.
customFieldsmap from strings to objectsOptional
Custom fields set on the DNA sequence.
entityRegistryIdstringOptional
Registry ID to assign to the entity. When registering, specifying this value sets the registry ID of the entity. When already registered, specifying this value updates the entity’s registry ID. If set, naming_strategy must be unspecified.
isCircularbooleanOptional
Whether the sequence forms a closed loop, with the last base connecting back to the first.
namestringOptional
Name of the item.
namingStrategyenumOptional
Strategy to use for labeling the item in the registry if registering. If one is specified, the entity_registry_id must be unspecified.
partslist of objectsOptional
Part features linking regions of this sequence to other nucleotide sequences.
primerslist of objectsOptional
Primer bind features on the DNA sequence. Primers on parts are not included.
registryIdstring or nullOptional
A not null value means the entity should be registered. A null value means it should be unregistered. If not null, the value must match the registry of the item's schema.
schemaFieldsmap from strings to objectsOptional
translationslist of objectsOptional
Translation annotations present on the DNA sequence. Translations may be one region or split
across multiple regions. Translations on parts are not included.
Response
OK
authorsstring or nullOptionalformat: "uri"
creatorobject or nullOptional
schemaFieldslist of objects or nullOptional
aliaseslist of strings or nullOptional
Array of aliases
annotationsstringOptionalformat: "uri"
Annotations on the DNA sequence, not including translations or primers. Annotations on parts are
not included.
archiveReasonstring or nullOptional
basesstringOptional
Bases of the forward strand of the DNA sequence.
createdAtstring or nullOptional
customFieldslist of objectsOptional
Custom fields set on the DNA sequence.
entityRegistryIdstring or nullOptional
The registry-assigned identifier for this item (e.g. its registry ID shown in the UI),
present only once the item has been registered. Null if the item is not registered.
folderobject or nullOptional
isCircularbooleanOptional
Whether the DNA sequence is circular or linear.
modifiedAtstring or nullOptional
namestringOptional
Name of the item.
nucleotideAlignmentsstringOptionalformat: "uri"
Nucleotide alignments that use this sequence as the reference sequence. For template
alignments, this is the template sequence; for consensus alignments, this is the derived
consensus sequence.
partsstringOptionalformat: "uri"
Part features linking regions of this sequence to other nucleotide sequences.
primersstringOptionalformat: "uri"
Primer bind features on the DNA sequence. Primers on parts are not included.
projectobject or nullOptional
registrationOriginobject or nullOptional
Provenance of this item’s registration — where and when it was registered. Null if unregistered.
registryobject or nullOptional
The Registry this item belongs to, if registered. Null if unregistered.
schemaobject or nullOptional
Use typedSchema instead, which returns the per-type schema.
startIndexintegerOptional
Starting index for the sequence residues of linear DNA sequences. Implicitly 1 for other sequence types.
translationsstringOptionalformat: "uri"
Translation annotations present on the DNA sequence. Translations may be one region or split
across multiple regions. Translations on parts are not included.
typedSchemaobject or nullOptional
