manager-app/manager_api/README.md

managerapi

API Manager Service

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: Version Alpha
• Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  managerapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  managerapi:
    path: /path/to/managerapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:managerapi/api.dart';

// TODO Configure OAuth2 access token for authorization: bearer
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = AuthenticationApi();
final grantType = grantType_example; // String | 
final username = username_example; // String | 
final password = password_example; // String | 
final clientId = clientId_example; // String | 
final clientSecret = clientSecret_example; // String | 

try {
    final result = api_instance.authenticationAuthenticateWithForm(grantType, username, password, clientId, clientSecret);
    print(result);
} catch (e) {
    print('Exception when calling AuthenticationApi->authenticationAuthenticateWithForm: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://192.168.31.96

Class	Method	HTTP request	Description
AuthenticationApi	authenticationAuthenticateWithForm	POST /api/Authentication/Token
AuthenticationApi	authenticationAuthenticateWithJson	POST /api/Authentication/Authenticate
ConfigurationApi	configurationCreate	POST /api/Configuration
ConfigurationApi	configurationDelete	DELETE /api/Configuration/{id}
ConfigurationApi	configurationGet	GET /api/Configuration
ConfigurationApi	configurationGetDetail	GET /api/Configuration/{id}
ConfigurationApi	configurationUpdate	PUT /api/Configuration
DeviceApi	deviceCreate	POST /api/Device
DeviceApi	deviceDelete	DELETE /api/Device/{id}
DeviceApi	deviceGet	GET /api/Device
DeviceApi	deviceGetDetail	GET /api/Device/{id}/detail
DeviceApi	deviceUpdate	PUT /api/Device
RessourceApi	ressourceCreate	POST /api/Ressource
RessourceApi	ressourceDelete	DELETE /api/Ressource/{id}
RessourceApi	ressourceGet	GET /api/Ressource
RessourceApi	ressourceGetDetail	GET /api/Ressource/{id}/detail
RessourceApi	ressourceShow	GET /api/Ressource/{id}
RessourceApi	ressourceUpdate	PUT /api/Ressource
SectionApi	sectionCreate	POST /api/Section
SectionApi	sectionDelete	DELETE /api/Section/{id}
SectionApi	sectionDeleteAllForConfiguration	DELETE /api/Section/configuration/{id}
SectionApi	sectionGet	GET /api/Section
SectionApi	sectionGetAllSectionSubSections	GET /api/Section/{id}/subsections
SectionApi	sectionGetDetail	GET /api/Section/{id}
SectionApi	sectionGetFromConfiguration	GET /api/Section/configuration/{id}
SectionApi	sectionUpdate	PUT /api/Section
UserApi	userCreateUser	POST /api/User
UserApi	userDeleteUser	DELETE /api/User/{id}
UserApi	userGet	GET /api/User
UserApi	userGetDetail	GET /api/User/{id}
UserApi	userUpdateUser	PUT /api/User

Documentation For Models

• ConfigurationDTO
• DeviceDTO
• DeviceDetailDTO
• DeviceDetailDTOAllOf
• LoginDTO
• RessourceDTO
• RessourceDetailDTO
• RessourceType
• SectionDTO
• SectionType
• TokenDTO
• TranslationDTO
• User
• UserDetailDTO

Documentation For Authorization

bearer

• Type: OAuth
• Flow: password
• Authorization URL: /authentication/Token
• Scopes:
• Manager-api: Manager WebAPI

Author