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

1.8 KiB

openapi.api.FormsApi

Load the API package

import 'package:openapi/api.dart';

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

Method HTTP request Description
showOrValidateForm POST /api/v3/example/form show or validate form

showOrValidateForm

Object showOrValidateForm(showOrValidateFormRequest)

show or validate form

This is an example of how a form might look like. Note that this endpoint does not exist in the actual implementation.

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 = FormsApi();
final showOrValidateFormRequest = ShowOrValidateFormRequest(); // ShowOrValidateFormRequest | 

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

Parameters

Name Type Description Notes
showOrValidateFormRequest ShowOrValidateFormRequest [optional]

Return type

Object

Authorization

BasicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/hal+json, text/plain

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