Invoke Subject Query
post
/ohfapi/cg/v3.3/subjectapi/subjects/queries
This end point supports the retrieval of Links to Execution Status for checking Progress and to Access Results when the execution is done.
Request
Supported Media Types
- application/json
- application/xml
Cohort Query Name,Creation Date,Retention Date Details for Subject
Nested Schema : AllCriteriaList
Type:
object
Contains all the Query Criteria
Show Source
-
allCriteriaList:
array allCriteriaList
Minimum Number of Items:
1
Maximum Number of Items:2147483647
List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Nested Schema : allCriteriaList
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
2147483647
List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Show Source
-
Array of:
object criteria
Discriminator:
type
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Nested Schema : UriBuilder
Type:
object
202 Response
Query accepted
400 Response
Invalid Parameters
406 Response
Failed to accept query
Examples
The following example submits a POST request. See the Criteria Classes for this endpoint.
API URL
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/queries
Example of Request Body
The following shows an example of the request body in JSON format.
{ "queryCriteria" : { "allCriteriaList" : [ { "type" : "MedicationCriteria", "medicationCodeList": ["1000000"], "medicationOutcomeCodeList":["1"] }, { "type":"SequenceVariantsCriteria", "fileTypeVCFSelected":true, "geneInformation":{ "type":"SequenceVariantsGeneDetails", "geneList":[ "BID" ], "dnaAlignmentList":[ "GRCh37" ], "dnaVersionList":[ 2 ] } } ] } }
Example of Response Body
The following example shows the response returned in JSON format.
{ [ { "rel": "status", "href": "/ohfapi/cg/v3.3/subjectapi/subjects/queries/977" }, { "rel": "result", "href": "/ohfapi/cg/v3.3/subjectapi/subjects/queries/977/data" } ] }