Retrieve Subjects Count
post
/ohfapi/cg/v3.3/subjectapi/subjects/queries/count
This endpoint supports the retrieval of Count of Subjects by Query Name or Criteria.
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
Root Schema : schema
Type:
integer
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/count
Example of Request Body
The following example shows the request sent in JSON format.
{ "queryCriteria" : { "allCriteriaList" : [ { "type" : "DiagnosisCriteria", "diagnosisCodeList": ["S280","M518","C9000","C9001","C900"] }, { "type":"SequenceVariantsCriteria", "exclude":false, "radioOptionMode":"VARS_IN_GEN_REGION", "genomicPosition" : "CHR1:1,200,000-1,900,000", "genomicPositionAlignment" : "GRCh37", "variantTypesList":[ { "variantType":"deletion" } ] }, { "type" : "HistoryCriteria", "historyCodeList": ["9822","1937","1"] } ] } }
Example of Response Body
The following example shows the response returned in JSON format.
3