16 docs tagged with "reference"

A dense, imperative briefing for AI agents calling the Agility API - decision procedures, contracts, and anti-patterns, with links to the owning pages

The vocabulary of the Agility API - asset model terms, query terms, and the UI names that differ from them

Every asset type system name with its default display name — an exhaustive lookup table aimed at tooling and AI agents

Dot notation, downcasting to a subtype, aggregation rollups, the now-only operator, and filters applied part-way along an attribute path.

The complete list of Agility attribute types reported by meta.v1, with the underlying data type of each.

The with parameter: assigning variables that filter expressions reference, and how its lexing rules differ from the filter language.

The where language: comparison operators including LIKE, boolean composition and grouping, value lists, unary existence assertions, and variables.

The complete rest-1.v1 query syntax rendered as EBNF, with the raw ANTLR grammar files available for download.

What each HTTP status actually means on the Agility API, with real response bodies

Normative reference for the attribute-path and filter syntax shared by rest-1.v1, query.v1 and api/asset: attribute paths, downcasts, aggregations, filter expressions, filter context, sort and paging.

Content types, the JSON-array and YAML-multi-document forms, the response envelope, resultMetaData, and config counts-only.

Methods, query-string syntax, response shapes, authentication, errors and caching for the loc-2.v1 localization endpoint.

The thirteen roles Agility supports, how Rights differ from Privileges, and what actually separates one role from another — written for integrators provisioning Members.

Ordering results with + and -, and paging with page=size,start — including the argument order that is commonly reversed.

The text file format behind Agility localization template sets: naming, UTF-8 encoding, comments, escaping, multi-line values and deletions.

The shape of every rest-1.v1 response: Data and Hist queries by asset type, asset and attribute, plus update, New and operation responses.