Objs Query

POST /objs/query

Objs Query

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
}
'

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

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 to query

Example:

"user/project"

filter · ObjectVersionFilter · object

Filter criteria for the query. See ObjectVersionFilter

Show child attributes

Example:

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

limit · integer | null

Maximum number of results to return

Example:

100

offset · integer | null

Number of results to skip before returning

Example:

0

sort_by · SortBy · object[] | null

Sorting criteria for the query results. Currently only supports 'object_id' and 'created_at'.

Show child attributes

Example:

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

metadata_only · boolean | null · default: false

If true, the val column is not read from the database and is empty.All other fields are returned.

include_storage_size · boolean | null · default: false

If true, the size_bytes column is returned.

Response

200

application/json

Successful Response

objs · ObjSchema · object[] · required

Show child attributes