쿼리 데이터(보기) API

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

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

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

Kore.ai 봇 플랫폼은 보안 API를 사용하여 봇 개발에 대한 액세스를 제공합니다. 이 API 사용 방법에 대한 자세한 내용은 여기를 참조하세요.

쿼리 매개 변수

매개 변수 설명
host 환경 URL, 예: https://bots.kore.ai
viewName 데이터를 가져올 테이블 보기 양식입니다.
sys_limit 가져올 최대 레코드 수입니다.
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/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"
	   }
}'

샘플 응답

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

Query Data (View) API

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

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

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

Kore.aiボットプラットフォームは、セキュリティ保護されたAPIを使用して、ボット開発へのアクセス権を提供します。これらのAPIの使用方法については、こちらを参照ください

クエリパラメータ

パラメータ 説明
host 環境URL、例: https://bots.kore.ai
viewName データを取得するためのテーブル表示フォーム。
sys_limit 取得する記録の最大数。
sys_offset 結果データセットの先頭からスキップする記録の数。

本文パラメータ

パラメータ 説明
クエリ

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

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

サンプルのレスポンス

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

Query Data (View) API

Used to get data from Table View.

To use this API, the app needs to be given Read access to the Table View from the Data Definition in DaaS (see here for details)

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

Kore.ai Bots Platform provides access to bot development using secured APIs. Refer here to learn more on how to use these APIs.

Query Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai
viewName The table view form 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.

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

Sample Response

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