テーブルクエリ

POST /table/query

テーブルクエリ

cURL

curl --request POST \
  --url https://api.example.com/table/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "digest": "<string>",
  "filter": {
    "row_digests": [
      "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims",
      "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"
    ]
  },
  "limit": 100,
  "offset": 10,
  "sort_by": [
    {
      "field": "col_a.prop_b",
      "order": "desc"
    }
  ]
}
'

200

{
  "rows": [
    {
      "digest": "<string>",
      "val": "<unknown>",
      "original_index": 123
    }
  ]
}

承認

Authorization · string · header · 必須

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

ボディ

application/json

project_id · string · 必須

プロジェクトの ID

例:

"my_entity/my_project"

digest · string · 必須

クエリ対象テーブルのダイジェスト

例:

"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"

filter · TableRowFilter · object

クエリに適用するオプションのフィルター。詳細は TableRowFilter を参照してください。

表示 子属性

例:

{
  "row_digests": [
    "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims",
    "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"
  ]
}

limit · integer | null

返す行数の最大値

例:

100

offset · integer | null

行の返却を開始する前にスキップする行数

例:

10

sort_by · SortBy · object[] | null

ソートに使用するフィールドのリスト。フィールドはドット区切りで記述し、辞書内の値にアクセスできます。ソート順を指定しない場合、デフォルトのテーブル順序（挿入順）が使用されます。

表示 子属性

例:

[
  { "field": "col_a.prop_b", "order": "desc" }
]

レスポンス

200

application/json

成功レスポンス

rows · TableRowSchema · object[] · 必須

表示 子属性