Jump to

• Request
• Response
• Examples

Retrieve Clinical Specimen Query Results for a Query Identifier

get

/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/queries/{id}/data

This end point supports the retrieval of Clinical Specimen Identifiers for a Query Identifier.

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

  Query 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 : SpecimenId

Type: object

Show Source

• specimenId(optional): integer(int64)
  Specimen Identifier

{
    "type":"object",
    "properties":{
        "specimenId":{
            "type":"integer",
            "format":"int64",
            "description":"Specimen Identifier"
        }
    }
}

400 Response

Invalid request parameters

404 Response

Query not found

Back to Top

Examples

The following example submits a GET request.

API URL ??? Patient or Subject Context

http://localhost:7010/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/queries/999/data

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "specimenId": 161768
    },
    {
      "specimenId": 205871
    },
    {
      "specimenId": 225868
    },
    {
      "specimenId": 246758
    },
    {
      "specimenId": 264035
    },
    {
      "specimenId": 6979809
    }
  ],
  "count": 6,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/999/data"
    }
  ]
}

API URL ??? Subject Context

http://localhost:7010/ohfapi/cg/v3.3/apiContext}/clinicalspecimens/queries/1002/data

Example of Response Body

The following example shows the response returned in JSON format.

{
  "items": [
    {
      "specimenId": 5197
    },
    {
      "specimenId": 6140
    },
    {
      "specimenId": 132980
    },
    {
      "specimenId": 133923
    },
    {
      "specimenId": 177380
    },
    {
      "specimenId": 178323
    },
    {
      "specimenId": 197080
    },
    {
      "specimenId": 198023
    },
    {
      "specimenId": 217080
    },
    {
      "specimenId": 218023
    },
    {
      "specimenId": 234380
    },
    {
      "specimenId": 235323
    },
    {
      "specimenId": 10257440
    },
    {
      "specimenId": 10259797
    }
  ],
  "count": 14,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/1002/data"
    }
  ]
}

Back to Top