Retrieve Count of Subject Specimens for a Query Name/Criteria
post
/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/count
This endpoint supports the retrieval of Count of Subject Specimens based for a Query Name or Criteria provided.
Request
Supported Media Types
- application/json
- application/xml
Cohort Query Name,Creation Date,Retention Date details
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 shows how to view the specimen count of patients based on query name by submitting a POST request. See the Criteria Classes for this endpoint.
Note:
Based on the genomic information entered, patient identifiers are retrieved. Based on these patient identifiers, the specimens are retrieved.API URL
http://localhost:7010/ohfapi/cg/v3.3/subjectapi/clinicalspecimens/queries/count
Example of Request Body
The following example shows the request sent in JSON format.
{ "cohortQueryName" : "Specimen_subjects_query" }
Example of Response Body
The following example shows the response returned in JSON format.
102