BEbenchling
Protein

Create and register proteins and components

Create and register proteins and their component parts (domains, chains, and variable pairs)

post/api/v3/proteins:bulk-create-and-register-proteins-and-components

Request

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

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Request body

entryIdstring

The ID of the notebook entry into which the creation results will be embedded upon completion. If omitted, no results are written to a notebook entry.

folderIdstring required

The ID of the folder in which the new entities should be created.

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 proteins in the registry. Applies to all proteins in the request, and must be enabled on the protein schema. NEW_IDS, IDS_FROM_NAMES, SET_FROM_NAME_PARTS, and KEEP_NAMES require a name on every protein. DELETE_NAMES, REPLACE_NAMES_FROM_PARTS, and REPLACE_ID_AND_NAME_FROM_PARTS do not accept names. If omitted, REPLACE_NAMES_FROM_PARTS is used when the protein schema has a name template, and DELETE_NAMES is used otherwise. Components are not affected.

proteinSchemaIdstring required

The schema ID for the protein entity type.

Response

Job status details

pollingUristring uri required

A URL to poll for the status of the task.

taskIdstring required

Changes

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