YQueue DocsDevelopers

Schema

Catalog Bulk Retrieve Request

  • Catalog

Overview

object · 3 properties · 1 required

Properties

uuids

array Required

UUIDs of catalog models to retrieve.

Min items 1
Max items 2000
Unique items Yes
Array items

Items

string
Format uuid

sort_field

oneOf
Default name
Nullable Yes
One of

One of 1

null

One of 2

reference

References Catalog Sort Field.

sort_direction

oneOf
Default asc
Nullable Yes
One of

One of 1

null

One of 2

reference

References Sort By.

Used by

Raw YAML
Download source
title: Catalog Bulk Retrieve Request
x-tags:
  - Catalog
type: object
required:
  - uuids
properties:
  uuids:
    type: array
    minItems: 1
    maxItems: 2000
    uniqueItems: true
    items:
      type: string
      format: uuid
    description: UUIDs of catalog models to retrieve.
  sort_field:
    oneOf:
      - type: 'null'
      - $ref: ./CatalogSortField.yaml
    default: name
  sort_direction:
    oneOf:
      - type: 'null'
      - $ref: ./SortDirection.yaml
    default: asc

Search documentation

Search across this documentation site.