Jump to

• Request
• Response
• Examples

Retrieve Patient Clinical Specimen Query Status

get

/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/{id}

This endpoint supports the retrieval of Patient Clinical Specimen Query Status for a Query Identifier.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

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

  Query ID

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : QueryExecutionStatus

Type: object

Show Source

• error(optional): object QueryJobError
• links(optional): array links
  A collection of links containing hrefs to query status and results
• queryId(optional): integer(int64)
• status(optional): string

{
    "type":"object",
    "properties":{
        "queryId":{
            "type":"integer",
            "format":"int64"
        },
        "status":{
            "type":"string"
        },
        "error":{
            "$ref":"#/definitions/QueryJobError"
        },
        "links":{
            "type":"array",
            "example":"{rel: 'status',href: '/patientapi/patients/queries/{id}'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to query status and results",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : QueryJobError

Type: object

Show Source

• errorCode(optional): string
• errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to query status and results

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'status',href: '/patientapi/patients/queries/{id}'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to query status and results",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'status',href: '/patientapi/patients/queries/{id}'}

400 Response

Invalid request parameters

404 Response

Query status not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/999

Example of Response Body

The following example shows the response returned in JSON format.

{
  "executeAsync": false,
  "minRetentionPeriodDays": 5,
  "queryCriteria": {
    "allCriteriaList": [
      {
        "type": "MedicationCriteria",
        "exclude": false,
        "medicationCodeList": [
          "1000000"
        ],
        "medicationOutcomeCodeList": [
          "1"
        ]
      },
      {
        "type": "SequenceVariantsCriteria",
        "exclude": false,
        "radioOptionMode": "VAR_IN_SELECTED_GENES",
        "geneInformation": {
          "type": "SequenceVariantsGeneDetails",
          "geneList": [
            "BID"
          ],
          "dnaVersionList": [
            2
          ],
          "dnaAlignmentList": [
            "GRCh37"
          ]
        },
        "geneRegionsList": [
          "PROMOTER"
        ],
        "polyphenSelected": false,
        "siftSelected": false,
        "fileTypeVCFSelected": true,
        "fileTypeMAFSelected": false,
        "fileTypeCGISelected": false
      }
    ]
  },
  "queryId": 999,
  "queryExecutionStatus": {
    "status": "DONE",
    "links": [
      {
        "rel": "status",
        "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/999"
      },
      {
        "rel": "result",
        "href": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/queries/999/data"
      }
    ]
  }
}

Back to Top