Retrieve Saved Queries
get
/HSDataService-web/api/3.2.0/savedqueries
This endpoint supports the retrieval of Saved Queries for the Logged in User.It returns Saved Query information like Description, Context, Privacy and other Saved Query information.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
- limit
-
Type:
integer
(int32
)Number of rows to return- offset
Type:integer
(int32
)Row number to start from
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Body
Model for paginated collections of data.
Root Schema : PageableCollection
Type:
object
Model for paginated collections of data.
- count
-
Type:
integer
(int64
)Number of objects in the 'items' collection. - hasMore
-
Type:
boolean
Default Value:false
A boolean indicating if more pages are available. - items
-
Type:
array
itemsA collection of paged items. - links
-
Type:
array
linksA collection of links containing hrefs to the current, next, and previous pages as applicable. - resourceType
-
Type:
string
Identify the resource type
Nested Schema : items
Nested Schema : links
Nested Schema : Serializable
Type:
object
400 Response
Invalid parameters supplied
404 Response
Query(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/savedqueries
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "SavedQueries", "items": [ { "queryId": 10000000000001, "queryName": "Clinical Saved Query", "contextFlag": "PATIENT", "privacy": "PRIVATE", "createdDate": "09/15/2016", "ownedBy": "tester" }, { "queryId": 10000000000009, "queryName": "Subject Race Query", "contextFlag": "SUBJECT", "privacy": "PRIVATE", "createdDate": "09/15/2016", "ownedBy": "tester" }, { "queryId": 10000000000017, "queryName": "Specimen Patients Query", "contextFlag": "PATIENT", "privacy": "PRIVATE", "createdDate": "09/15/2016", "ownedBy": "tester" }, { "queryId": 10000000000027, "queryName": "Specimen_subjects_query", "contextFlag": "SUBJECT", "privacy": "PRIVATE", "createdDate": "09/15/2016", "ownedBy": "tester" }, { "queryId": 10000000001005, "queryName": "prediction", "contextFlag": "PATIENT", "privacy": "PRIVATE", "createdDate": "09/28/2016", "ownedBy": "tester" } ], "count": 5, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/savedqueries?limit=5" }, { "rel": "next", "href": "http://localhost:7001/HSDataService-web/api/3.2.0/savedqueries?offset=5&limit=5" } ] }