Jump to

• Request
• Response
• Examples

Retrieve Clinical Specimen Alias for a Specimen Identifier

get

/ohfapi/cg/v3.3/{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: string
  Pattern: subjectapi|patientapi

  Patient/Subject API context
• id: integer(int64)
  Minimum Value: 0

  Patient/Subject Clinical Specimen Row ID

Query Parameters

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

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollection

Type: object

Model for paginated collections of data.

Show Source

• count(optional): integer(int64)
  Number of objects in the 'items' collection.
• hasMore(optional): boolean
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  A collection of links containing hrefs to the current, next, and previous pages as applicable.
• resourceType(optional): string
  Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Serializable"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Serializable

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Serializable"
    }
}

Nested Schema : links

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

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

Nested Schema : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Clinical specimen or clinical specimen metadata not found

Back to Top

Examples

The following example submits a GET request.

API URL ??? Patient Context

http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1010"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/1010/aliases"
    }
  ]
}

API URL ??? Subject Context

http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/1035"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:post/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/1035/aliases"
    }
  ]
}

Back to Top