open-project-flutter-api/doc/CollectionsApi.md

openapi.api.CollectionsApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://community.openproject.org

Method	HTTP request	Description
viewAggregatedResult	GET /api/v3/examples	view aggregated result

viewAggregatedResult

viewAggregatedResult(groupBy, showSums)

view aggregated result

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: BasicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';

final api_instance = CollectionsApi();
final groupBy = status; // String | The column to group by. Note: Aggregation is as of now only supported by the work package collection. You can pass any column name as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.
final showSums = true; // bool | 

try {
    api_instance.viewAggregatedResult(groupBy, showSums);
} catch (e) {
    print('Exception when calling CollectionsApi->viewAggregatedResult: $e\n');
}

Parameters

Name	Type	Description	Notes
groupBy	String	The column to group by. Note: Aggregation is as of now only supported by the work package collection. You can pass any column name as returned by the queries endpoint.	[optional]
showSums	bool		[optional] [default to false]

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]