Table Query

POST /table/query

Try it

200

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

Authorizations

Authorization · string · header · required

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

Body

application/json

project_id · string · required

The ID of the project

digest · string · required

The digest of the table to query

filter · TableRowFilter · object

Optional filter to apply to the query. See TableRowFilter for more details.

Show child attributes

filter. row_digests · string[] | null

List of row digests to filter by

Example:

[
  "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims",
  "aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"
]

Example:

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

limit · integer | null

Maximum number of rows to return

Example:

100

offset · integer | null

Number of rows to skip before starting to return rows

Example:

10

sort_by · SortBy · object[] | null

List of fields to sort by. Fields can be dot-separated to access dictionary values. No sorting uses the default table order (insertion order).

Show child attributes

sort_by. field · string · required

sort_by. direction · enum<string> · required

Available options: asc, desc

Example:

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

Response

200

application/json

Successful Response

rows · TableRowSchema · object[] · required

Show child attributes

rows. digest · string · required

rows. val · any · required

rows. original_index · integer | null