Get ProteinVersion by ID

Beta

GET

https://{tenant_name}.benchling.com/api/v3/protein-version/:protein_version_id

GET

/api/v3/protein-version/:protein_version_id

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

{
  "__typename": "__typename",
  "chains": [
    {
      "__typename": "__typename",
      "chainPositions": [
        {}
      ],
      "domains": [
        {}
      ],
      "label": "label",
      "type": "HEAVY"
    }
  ],
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "domains": [
    {
      "__typename": "__typename",
      "domainPositions": [
        {}
      ],
      "label": "label",
      "type": "VL"
    }
  ],
  "format": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "name": "name",
  "outOfSync": true,
  "outOfSyncReason": "outOfSyncReason",
  "parent": {
    "__typename": "__typename",
    "id": "id"
  },
  "protein": {
    "__typename": "__typename",
    "id": "id"
  }
}

Get a single ProteinVersion by ID.

Authentication

AuthorizationBearer

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

Path parameters

protein_version_idstringRequired

ID of the ProteinVersion.

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

chainslist of objectsOptional

The chains and associated amino acid sequences on the protein.

createdAtstringOptional

DateTime this version was created.

creatorobjectOptional

domainslist of objectsOptional

The domains and associated amino acid sequences on the protein.

formatobjectOptional

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

idstringOptional

ID of the protein version.

namestringOptional

Name of the protein version.

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.

parentobject or nullOptional

The parent version of the protein.

proteinobjectOptional

The protein that owns this version.

Errors

400

Protein Version Get Request Bad Request Error

403

Protein Version Get Request Forbidden Error

404

Protein Version Get Request Not Found Error

429

Protein Version Get Request Too Many Requests Error

500

Protein Version Get Request Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors