OPDC API Documentation

Browse the selected domain reference below. For authentication, request and response conventions, errors, locking, and writes, start with the Getting started guide.

API v3 domain

Domain reference

Explore the operations and schemas for this area of the API.

This page loads only the selected domain reference. For authentication, headers, the shared query contract, errors, locking, and writes, start with Getting started.

Section 6

Full API reference#

This is the v3 contract itself, not a description of it. The document below is OpenAPI 3.1 compiled from the TypeSpec the server and the generated clients are both built from, so what it says is what the API does. The guide above covers the 82 query entities, seven writes, and the problem shape for each status. This reference includes the complete field and type definitions.

Reference domain

Only the selected domain is loaded into the interactive reference. The complete v3 contract remains available for generators and tooling.

The field-level reference for all 93 routes. Expand an entity's model to see its available properties and types. Those property names are used in select, orderBy, matchFields and every match.field.

Use it as an index rather than reading it front to back. The 82 /query entries all share the contract from section 2, and every operation's failure responses are the same twelve from section 3. Those responses are declared once and referenced, so a status on one route has the same meaning on every route.

Loading the reference domains…

Something here does not match what you see?

This guide is maintained by hand alongside the generated reference, so if a field, a status value or a cascade does not behave the way it is described here, that is worth reporting rather than working around. Tell us what you called and what came back.