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

openapi.api.SchemasApi

Load the API package

import 'package:openapi/api.dart';

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

Method	HTTP request	Description
viewTheSchema	GET /api/v3/example/schema	view the schema

viewTheSchema

Object viewTheSchema()

view the schema

This is an example of how a schema 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 = SchemasApi();

try {
    final result = api_instance.viewTheSchema();
    print(result);
} catch (e) {
    print('Exception when calling SchemasApi->viewTheSchema: $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]