Information Access overview

Queries

Queries are executed using a SQL-like syntax encoded in JSON with the following clauses:

select [Required] contains keys that define which elements to include from the Data Dictionary.
from [Optional] contains keys that define the sources contributing data to the operation.
where [Optional] contains keys that define a list of elements and apply filters to each element.
groupBy [Optional] contains keys that define a list of columns for grouping the data elements in the request.
sortBy [Optional] contains keys that define sorting behavior for each data element in the request.
options [Optional] contains a list of name/value pairs that allow you to further customize the query.

Example

The following example query retrieves the first 100 tuples (a finite ordered list of elements) of full name, job, organization, and hire date for employees defined as Apprentice within a particular Hyperfind instance.

{
  "select": [
    {"key": "EMP_COMMON_FULL_NAME"},
    {"key": "EMP_COMMON_PRIMARY_JOB"},
    {"key": "EMP_COMMON_PRIMARY_ORG"},
    {"key": "PEOPLE_HIRE_DATE"}],
  "from": {
    "view": "EMP",
    "employeeSet": {
      "hyperfind": {
        "id": "1"
      },
      "dateRange": {
        "symbolicPeriod": {
          "id": 5
        }
      }
    }
  },
  "where": [
    {
      "key": "EMP_COMMON_PRIMARY_JOB",
      "operator": "STARTS_WITH",
      "values": [
        "Apprentice"
      ]
    }
  ],
  "count": 100
}