Jump to

• Request
• Response
• Examples

Retrieve Clinical Specimen Metadata for a Specimen Identifier

get

/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/{id}/metadata

This endpoint supports the retrieval of Patient/Subject Clinical Specimen Metadata for a Clinical Specimen Row ID. It returns Clinical Specimen Metadata information like Specimen Number, Specimen Vendor Number and other metadata associated information.

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

http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2/metadata?limit=2&offset=2

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "SpecimenMetadata",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "871045"
      },
      "metadata": {
        "attrName": "ATTR_13",
        "attrDesc": "ATTRIBUTE_DESC_13",
        "strValue": "ATTR_13_VAL_2",
        "strValueUpper": "ATTR_13_VAL_2"
      },
      "specimenReference": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2",
        "display": "HG0002(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG0002"
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "1075613"
      },
      "metadata": {
        "attrName": "ATTR_16",
        "attrDesc": "ATTRIBUTE_DESC_16",
        "strValue": "ATTR_16_VAL_2",
        "strValueUpper": "ATTR_16_VAL_2"
      },
      "specimenReference": {
        "reference": "/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2",
        "display": "HG0002(vendor2)"
      },
      "specimenVendorNumber": "vendor2",
      "accessionIdentifier": "HG0002"
    }
  ],
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2/metadata?limit=2&offset=2"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2/metadata?offset=4&limit=2"
    },
    {
      "rel": "prev",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/2/metadata?offset=0&limit=2"
    }
  ]
}

Back to Top