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

openapi.api.BudgetsApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
viewBudget	GET /api/v3/budgets/{id}	view Budget
viewBudgetsOfAProject	GET /api/v3/projects/{id}/budgets	view Budgets of a Project

viewBudget

BudgetModel viewBudget(id)

view Budget

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 = BudgetsApi();
final id = 1; // int | Budget id

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

Parameters

Name	Type	Description	Notes
id	int	Budget id

Return type

BudgetModel

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]

viewBudgetsOfAProject

Object viewBudgetsOfAProject(id)

view Budgets of a Project

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 = BudgetsApi();
final id = 1; // int | Project id

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

Parameters

Name	Type	Description	Notes
id	int	Project id

Return type

Object

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]