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

openapi.api.CustomOptionsApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
viewCustomOption	GET /api/v3/custom_options/{id}	View Custom Option

viewCustomOption

CustomOptionModel viewCustomOption(id)

View Custom Option

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 = CustomOptionsApi();
final id = 1; // int | The custom option's identifier

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

Parameters

Name	Type	Description	Notes
id	int	The custom option's identifier

Return type

CustomOptionModel

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]