AA Sequence

Update AaSequence

Update an AA sequence.

patch/api/v3/aa-sequence/{aa_sequence_id}

Request

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

Path parameters

aa_sequence_idstring required

ID of the AaSequence.

Request body

aliasesstring[]

Array of aliases

allowCustomFieldDeletionboolean

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.

aminoAcidsstring

Updates the amino acids of the AA sequence when provided. Letters A-Z only (case-insensitive). Invalid characters are rejected. There is a per-tenant limit on sequence length (50,000 characters by default). The request must also include an annotations property (use annotations: [] to clear annotations); that value replaces the sequence's full annotation set.

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.

authorIdsstring[]
customFieldsobject

Custom fields set on the AA sequence.

entityRegistryIdstring

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.

folderIdstring
namestring

Name of the item.

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

Strategy to use for labeling the item in the registry if registering. If one is specified, the entity_registry_id must be unspecified.

registryIdstring nullable

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.

schemaFieldsobject
schemaIdstring

Response

OK

__typenamestring
aliasesstring[] nullable

Array of aliases

aminoAcidsstring

Amino acids of the AA sequence.

annotationsstring uri

Annotations marking functional regions, domains, binding sites, post-translational modifications, or other features on the AA sequence.

archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable

DateTime the AA sequence was created.

entityRegistryIdstring nullable

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.

idstring

ID of the AA sequence.

modifiedAtstring datetime nullable

DateTime the AA sequence was last modified.

namestring

Name of the item.

authorsstring uri nullable

Changes

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