REST API for Oracle Healthcare Translational Research

Retrieve Proteins for a Gene Identifier

get

/HSDataService-web/api/3.2.0/genes/{id}/proteins

This endpoint supports the retrieval of Proteins for a Gene Row ID passed. It returns Protein information like Protein Identifier, Name, Accession, Ensembl Version, Protein References and other Protein associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

gene row ID

Query Parameters

limit: Type: integer (int32)

Number of rows to return
offset: Type: integer (int32)

Row number to start from

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionGeneProtein

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object GeneProtein

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : GeneProtein

Type: object

Properties

accession: Type: string

Accession Identifier. For ex.,'P01308; Q5EEX2;'
ensemblVersion: Type: string

Ensembl Version. For ex.,GRCH37.75
geneReference: Type: object LinkedReference
proteinId: Type: integer (int64)

Protein Identifier
proteinName: Type: string

Name of Protein. For ex.,e.g. INS_HUMAN
proteinReferences: Type: array proteinReferences

List of Gene References

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : proteinReferences

Type: array

List of Gene References

Items

Type: object GeneReference

Nested Schema : GeneReference

Type: object

Properties

database: Type: string

Database Name. For ex.,dbSNP_142
dnaReferenceVersion: Type: string

Version Label. For ex.,SIFT_VER2_75
geneRef: Type: object LinkedReference
identifier: Type: object OdbIdentifier

Identifier assigned by a given system
referenceId: Type: string

Reference ID to External Database. For ex.,rs13079411

Nested Schema : OdbIdentifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

400 Response

Invalid parameters supplied

404 Response

Gene protein(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/proteins

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "Proteins",
  "items": [
    {
      "proteinId": 78371,
      "proteinName": "EGFR_HUMAN",
      "accession": "P00533; O00688; O00732; P06268; Q14225; Q68GS5; Q92795; Q9BZS2; Q9GZX1; Q9H2C9; Q9H3C9; Q9UMD7; Q9UMD8; Q9UMG5;",
      "ensemblVersion": "GRCH37.75",
      "proteinReferences": [
        {
          "referenceId": "ENSP00000275493",
          "database": "Ensembl"
        },
        {
          "referenceId": "X00588",
          "database": "EMBL"
        },
        {
          "referenceId": "U95089",
          "database": "EMBL"
        },
        {
          "referenceId": "U48722",
          "database": "EMBL"
        }  "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/proteins"
    }
  ]
}