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

openapi.api.StatusesApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
listAllStatuses	GET /api/v3/statuses	List all Statuses
viewStatus	GET /api/v3/statuses/{id}	View Status

listAllStatuses

Object listAllStatuses()

List all Statuses

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

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

Parameters

This endpoint does not need any parameter.

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]

viewStatus

StatusModel viewStatus(id)

View Status

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

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

Parameters

Name	Type	Description	Notes
id	int	Status id

Return type

StatusModel

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]