Requête sur les objets

POST /objs/query

Requête sur les objets

cURL

curl --request POST \
  --url https://api.example.com/objs/query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "latest_only": true,
    "object_ids": [
      "my_favorite_model"
    ]
  },
  "limit": 100,
  "offset": 0,
  "sort_by": [
    {
      "direction": "desc",
      "field": "created_at"
    }
  ],
  "metadata_only": false,
  "include_storage_size": false,
  "include_tags_and_aliases": false
}
'

200

{
  "objs": [
    {
      "project_id": "<string>",
      "object_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "digest": "<string>",
      "version_index": 123,
      "is_latest": 123,
      "kind": "<string>",
      "base_object_class": "<string>",
      "val": "<unknown>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "leaf_object_class": "<string>",
      "wb_user_id": "<string>",
      "size_bytes": 123,
      "tags": [
        "<string>"
      ],
      "aliases": [
        "<string>"
      ]
    }
  ]
}

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

project_id · string · requis

L’ID du projet à interroger

Exemple:

"user/project"

filter · ObjectVersionFilter · object

Critères de filtre pour la requête. Voir ObjectVersionFilter

Show child attributes

Exemple:

{
  "latest_only": true,
  "object_ids": ["my_favorite_model"]
}

limit · integer | null

Nombre maximal de résultats à renvoyer

Exemple:

100

offset · integer | null

Nombre de résultats à ignorer avant de renvoyer la réponse

Exemple:

0

sort_by · SortBy · object[] | null

Critères de tri des résultats de la requête. Prend actuellement en charge uniquement 'object_id' et 'created_at'.

Show child attributes

Exemple:

[
  {
    "direction": "desc",
    "field": "created_at"
  }
]

metadata_only · boolean | null · défaut: false

Si la valeur est true, la colonne val n’est pas lue depuis la base de données et reste vide. Tous les autres champs sont renvoyés.

include_storage_size · boolean | null · défaut: false

Si la valeur est true, la colonne size_bytes est renvoyée.

include_tags_and_aliases · boolean | null · défaut: false

Si true, les tags et les alias sont récupérés et inclus dans la réponse.

Réponse

200

application/json

Réponse réussie

objs · ObjSchema · object[] · requis

Show child attributes