Skip to content

tools.ozone.set.querySets

Lexicon Version: 1

Type: query

Query available sets

Parameters:

NameTypeReq’dDescriptionConstraints
limitintegerMin: 1
Max: 100
Default: 50
cursorstring
namePrefixstring
sortBystringEnum: name, createdAt, updatedAt
Default: name
sortDirectionstringDefaults to ascending order of name field.Enum: asc, desc
Default: asc
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
setsArray of tools.ozone.set.defs#setView
cursorstring

{
"lexicon": 1,
"id": "tools.ozone.set.querySets",
"defs": {
"main": {
"type": "query",
"description": "Query available sets",
"parameters": {
"type": "params",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"cursor": {
"type": "string"
},
"namePrefix": {
"type": "string"
},
"sortBy": {
"type": "string",
"enum": [
"name",
"createdAt",
"updatedAt"
],
"default": "name"
},
"sortDirection": {
"type": "string",
"default": "asc",
"enum": [
"asc",
"desc"
],
"description": "Defaults to ascending order of name field."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"sets"
],
"properties": {
"sets": {
"type": "array",
"items": {
"type": "ref",
"ref": "tools.ozone.set.defs#setView"
}
},
"cursor": {
"type": "string"
}
}
}
}
}
}
}