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

openapi.api.HelpTextsApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
getHelpText	GET /api/v3/help_texts/{id}	Get help text
listHelpTexts	GET /api/v3/help_texts	List help texts

getHelpText

HelpTextModel getHelpText(id)

Get help text

Fetches the help text from the given id.

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 = HelpTextsApi();
final id = 1; // int | Help text id

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

Parameters

Name	Type	Description	Notes
id	int	Help text id

Return type

HelpTextModel

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]

listHelpTexts

HelpTextCollectionModel listHelpTexts()

List help texts

List the complete collection of help texts.

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

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

Parameters

This endpoint does not need any parameter.

Return type

HelpTextCollectionModel

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]