368 lines
10 KiB
Markdown
368 lines
10 KiB
Markdown
# manager_api_new.api.ConfigurationApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *http://localhost:5000*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**configurationCreate**](ConfigurationApi.md#configurationcreate) | **POST** /api/Configuration |
|
|
[**configurationDelete**](ConfigurationApi.md#configurationdelete) | **DELETE** /api/Configuration/{id} |
|
|
[**configurationExport**](ConfigurationApi.md#configurationexport) | **GET** /api/Configuration/{id}/export |
|
|
[**configurationGet**](ConfigurationApi.md#configurationget) | **GET** /api/Configuration |
|
|
[**configurationGetConfigurationsByPinCode**](ConfigurationApi.md#configurationgetconfigurationsbypincode) | **GET** /api/Configuration/byPin |
|
|
[**configurationGetDetail**](ConfigurationApi.md#configurationgetdetail) | **GET** /api/Configuration/{id} |
|
|
[**configurationImport**](ConfigurationApi.md#configurationimport) | **POST** /api/Configuration/import |
|
|
[**configurationUpdate**](ConfigurationApi.md#configurationupdate) | **PUT** /api/Configuration |
|
|
|
|
|
|
# **configurationCreate**
|
|
> ConfigurationDTO configurationCreate(configurationDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final configurationDTO = ConfigurationDTO(); // ConfigurationDTO |
|
|
|
|
try {
|
|
final result = api_instance.configurationCreate(configurationDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationCreate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**configurationDTO** | [**ConfigurationDTO**](ConfigurationDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ConfigurationDTO**](ConfigurationDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationDelete**
|
|
> String configurationDelete(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.configurationDelete(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationDelete: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationExport**
|
|
> MultipartFile configurationExport(id, language)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final id = id_example; // String |
|
|
final language = language_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.configurationExport(id, language);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationExport: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
**language** | **String**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**MultipartFile**](MultipartFile.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/octet-stream, application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationGet**
|
|
> List<ConfigurationDTO> configurationGet(instanceId)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final instanceId = instanceId_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.configurationGet(instanceId);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationGet: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instanceId** | **String**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**List<ConfigurationDTO>**](ConfigurationDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationGetConfigurationsByPinCode**
|
|
> List<ConfigurationDTO> configurationGetConfigurationsByPinCode(pinCode)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final pinCode = 56; // int |
|
|
|
|
try {
|
|
final result = api_instance.configurationGetConfigurationsByPinCode(pinCode);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationGetConfigurationsByPinCode: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**pinCode** | **int**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**List<ConfigurationDTO>**](ConfigurationDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationGetDetail**
|
|
> ConfigurationDTO configurationGetDetail(id)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final id = id_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.configurationGetDetail(id);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationGetDetail: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**id** | **String**| |
|
|
|
|
### Return type
|
|
|
|
[**ConfigurationDTO**](ConfigurationDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationImport**
|
|
> String configurationImport(exportConfigurationDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final exportConfigurationDTO = ExportConfigurationDTO(); // ExportConfigurationDTO |
|
|
|
|
try {
|
|
final result = api_instance.configurationImport(exportConfigurationDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationImport: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**exportConfigurationDTO** | [**ExportConfigurationDTO**](ExportConfigurationDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
**String**
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
# **configurationUpdate**
|
|
> ConfigurationDTO configurationUpdate(configurationDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = ConfigurationApi();
|
|
final configurationDTO = ConfigurationDTO(); // ConfigurationDTO |
|
|
|
|
try {
|
|
final result = api_instance.configurationUpdate(configurationDTO);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling ConfigurationApi->configurationUpdate: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**configurationDTO** | [**ConfigurationDTO**](ConfigurationDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
[**ConfigurationDTO**](ConfigurationDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|