Query Data (Table) API1 min read

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

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

パラメータ

説明

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,
        }
    ]
}

On this Page