Retrieve Subject Clinical Specimen Using Query Criteria
post
/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries
This endpoint supports the retrieval of all specimens of the subjects identified for this query criteria. It returns Status information like Reference Links to Execution Status for checking Progress and to Access Results when the execution is done. Note: In future release this API would retrieve only the specimen which fall under the query criteria and not just all specimen of subjects identified for this criteria.
Request
Supported Media Types
- application/json
- application/xml
Body Parameter
Cohort Query Name,Creation Date,Retention Date Details for Subject
Root Schema : APIQueryRequest
Type:
object- cohortQueryName
-
Type:
string - createdOnDate
-
Type:
string(date-time) - executeAsync
-
Type:
booleanDefault Value:false - minRetentionPeriodDays
-
Type:
integer(int64)Minimum Value:0 - queryCriteria
-
Type:
objectOracleDBQueryDSContains all the Query Criteria - retentionDate
-
Type:
string(date-time)
Nested Schema : OracleDBQueryDS
Type:
objectContains all the Query Criteria
- allCriteriaList
-
Type:
arrayallCriteriaListRequired:trueMinimum Number of Items:1Maximum Number of Items:2147483647List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Nested Schema : allCriteriaList
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
2147483647List of Criteria Eg.DemographicsCriteria,MedicationCriteria,DiagnosisCriteria,SequenceVariantsCriteria,ConsentCriteria,DiagnosisCriteria,EncounterCriteria,ObservationCriteria,HistoryCriteria,ProceduresCriteria,SpecimenCriteria,StudyCriteria,MicroarrayExpressionCriteria,RNASeqExpressionCriteria,CopyNumberVariationCriteria,RelativeTimeEventsCriteria
Nested Schema : criteria
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Root Schema : /paths/~1subjectapi~1clinicalspecimens~1queries/post/responses/200/schema
Nested Schema : Link
Type:
object- params
-
Type:
objectparamsAdditional Properties Allowed: additionalProperties - rel
-
Type:
string - rels
-
Type:
arrayrels - title
-
Type:
string - type
-
Type:
string - uri
-
Type:
string(uri) - uriBuilder
-
Type:
objectUriBuilder
Nested Schema : params
Nested Schema : rels
Type:
array-
Type:
string
Nested Schema : UriBuilder
Type:
object202 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:7001/HSDataService-web/api/3.2.0subjectapi/clinicalspecimens/queries
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 Request Body
The following example shows the response returned in JSON format.
[
{
"rel": "status",
"href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1002"
},
{
"rel": "result",
"href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1002/data"
}
]