Module queries

Module queries 

Source
Expand description

Queries Rest API Endpoint definitions

The Redmine API for queries is read-only. It only supports listing all visible queries. The API does not expose endpoints for:

  • Retrieving a single query by ID (GET /queries/:id)
  • Creating a query (POST /queries.json)
  • Updating a query (PUT /queries/:id.json)
  • Deleting a query (DELETE /queries/:id.json)

This was confirmed by examining the Redmine source code (config/routes.rb and app/controllers/queries_controller.rb). Previous analysis indicating inconsistencies due to missing client implementations for these endpoints was a false positive.

Redmine Documentation

  • all (visible) custom queries endpoint

Structs§

ListQueries
The endpoint to retrieve all queries visible to the current user
ListQueriesBuilder
Builder for ListQueries.
QueriesWrapper
helper struct for outer layers with a queries field holding the inner data
Query
a type for a detailed query to use as an API return type
QueryListItem
a type for query list items to use as an API return type

Enums§

ListQueriesBuilderError
Error type for ListQueriesBuilder
Visibility
The visibility of a query