ApicalypseQueryBuilder

APICalypse query builder.

See APICalypse cheatsheet

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard

Builds the specified query.

Link copied to clipboard
fun exclude(vararg excludes: String): ApicalypseQueryBuilder

Fields to exclude when using '*' wildcard when specifying the list of fields

Link copied to clipboard
fun fields(vararg fieldList: String): ApicalypseQueryBuilder

Fields that should be returned as a result of an API request.

Link copied to clipboard

Sets a limit on the number of results returned.

Link copied to clipboard

Number of results to skip over.

Link copied to clipboard

Search based on name, results are sorted by similarity to the given search string.

Link copied to clipboard
fun sort(field: String, order: SortOrder = ASC): ApicalypseQueryBuilder

Sets the field that will be used to sort the result and the sort order

Link copied to clipboard

SQL-like query filter.