REST API for Oracle Healthcare Translational Research

Retrieve Count of Subject Specimens for a Query Name/Criteria

post

/HSDataService-web/api/3.2.0/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

Body Parameter

Cohort Query Name,Creation Date,Retention Date details

Root Schema : APIQueryRequest

Type: object

Properties

cohortQueryName: Type: string
createdOnDate: Type: string (date-time)
executeAsync: Type: boolean

Default Value: false
minRetentionPeriodDays: Type: integer (int64)

Minimum Value: 0
queryCriteria: Type: object OracleDBQueryDS

Contains all the Query Criteria
retentionDate: Type: string (date-time)

Nested Schema : OracleDBQueryDS

Type: object

Contains all the Query Criteria

Properties

allCriteriaList: Type: array allCriteriaList

Required: true

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

Items

Type: object criteria

Discriminator: type

Nested Schema : criteria

Type: object

Discriminator: type

Properties

exclude: Type: boolean

Default Value: false

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : /paths/~1subjectapi~1clinicalspecimens~1queries~1count/post/responses/200/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:7001/HSDataService-web/api/3.2.0/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.