Objs Query

POST 
/objs/query

Objs Query

Request

application/json

Body

required

project_id Project Id (string)required

The ID of the project to query

filter

object

Filter criteria for the query. See ObjectVersionFilter

anyOf

ObjectVersionFilter

base_object_classes

object

Filter objects by their base classes

anyOf

MOD1

Array [

string

]

object_ids

object

Filter objects by their IDs

anyOf

MOD1

Array [

string

]

is_op

object

Filter objects based on whether they are weave.ops or not. True will only return ops, False will return non-ops, and None will return all objects

anyOf

MOD1

boolean

latest_only

object

If True, return only the latest version of each object. False and None will return all versions

anyOf

MOD1

boolean

limit

object

Maximum number of results to return

anyOf

MOD1

integer

offset

object

Number of results to skip before returning

anyOf

MOD1

integer

sort_by

object

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

anyOf

MOD1

Array [

field Field (string)required

direction Direction (string)required

Possible values: [asc, desc]

]

metadata_only

object

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

anyOf

MOD1

boolean

Responses

200

Successful Response

application/json

Schema

Schema

objs

object[]

required

Array [

project_id Project Id (string)required

object_id Object Id (string)required

created_at date-timerequired

deleted_at

object

anyOf

MOD1

string

digest Digest (string)required

version_index Version Index (integer)required

is_latest Is Latest (integer)required

kind Kind (string)required

base_object_class

object

required

anyOf

MOD1

string

val Valrequired

]

Example (from schema)

{
  "objs": [
    {
      "project_id": "string",
      "object_id": "string",
      "created_at": "2024-10-09T19:25:34.387Z",
      "deleted_at": "2024-10-09T19:25:34.387Z",
      "digest": "string",
      "version_index": 0,
      "is_latest": 0,
      "kind": "string",
      "base_object_class": "string"
    }
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...