Get AaSequence by ID

GET

https://{tenant_name}.benchling.com/api/v3/aa-sequence/:aa_sequence_id

GET

/api/v3/aa-sequence/:aa_sequence_id

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

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "aminoAcids": "aminoAcids",
  "annotations": "annotations",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "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 AaSequence by ID.

Authentication

AuthorizationBearer

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

Path parameters

aa_sequence_idstringRequired

ID of the AaSequence.

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"

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

Array of aliases

aminoAcidsstringOptional

Amino acids of the AA sequence.

annotationsstringOptionalformat: "uri"

Annotations marking functional regions, domains, binding sites, post-translational modifications, or other features on the AA sequence.

archiveReasonstring or nullOptional

archivedbooleanOptional

createdAtstring or nullOptional

DateTime the AA sequence was created.

customFieldslist of objects or nullOptional

Custom fields set on the AA sequence.

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

Folder containing the AA sequence.

idstringOptional

ID of the AA sequence.

modifiedAtstring or nullOptional

DateTime the AA sequence was last modified.

namestringOptional

Name of the item.

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.

schemaobject or nullOptional

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

typedSchemaobject or nullOptional

Errors

400

Aa Sequence Get Request Bad Request Error

403

Aa Sequence Get Request Forbidden Error

404

Aa Sequence Get Request Not Found Error

429

Aa Sequence Get Request Too Many Requests Error

500

Aa Sequence Get Request Internal Server Error