Retrieve Subject Clinical Specimen Queries Status
get
/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries
This endpoint supports the retrieval of Subject Clinical Specimen Queries Status.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
- apiContext
-
Type:
string
Required:true
Patient/Subject API context
Query Parameters
- limit
-
Type:
integer
(int32
)Pagination query params: ?limit=2&offset=0- offset
Type:integer
(int32
)Pagination query params: ?limit=2&offset=0
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Root Schema : APIQueryStatus
Type:
object
- cohortQueryName
-
Type:
string
- createdOnDate
-
Type:
string
(date-time
) - executeAsync
-
Type:
boolean
Default Value:false
- minRetentionPeriodDays
-
Type:
integer
(int64
)Minimum Value:0
- queryCriteria
-
Type:
object
OracleDBQueryDSContains all the Query Criteria - queryExecutionStatus
-
Type:
object
QueryExecutionStatus - queryId
-
Type:
integer
(int64
) - retentionDate
-
Type:
string
(date-time
)
Nested Schema : OracleDBQueryDS
Type:
object
Contains all the Query Criteria
- allCriteriaList
-
Type:
array
allCriteriaListRequired: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 : QueryExecutionStatus
Type:
object
- error
-
Type:
object
QueryJobError - links
-
Type:
array
linksA collection of links containing hrefs to query status and results - queryId
-
Type:
integer
(int64
) - status
-
Type:
string
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
Nested Schema : criteria
Nested Schema : QueryJobError
Type:
object
- errorCode
-
Type:
string
- errorMessage
-
Type:
string
400 Response
Invalid request parameters
404 Response
Query status not found
Examples
The following example submits a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries
Example of Response Body
The following example shows the response returned in JSON format.
{ "items": [ { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1066, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1066" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1066/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1065, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1065" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1065/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1034, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1034" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1034/data" } ] } }, { "createdOnDate": "02/10/2017", "retentionDate": "02/15/2017", "queryId": 1033, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1033" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1033/data" } ] } }, { "createdOnDate": "02/15/2017", "retentionDate": "02/20/2017", "queryId": 1005, "queryExecutionStatus": { "status": "DONE", "links": [ { "rel": "status", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1005" }, { "rel": "result", "href": "/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries/1005/data" } ] } } ], "count": 5, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries?limit=5" }, { "rel": "next", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/clinicalspecimens/queries?offset=5&limit=5" } ] }