Introduction

API v3 is the latest version of the Xytech Platform REST API. It builds on v2 with one goal in mind: make the API easier to use and harder to get wrong, while keeping it fast under load.

v3 is generally available from release 26.5. It is enabled by default - there is no longer a feature flag to turn on - and it runs alongside v2, so existing v2 integrations keep working unchanged.

Why v3?

The API v3 initiative was guided by three objectives:

• Embrace standards. Align Xytech's API with widely understood REST conventions for URLs, request bodies, and HTTP status codes, so that developers familiar with other modern APIs feel at home.

• Apply better defaults. Ship sensible, safe defaults - especially around result size - so that a naive call stays performant and doesn't put the system under unnecessary load.

• Improve functionality. Add capabilities that integrators have asked for, such as querying setup documents and sending complex queries in a request body.

• Cleaner URLs. Record keys are path segments (/job_no/123) rather than ?job_no=123, so simple lookups read cleanly and need no encoding. (The JSON fields and query parameters still need URL-encoding in strict clients.)

• Predictable performance. A required fields projection and a system default page size protect both your integration and the platform from accidental "select everything" calls.

• - a focused checklist of what changes for an existing v2 integration, with before/after examples.

• - a task-oriented reference for building a new integration on v3: authentication, addressing records, querying, paging, updating, and error handling.

Conventions used in this guide. Examples use https://<your-server> as a placeholder for your Xytech web address - replace it with your own. The exact base URL for your environment is shown on the /apidocs page (see ).