BEbenchling
Protein

Get Protein by ID

Get a single Protein by ID.

get/api/v3/protein/{protein_id}

Request

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

Path parameters

protein_idstring required

ID of the Protein.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__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.