{"id":23652,"date":"2020-07-03T15:22:18","date_gmt":"2020-07-03T14:22:18","guid":{"rendered":"https:\/\/developer.kore.ai\/v8-0\/?p=23652"},"modified":"2021-03-25T12:35:45","modified_gmt":"2021-03-25T12:35:45","slug":"query-data-table-api","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v8-0\/docs\/bots\/api-guide\/query-data-table-api\/","title":{"rendered":"Query Data (Table) API"},"content":{"rendered":"
\r\n\t
\r\n\t\t
\r\n\t\t\t

Used to get data from Data Table.<\/p>\n

To use this API, the app needs to be given Read access to the Data Table from the Data Definition in DaaS (see here for details<\/a>)<\/p>\n

POST<\/b> https:\/\/{{host}}\/api\/public\/tables\/{{tableName}}\/query?sys_limit={{limit_value}}&sys_offset={{offset_value}}<\/code><\/span><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n

<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Query Parameters<\/span><\/h3>\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
host<\/span><\/td>\nEnvironment URL, for example, https:\/\/bots.kore.ai<\/code><\/span>
\n<\/span><\/td>\n<\/tr>\n
tableName<\/span><\/td>\nName of the Table to fetch data<\/span><\/td>\n<\/tr>\n
sys_limit<\/td>\nThe maximum number of records to be fetched.
\nBy default this is set to 10 and the maximum allowed is 100.<\/span><\/td>\n<\/tr>\n
sys_offset<\/td>\nThe number of records to be skipped from the beginning of the results dataset.<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t

Body Parameters<\/span><\/h3>\n\n\n\n\n\n
Parameter<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
query<\/td>\nFilter criteria identifying the rows to be fetched<\/p>\n
\u00a0\"query\":{\r\n\t\"expressions\": [\r\n\t   {\"field\": \"<col1_name>\", \"operand\": \"=\/!=\/<\/>\", \"value\": \"<value1>\"},\r\n\t   {\"field\": \"<col2_name>\", \"operand\": \"=\/!=\/<\/>\", \"value\": \"<value2>\"}\r\n\t],\r\n\t\"operator\": \"and\/or\"\r\n\t   }<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Authorization<\/span><\/h3>\n
Invoke the API with JWT in the header with the following syntax:<\/p>\n
auth: {{JWT}}<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Response content type<\/span><\/h3>\n
application\/json<\/code><\/p>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Request<\/span><\/h3>\n
curl -X POST \\\r\n  http:\/\/{{host}}\/api\/public\/tables\/{{tableName}}\/query?sys_limit=4&sys_offset=0 \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}<\/em>' \\\r\n  -H 'content-type: application\/json' \\\r\n  -d '{\r\n      \"query\":{\r\n \t\"expressions\": [\r\n        \t{\"field\": \"firstName\", \"operand\": \"=\", \"value\": \"Jane\"},\r\n\t\t{\"field\": \"lastName\", \"operand\": \"=\", \"value\": \"Doe\"}\r\n\t\t],\r\n\t\t\"operator\": \"or\"\r\n\t   }\r\n}'<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div>\r\n\t
\r\n\t\t
\r\n\t\t\t
Sample Response<\/span><\/h3>\n
{\r\n    \"metaInfo\": [\r\n        {\r\n            \"name\": \"gender\",\r\n            \"type\": \"string\"\r\n        },\r\n        {\r\n            \"name\": \"lastName\",\r\n            \"type\": \"string\"\r\n        }\r\n    ],\r\n    \"queryResult\": [\r\n        {\r\n            \"age\": male,\r\n            \"last_name\":tony,\r\n        }\r\n    ]\r\n}\r\n<\/pre>\n\r\n\t\t<\/div>\r\n\t<\/div>\r\n
<\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/section>\n","protected":false},"excerpt":{"rendered":"Used to get data from Data Table. To use this API, the app needs to be given Read access to the Data Table from the Data Definition in DaaS (see here for details) POST https:\/\/{{host}}\/api\/public\/tables\/{{tableName}}\/query?sys_limit={{limit_value}}&sys_offset={{offset_value}} Query Parameters Parameter Description host Environment URL, for example, https:\/\/bots.kore.ai tableName Name of the Table to fetch data sys_limit The...","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-23652","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/23652","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/comments?post=23652"}],"version-history":[{"count":3,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/23652\/revisions"}],"predecessor-version":[{"id":24610,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/posts\/23652\/revisions\/24610"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/media?parent=23652"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/categories?post=23652"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v8-0\/wp-json\/wp\/v2\/tags?post=23652"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}