open-project-flutter-api/doc/ConfigurationApi.md
2023-11-05 19:54:17 +01:00

1.4 KiB

openapi.api.ConfigurationApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
viewConfiguration GET /api/v3/configuration View configuration

viewConfiguration

ConfigurationModel viewConfiguration()

View configuration

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 = ConfigurationApi();

try {
    final result = api_instance.viewConfiguration();
    print(result);
} catch (e) {
    print('Exception when calling ConfigurationApi->viewConfiguration: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

ConfigurationModel

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/hal+json

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