Jump to

• Request
• Response
• Examples

Retrieve Saved Queries

get

/ohfapi/cg/v3.3/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(optional): integer(int32)
  Number of rows to return
• offset(optional): integer(int32)
  Row number to start from

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollection

Type: object

Model for paginated collections of data.

Show Source

• count(optional): integer(int64)
  Number of objects in the 'items' collection.
• hasMore(optional): boolean
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  A collection of links containing hrefs to the current, next, and previous pages as applicable.
• resourceType(optional): string
  Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Serializable"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Serializable

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Serializable"
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Nested Schema : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Query(s) not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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:7010/ohfapi/cg/v3.3/savedqueries?limit=5"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/savedqueries?offset=5&limit=5"
    }
  ]
}

Back to Top