Query Data (View) API

Used to get data from Table View.

Method	POST
Endpoint	https://{{host}}/api/public/views/{{viewName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}}
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
App Access	Read access to the Data Table from the Data Definition in DaaS. For more information, see app assignment for accessing the data in a table and Data as a Service articles.

Path Parameters

PARAMETER	DESCRIPTION
host	Environment URL, for example, https://bots.kore.ai
viewName	The table view from which to fetch data.
sys_limit	The maximum number of records to be fetched.
sys_offset	The number of records to be skipped from the beginning of the results dataset.

Sample Request

curl -X POST 'https://{{host}}/api/public/views/{{viewName}}/query?sys_limit=4&sys_offset=0' \
  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
  -H 'content-type: application/json' \
  -d '{
      "query":{
    "expressions": [
            {"field": "firstName", "operand": "=", "value": "Jane"},
        {"field": "lastName", "operand": "=", "value": "Doe"}
        ],
        "operator": "or"
       }
}'

Body Parameters

PARAMETER	DESCRIPTION
query	Filter criteria identifying the rows to be fetched "query":{ "expressions": [ {"field": "<col1_name>", "operand": "=/!=/</>", "value": "<value1>"}, {"field": "<col2_name>", "operand": "=/!=/</>", "value": "<value2>"} ], "operator": "and/or" }

Sample Response

{
    "metaInfo": [
        {
            "name": "gender",
            "type": "string"
        },
        {
            "name": "lastName",
            "type": "string"
        }
    ],
    "queryResult": [
        {
            "age": male,
            "last_name":tony,
        }
    ]
}