Requête sur le tableau

POST /table/query

Requête sur le tableau

cURL

curl --request POST \
  --url https://api.example.com/table/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "digest": "<string>",
  "project_id": "<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
    }
  ]
}

Autorisations

Authorization · string · header · requis

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

Corps

application/json

digest · string · requis

L’empreinte du tableau à interroger

Exemple:

"aonareimsvtl13apimtalpa4435rpmgnaemrpgmarltarstaorsnte134avrims"

project_id · string · requis

L’ID du projet

Exemple:

"my_entity/my_project"

filter · TableRowFilter · object

Filtre facultatif à appliquer à la requête. Voir TableRowFilter pour plus de détails.

Show child attributes

Exemple:

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

limit · integer | null

Nombre maximal de lignes à renvoyer

Exemple:

100

offset · integer | null

Nombre de lignes à ignorer avant de commencer à renvoyer des lignes

Exemple:

10

sort_by · SortBy · object[] | null

Liste des champs selon lesquels trier. Les champs peuvent être séparés par des points pour accéder aux valeurs du dictionnaire. Si aucun tri n’est appliqué, l’ordre par défaut du tableau est utilisé (ordre d’insertion).

Show child attributes

Exemple:

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

Réponse

200

application/json

Réponse réussie

rows · TableRowSchema · object[] · requis

Show child attributes