Skip to main content

7 docs tagged with "conventions"

View all tags

API Conventions

Base URLs, HTTP headers, error shapes and terminology shared by every Agility API.

Attribute Definition Syntax

Where to find the normative attribute-path and filter-expression grammar shared by every Agility query surface.

Base URL

How to build the base URL that every Agility API request is relative to, from your instance host and instance name.

Dates and Date Ranges

How Agility stores date ranges. EndDate is exclusive — midnight of the day after the range ends — which is the source of most off-by-one errors against the API.

Errors

The HTTP status codes the Agility APIs return, what each one means, and how to read the error payload.

HTTP Headers

The Authorization, Content-Type and Accept headers required by every Agility API request, and what each one controls.

Terminology

Asset, asset type, asset state, attribute definition and Oid — the five terms the Agility API vocabulary is built from.