manager-app/manager_api_new/doc/ApplicationInstanceApi.md
2025-08-14 16:29:40 +02:00

370 lines
12 KiB
Markdown

# manager_api_new.api.ApplicationInstanceApi
## 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**](ApplicationInstanceApi.md#applicationinstanceaddconfigurationtoapplicationinstance) | **POST** /api/ApplicationInstance/{applicationInstanceId}/application-link |
[**applicationInstanceCreate**](ApplicationInstanceApi.md#applicationinstancecreate) | **POST** /api/ApplicationInstance |
[**applicationInstanceDelete**](ApplicationInstanceApi.md#applicationinstancedelete) | **DELETE** /api/ApplicationInstance/{id} |
[**applicationInstanceDeleteAppConfigurationLink**](ApplicationInstanceApi.md#applicationinstancedeleteappconfigurationlink) | **DELETE** /api/ApplicationInstance/{applicationInstanceId}/application-link/{appConfigurationLinkId} |
[**applicationInstanceGet**](ApplicationInstanceApi.md#applicationinstanceget) | **GET** /api/ApplicationInstance |
[**applicationInstanceGetAllApplicationLinkFromApplicationInstance**](ApplicationInstanceApi.md#applicationinstancegetallapplicationlinkfromapplicationinstance) | **GET** /api/ApplicationInstance/{applicationInstanceId}/application-link |
[**applicationInstanceUpdate**](ApplicationInstanceApi.md#applicationinstanceupdate) | **PUT** /api/ApplicationInstance |
[**applicationInstanceUpdateApplicationLink**](ApplicationInstanceApi.md#applicationinstanceupdateapplicationlink) | **PUT** /api/ApplicationInstance/application-link |
# **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 = ApplicationInstanceApi();
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 ApplicationInstanceApi->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 = ApplicationInstanceApi();
final applicationInstanceDTO = ApplicationInstanceDTO(); // ApplicationInstanceDTO |
try {
final result = api_instance.applicationInstanceCreate(applicationInstanceDTO);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->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 = ApplicationInstanceApi();
final id = id_example; // String |
try {
final result = api_instance.applicationInstanceDelete(id);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->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 = ApplicationInstanceApi();
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 ApplicationInstanceApi->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 = ApplicationInstanceApi();
final instanceId = instanceId_example; // String |
try {
final result = api_instance.applicationInstanceGet(instanceId);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->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(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 = ApplicationInstanceApi();
final applicationInstanceId = applicationInstanceId_example; // String |
try {
final result = api_instance.applicationInstanceGetAllApplicationLinkFromApplicationInstance(applicationInstanceId);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->applicationInstanceGetAllApplicationLinkFromApplicationInstance: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**applicationInstanceId** | **String**| |
### 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 = ApplicationInstanceApi();
final applicationInstanceDTO = ApplicationInstanceDTO(); // ApplicationInstanceDTO |
try {
final result = api_instance.applicationInstanceUpdate(applicationInstanceDTO);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->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 = ApplicationInstanceApi();
final appConfigurationLinkDTO = AppConfigurationLinkDTO(); // AppConfigurationLinkDTO |
try {
final result = api_instance.applicationInstanceUpdateApplicationLink(appConfigurationLinkDTO);
print(result);
} catch (e) {
print('Exception when calling ApplicationInstanceApi->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)