API Reference
Reference documentation for the Business NXT GraphQL schema, features, and extensions for working with DMEs.
This section provides a comprehensive documentation of the Business NXT GraphQL API. In this section you will find:
- Schema documentation that details how to perform queries and mutations, how to execute asynchronous requests, how to fetch model information, and many others.
- Features such as filtering, pagination, sorting, aliases, directives, fragments, and more
- Extensions that enable you to work with data model extensions (DMEs)
- Error handling information for understanding and managing errors that may occur
- Rate limiting information for understanding the rate limits that apply to your API usage
Section Content
Schema
Details the Business NXT GraphQL schema, Relay-like, exposing system and company databases with types named after tables, supporting queries and mutations.
Features
Comprehensive GraphQL features - filtering, sorting, pagination, fragments, aliases, directives, error handling, unoptimized queries, batch requests.
Extensions
GraphQL schema for data model extensions.
Error handling
GraphQL API error handling - status codes, error messages, syntax errors, multiple request outcomes, execution tracing for troubleshooting, and detailed error property explanations.
Rate limits
Rate limiting for Business NXT API.