Retrieve Subject Query Status for a Query Identifier
get
/ohfapi/cg/v3.3/subjectapi/subjects/queries/{id}
This end point supports the retrieval of Subject Query Status, Error Code, Error Message and other Status associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
Query ID
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : QueryExecutionStatus
Type:
Show Source
object
-
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
Nested Schema : links
Type:
array
A collection of links containing hrefs to query status and results
Show Source
Example:
{rel: 'status',href: '/patientapi/patients/queries/{id}'}
400 Response
Invalid request parameters
404 Response
Query status not found
Examples
The following example shows how to view the status of a subject query by submitting a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/queries/977
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" ] }, "polyphenSelected": false, "siftSelected": false, "fileTypeVCFSelected": true, "fileTypeMAFSelected": false, "fileTypeCGISelected": false } ] }, "queryId": 977, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/ohfapi/cg/v3.3/subjectapi/subjects/queries/977" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/subjectapi/subjects/queries/977/data" } ] } }