Protein

Create Protein

Create Protein.

post/api/v3/protein

Request

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

Request body

aliasesstring[]

Array of aliases

authorIdsstring[]
customFieldsobject

Custom fields set on the protein.

entityRegistryIdstring

Registry ID to assign to the entity. If one is specified, the labeling_strategy must be unspecified.

folderIdstring required
namestring required

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 one is specified, the entity_registry_id must be unspecified.

registryIdstring nullable

A not null value means the entity should be registered. If not null, the value must match the registry of the item's schema.

schemaFieldsobject

Values for schema-defined fields on this protein.

schemaIdstring required

The ID of the protein schema to create the protein in. The schema's format defines required domain and chain labels.

studyIdsstring[]

Study IDS to associate with the item.

Response

Created

__typenamestring
aliasesstring[] nullable

Array of aliases

archiveReasonstring nullable
archivedboolean
createdAtstring datetime

DateTime the protein 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.

fullHistorystring uri

fullHistory is a superset of history that also returns inactive versions that are not part of the current version history. Versions are returned in chronological order (oldest first).

historystring uri

Only the currently active version lineage, in chronological order (oldest first).

If a change was made and then undone by resetting to an earlier version, the version recording that change is not relevant to the current state of the entity, so it is not included in this listing.

idstring

ID of the protein.

modifiedAtstring datetime

DateTime the protein was last modified.

namestring

Name of the item.

outOfSyncboolean

Indicates if constituent domain or chain entities have changed since the protein was last updated.

outOfSyncReasonstring nullable

Any additional information about why the protein is out of sync.

authorsstring uri nullable

Changes

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