REST API for Oracle Healthcare Translational Research

Retrieve Clinical Specimen Alias for a Specimen Identifier

get

/HSDataService-web/api/3.2.0/{apiContext}/clinicalspecimens/{id}/aliases

This endpoint supports the retrieval of Patient/Subject Clinical Specimen Aliases for a Clinical Specimen Row ID. It returns Clinical Specimen Aliases information like Specimen Alias and its Row ID, Service Provider Identifier and reference to the Clinical Specimen details. Result includes only aliases to which user has read access.

Request

Supported Media Types

application/json
application/xml

Path Parameters

apiContext: Type: string

Required: true

Pattern: subjectapi|patientapi

Patient/Subject API context
id: Type: integer (int64)

Required: true

Patient/Subject Clinical Specimen Row ID

Query Parameters

limit: Type: integer (int32)

Pagination query params: ?limit=2&offset=0
offset: Type: integer (int32)

Pagination query params: ?limit=2&offset=0

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollection

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 Serializable

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 : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Clinical specimen or clinical specimen metadata not found

Examples

The following example submits a GET request.

API URL — Patient Context

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1010/aliases

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenAlias",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "16"
      },
      "serviceProviderIdentifier": "vcf",
      "specimenAlias": "ALIAS_SVCPRV1_CNV_dummy_01",
      "specimenAliasUpper": "ALIAS_SVCPRV1_CNV_DUMMY_01",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1010"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "/HSDataService-web/api/3.2.0/patientapi/clinicalspecimens/1010/aliases"
    }
  ]
}

API URL — Subject Context

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1035/aliases

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenAlias",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "89"
      },
      "serviceProviderIdentifier": "SVCPRV1",
      "specimenAlias": "ALIAS_SVCPRV1_TCGA-08-0375-11A-8109",
      "specimenAliasUpper": "ALIAS_SVCPRV1_TCGA-08-0375-11A-8109",
      "specimenReference": {
        "reference": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1035"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:post/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/1035/aliases"
    }
  ]
}