BEbenchling
aaSequences

Create an AA sequence

Create an AA sequence

post/aa-sequences

Request

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

Request body

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
fieldsFields
folderIdstring

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

namestring required

Name of the AA sequence. Cannot be an empty string.

schemaIdstring

ID of the AA sequence's schema.

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[]

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.