BEbenchling
Protein Format

Get ProteinFormat by ID

Get a single ProteinFormat by ID.

get/api/v3/protein-format/{protein_format_id}

Request

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

Path parameters

protein_format_idstring required

ID of the ProteinFormat.

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
archiveReasonstring nullable
archivedboolean
builtInboolean

Whether this is an out-of-the-box Benchling-provided format. These formats come pre-loaded and cannot be modified or deleted by users.

createdAtstring datetime

When the protein format was created.

idstring

API identifier of the protein format. Custom formats use the abfmt_ prefix; built-in formats use builtinabfmt_.

modifiedAtstring datetime

When the protein format was last modified.

namestring

The display name of the protein format.

originalVeritasstring nullable

The VERITAS string used to create the format.

Changes

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