Query API

Welcome to the Query API documentation. This API provides a comprehensive set of functions for creating and validating query and filter requests used throughout the system. Below is a list of available functions, each with a brief description and a link to its detailed documentation.

Function List

newFilterRequest

Generates an empty non-persisted Filter Request object to provide the structure required by the API to filter query data. This method is used to create filter conditions that can be applied to find methods. Returns a JSON representation of the newly created filter request object.

newQueryRequest

Generates an empty non-persisted Query Request object to provide the structure required by the API to define pagination, sorting, and filtering parameters when calling find methods. Returns a JSON representation of the newly created query request object.

validateFilterRequest

Validates the specified parameters for a Filter Request object and returns any validation errors. This only checks if the filter request object is valid based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.

validateQueryRequest

Validates the specified parameters for a Query Request object and returns any validation errors. This only checks if the query request object is valid based on the attributes given. Returns a JSON object where keys are field names and values are lists of validation violation messages.