Viingx icon

Viingx

Interface to viingx systems

Entity → Get Entities

AI-generated

Summary

Retrieves entities of a selected entity type, with optional query filters, sorting, pagination, cursor mode, aggregation, and selected data roots.

Inputs

  • Entity Type Name or ID (required) — Select the entity type to retrieve, or provide its ID.
  • Query — JSON query definition for filtering entities. An empty value returns all entities of the selected type. Supports the documented operators, including comparisons, text matching, existence checks, and compound and/or queries.
  • Sorting — JSON array of property and direction pairs to order results; directions are asc or des.
  • Offset — Zero-based offset for the results; defaults to 0.
  • Limit — Maximum number of results; defaults to 100.
  • More (required) — Enable cursor mode.
  • Cursor — Cursor value for cursor-based retrieval.
  • Aggregation — JSON aggregation definitions, such as counting a property.
  • Roots — Choose which entity data roots to include: Content, Preview, Workflow, or Quality Gates.

Output shape

A list of entity results.

The UI declares offset/limit pagination and optional cursor mode. The source pack omits the operation implementation bodies, so it does not establish the exact response envelope, pagination behavior, or how selected roots and aggregations affect returned data.

Links

Discussion