BEbenchling
aaSequences

Create or update a registered AA sequence.

Create or update a registered AA 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/aa-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 AA sequence.

registryIdstring required
schemaIdstring required

ID of the AA sequence's schema.

entityRegistryIdstring required

Registry ID of the entity in Benchling.

aliasesstring[]

Aliases to add to the AA sequence

aminoAcidsstring required

Amino acids for the AA sequence.

authorIdsstring[]

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

customFieldsCustomFields
folderIdstring

ID of the folder containing the AA sequence.

Response

OK

aliasesstring[]

Array of aliases

aminoAcidsstring

Amino acids of the AA sequence.

apiURLstring uri

The canonical url of the AA Sequence in the API.

createdAtstring date-time

DateTime the AA sequence was created.

customFieldsCustomFields
entityRegistryIdstring nullable

Registry ID of the AA sequence if registered.

fieldsFields
folderIdstring nullable

ID of the folder that contains the AA sequence.

idstring

ID of the AA sequence.

lengthinteger

Number of amino acids in the AA sequence.

modifiedAtstring date-time

DateTime the AA sequence was last modified.

namestring

Name of the AA sequence.

registryIdstring nullable

Registry the AA sequence is registered in.

urlstring

The path of the web URL, omitting the tenant domain

webURLstring uri

URL of the AA sequence.

Changes

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