2025-07-17 12:11:59 +02:00

632 lines
19 KiB
Markdown

# manager_api_new.api.InstanceApi
## Load the API package
```dart
import 'package:manager_api_new/api.dart';
```
All URIs are relative to *https://localhost:5001*
Method | HTTP request | Description
------------- | ------------- | -------------
[**applicationInstanceAddConfigurationToApplicationInstance**](InstanceApi.md#applicationinstanceaddconfigurationtoapplicationinstance) | **POST** /api/ApplicationInstance/{applicationInstanceId}/application-link |
[**applicationInstanceCreate**](InstanceApi.md#applicationinstancecreate) | **POST** /api/ApplicationInstance |
[**applicationInstanceDelete**](InstanceApi.md#applicationinstancedelete) | **DELETE** /api/ApplicationInstance/{id} |
[**applicationInstanceDeleteAppConfigurationLink**](InstanceApi.md#applicationinstancedeleteappconfigurationlink) | **DELETE** /api/ApplicationInstance/{applicationInstanceId}/application-link/{appConfigurationLinkId} |
[**applicationInstanceGet**](InstanceApi.md#applicationinstanceget) | **GET** /api/ApplicationInstance |
[**applicationInstanceGetAllApplicationLinkFromApplicationInstance**](InstanceApi.md#applicationinstancegetallapplicationlinkfromapplicationinstance) | **GET** /api/ApplicationInstance/{applicationInstanceId}/application-link |
[**applicationInstanceUpdate**](InstanceApi.md#applicationinstanceupdate) | **PUT** /api/ApplicationInstance |
[**applicationInstanceUpdateApplicationLink**](InstanceApi.md#applicationinstanceupdateapplicationlink) | **PUT** /api/ApplicationInstance/application-link |
[**instanceCreateInstance**](InstanceApi.md#instancecreateinstance) | **POST** /api/Instance |
[**instanceDeleteInstance**](InstanceApi.md#instancedeleteinstance) | **DELETE** /api/Instance/{id} |
[**instanceGet**](InstanceApi.md#instanceget) | **GET** /api/Instance |
[**instanceGetDetail**](InstanceApi.md#instancegetdetail) | **GET** /api/Instance/{id} |
[**instanceGetInstanceByPinCode**](InstanceApi.md#instancegetinstancebypincode) | **GET** /api/Instance/byPin |
[**instanceUpdateinstance**](InstanceApi.md#instanceupdateinstance) | **PUT** /api/Instance |
# **applicationInstanceAddConfigurationToApplicationInstance**
> AppConfigurationLinkDTO applicationInstanceAddConfigurationToApplicationInstance(applicationInstanceId, appConfigurationLinkDTO)
### 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 = InstanceApi();
final applicationInstanceId = applicationInstanceId_example; // String |
final appConfigurationLinkDTO = AppConfigurationLinkDTO(); // AppConfigurationLinkDTO |
try {
final result = api_instance.applicationInstanceAddConfigurationToApplicationInstance(applicationInstanceId, appConfigurationLinkDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceAddConfigurationToApplicationInstance: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceId** | **String**| |
**appConfigurationLinkDTO** | [**AppConfigurationLinkDTO**](AppConfigurationLinkDTO.md)| |
### Return type
[**AppConfigurationLinkDTO**](AppConfigurationLinkDTO.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)
# **applicationInstanceCreate**
> ApplicationInstanceDTO applicationInstanceCreate(applicationInstanceDTO)
### 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 = InstanceApi();
final applicationInstanceDTO = ApplicationInstanceDTO(); // ApplicationInstanceDTO |
try {
final result = api_instance.applicationInstanceCreate(applicationInstanceDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceCreate: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceDTO** | [**ApplicationInstanceDTO**](ApplicationInstanceDTO.md)| |
### Return type
[**ApplicationInstanceDTO**](ApplicationInstanceDTO.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)
# **applicationInstanceDelete**
> String applicationInstanceDelete(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 = InstanceApi();
final id = id_example; // String |
try {
final result = api_instance.applicationInstanceDelete(id);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceDelete: $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)
# **applicationInstanceDeleteAppConfigurationLink**
> String applicationInstanceDeleteAppConfigurationLink(applicationInstanceId, appConfigurationLinkId)
### 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 = InstanceApi();
final applicationInstanceId = applicationInstanceId_example; // String |
final appConfigurationLinkId = appConfigurationLinkId_example; // String |
try {
final result = api_instance.applicationInstanceDeleteAppConfigurationLink(applicationInstanceId, appConfigurationLinkId);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceDeleteAppConfigurationLink: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceId** | **String**| |
**appConfigurationLinkId** | **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)
# **applicationInstanceGet**
> List<ApplicationInstanceDTO> applicationInstanceGet(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 = InstanceApi();
final instanceId = instanceId_example; // String |
try {
final result = api_instance.applicationInstanceGet(instanceId);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceGet: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instanceId** | **String**| | [optional]
### Return type
[**List<ApplicationInstanceDTO>**](ApplicationInstanceDTO.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)
# **applicationInstanceGetAllApplicationLinkFromApplicationInstance**
> List<AppConfigurationLinkDTO> applicationInstanceGetAllApplicationLinkFromApplicationInstance(applicationInstanceId2, applicationInstanceId)
### 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 = InstanceApi();
final applicationInstanceId2 = applicationInstanceId_example; // String |
final applicationInstanceId = applicationInstanceId_example; // String |
try {
final result = api_instance.applicationInstanceGetAllApplicationLinkFromApplicationInstance(applicationInstanceId2, applicationInstanceId);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceGetAllApplicationLinkFromApplicationInstance: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceId2** | **String**| |
**applicationInstanceId** | **String**| | [optional]
### Return type
[**List<AppConfigurationLinkDTO>**](AppConfigurationLinkDTO.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)
# **applicationInstanceUpdate**
> ApplicationInstanceDTO applicationInstanceUpdate(applicationInstanceDTO)
### 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 = InstanceApi();
final applicationInstanceDTO = ApplicationInstanceDTO(); // ApplicationInstanceDTO |
try {
final result = api_instance.applicationInstanceUpdate(applicationInstanceDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceUpdate: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceDTO** | [**ApplicationInstanceDTO**](ApplicationInstanceDTO.md)| |
### Return type
[**ApplicationInstanceDTO**](ApplicationInstanceDTO.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)
# **applicationInstanceUpdateApplicationLink**
> AppConfigurationLinkDTO applicationInstanceUpdateApplicationLink(appConfigurationLinkDTO)
### 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 = InstanceApi();
final appConfigurationLinkDTO = AppConfigurationLinkDTO(); // AppConfigurationLinkDTO |
try {
final result = api_instance.applicationInstanceUpdateApplicationLink(appConfigurationLinkDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->applicationInstanceUpdateApplicationLink: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**appConfigurationLinkDTO** | [**AppConfigurationLinkDTO**](AppConfigurationLinkDTO.md)| |
### Return type
[**AppConfigurationLinkDTO**](AppConfigurationLinkDTO.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)
# **instanceCreateInstance**
> InstanceDTO instanceCreateInstance(instanceDTO)
### 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 = InstanceApi();
final instanceDTO = InstanceDTO(); // InstanceDTO |
try {
final result = api_instance.instanceCreateInstance(instanceDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceCreateInstance: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instanceDTO** | [**InstanceDTO**](InstanceDTO.md)| |
### Return type
[**InstanceDTO**](InstanceDTO.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)
# **instanceDeleteInstance**
> String instanceDeleteInstance(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 = InstanceApi();
final id = id_example; // String |
try {
final result = api_instance.instanceDeleteInstance(id);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceDeleteInstance: $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)
# **instanceGet**
> List<Instance> instanceGet()
### 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 = InstanceApi();
try {
final result = api_instance.instanceGet();
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceGet: $e\n');
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**List<Instance>**](Instance.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)
# **instanceGetDetail**
> InstanceDTO instanceGetDetail(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 = InstanceApi();
final id = id_example; // String |
try {
final result = api_instance.instanceGetDetail(id);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceGetDetail: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| |
### Return type
[**InstanceDTO**](InstanceDTO.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)
# **instanceGetInstanceByPinCode**
> InstanceDTO instanceGetInstanceByPinCode(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 = InstanceApi();
final pinCode = pinCode_example; // String |
try {
final result = api_instance.instanceGetInstanceByPinCode(pinCode);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceGetInstanceByPinCode: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pinCode** | **String**| | [optional]
### Return type
[**InstanceDTO**](InstanceDTO.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)
# **instanceUpdateinstance**
> InstanceDTO instanceUpdateinstance(instanceDTO)
### 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 = InstanceApi();
final instanceDTO = InstanceDTO(); // InstanceDTO |
try {
final result = api_instance.instanceUpdateinstance(instanceDTO);
print(result);
} catch (e) {
print('Exception when calling InstanceApi->instanceUpdateinstance: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instanceDTO** | [**InstanceDTO**](InstanceDTO.md)| |
### Return type
[**InstanceDTO**](InstanceDTO.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)