쿼리 데이터(테이블) API

데이터 테이블에서 데이터를 가져오는 데 사용됩니다.

이 API를 사용하려면 앱에 DaaS의 데이터 정의에서 데이터 테이블에 대한 읽기 액세스 권한이 부여되어야 합니다(자세한 내용은 여기 참조).

POST https://{{host}}/api/public/tables/{{tableName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}}

쿼리 매개 변수

매개 변수 설명
host 환경 URL, 예: https://bots.kore.ai
tableName 데이터를 가져올 테이블의 이름
sys_limit 가져올 최대 레코드 수입니다. 기본적으로 이 값은 10으로 설정되고 허용되는 최대값은 100입니다.
sys_offset 결과 데이터 세트의 시작 부분에서 건너뛴 레코드 수입니다.

본문 매개 변수

매개 변수 설명
query

가져올 행을 식별하는 필터 기준

 "query":{
	"expressions": [
	   {"field": "<col1_name>", "operand": "=/!=/</>", "value": "<value1>"},
	   {"field": "<col2_name>", "operand": "=/!=/</>", "value": "<value2>"}
	],
	"operator": "and/or"
	   }

권한 부여

다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}

콘텐츠 유형 응답

application/json

샘플 요청

curl -X POST \
  http://{{host}}/api/public/tables/{{tableName}}/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"
	   }
}'

샘플 응답

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

Query Data (Table) API

データテーブルからデータを手に入れる際に使用。

このAPIを使用するためには、DaaSにおけるデータ定義からデータテーブルへの読み込みアクセス権をアプリに与える必要があります（詳細についてはこちらをご参照ください）。

POST https://{{host}}/api/public/tables/{{tableName}}/query?sys_limit={{limit_value}}&sys_offset={{offset_value}}

クエリパラメータ

パラメータ 説明
host 環境URL、例：https://bots.kore.ai
tableName データを取得するテーブルの名前
sys_limit 取得する記録の最大数。デフォルトでは10に設定されており、最大許容値は100です。
sys_offset 結果データセットの先頭からスキップする記録の数。

本文パラメータ

パラメータ 説明
query

取得される行を特定するフィルター基準

 "query":{
  "expressions": [
     {"field": "<col1_name>", "operand": "=/!=/</>", "value": "<value1>"},
     {"field": "<col2_name>", "operand": "=/!=/</>", "value": "<value2>"}
  ],
  "operator": "and/or"
     }

認証

ヘッダー内のJWTを含むAPIを、以下の構文で呼び出します。 auth: {{JWT}}

応答コンテンツタイプ

application/json

サンプルのリクエスト

curl -X POST \
  http://{{host}}/api/public/tables/{{tableName}}/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"
     }
}'

サンプルのレスポンス

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

Query Data (Table) API

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 maximum number of records to be fetched.
By default this is set to 10 and the maximum allowed is 100.
sys_offset The number of records to be skipped from the beginning of the results dataset.

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"
	   }

Authorization

Invoke the API with JWT in the header with the following syntax:

auth: {{JWT}}

Response content type

application/json

Sample Request

curl -X POST \
  http://{{host}}/api/public/tables/{{tableName}}/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"
	   }
}'

Sample Response

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