Get Protein by ID

GET

https://{tenant_name}.benchling.com/api/v3/protein/:protein_id

GET

/api/v3/protein/:protein_id

curl https://{tenant_name}.benchling.com/api/v3/protein/protein_id \
     -H "Authorization: Bearer <token>"

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "chains": [
    {
      "__typename": "__typename",
      "chainPositions": [
        {}
      ],
      "domains": [
        {}
      ],
      "label": "label",
      "type": "HEAVY"
    }
  ],
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "domains": [
    {
      "__typename": "__typename",
      "domainPositions": [
        {}
      ],
      "label": "label",
      "type": "VL"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "format": {
    "__typename": "__typename",
    "id": "id"
  },
  "fullHistory": "fullHistory",
  "history": "history",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "outOfSync": true,
  "outOfSyncReason": "outOfSyncReason",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single Protein by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

protein_idstringRequired

ID of the Protein.

Query parameters

returningstringOptional

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

omitstringOptional

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

Response

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobjectOptional

schemaFieldslist of objects or nullOptional

Values for schema-defined fields on this protein.

aliaseslist of strings or nullOptional

Array of aliases

archiveReasonstring or nullOptional

archivedbooleanOptional

chainslist of objectsOptional

The chains and associated amino acid sequences on the protein.

createdAtstringOptional

DateTime the protein was created.

customFieldslist of objects or nullOptional

Custom fields set on the protein.

domainslist of objectsOptional

The domains and associated amino acid sequences on the protein.

entityRegistryIdstring or nullOptional

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.

folderobject or nullOptional

formatobjectOptional

The protein format that defines the structure (domains, chains, interactions) for the protein.

fullHistorystringOptionalformat: "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).

historystringOptionalformat: "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.

idstringOptional

ID of the protein.

modifiedAtstringOptional

DateTime the protein was last modified.

namestringOptional

Name of the item.

outOfSyncbooleanOptional

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

outOfSyncReasonstring or nullOptional

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

projectobject or nullOptional

registrationOriginobject or nullOptional

Provenance of this item’s registration — where and when it was registered. Null if unregistered.

registryobject or nullOptional

The Registry this item belongs to, if registered. Null if unregistered.

schemaobjectOptional

Use typedSchema instead, which returns the per-type schema.

typedSchemaobjectOptional

Schema reference for this protein. Callers can retrieve the schema separately when they need its field definitions.

Errors

400

Protein Get Request Bad Request Error

403

Protein Get Request Forbidden Error

404

Protein Get Request Not Found Error

429

Protein Get Request Too Many Requests Error

500

Protein Get Request Internal Server Error