manager-app/manager_api_new/doc/InstanceApi.md

manager_api_new.api.InstanceApi

Load the API package

import 'package:manager_api_new/api.dart';

All URIs are relative to https://localhost:5001

Method	HTTP request	Description
applicationInstanceAddConfigurationToApplicationInstance	POST /api/ApplicationInstance/{applicationInstanceId}/application-link
applicationInstanceCreate	POST /api/ApplicationInstance
applicationInstanceDelete	DELETE /api/ApplicationInstance/{id}
applicationInstanceDeleteAppConfigurationLink	DELETE /api/ApplicationInstance/{applicationInstanceId}/application-link/{appConfigurationLinkId}
applicationInstanceGet	GET /api/ApplicationInstance
applicationInstanceGetAllApplicationLinkFromApplicationInstance	GET /api/ApplicationInstance/{applicationInstanceId}/application-link
applicationInstanceUpdate	PUT /api/ApplicationInstance
applicationInstanceUpdateApplicationLink	PUT /api/ApplicationInstance/application-link
instanceCreateInstance	POST /api/Instance
instanceDeleteInstance	DELETE /api/Instance/{id}
instanceGet	GET /api/Instance
instanceGetDetail	GET /api/Instance/{id}
instanceGetInstanceByPinCode	GET /api/Instance/byPin
instanceUpdateinstance	PUT /api/Instance

applicationInstanceAddConfigurationToApplicationInstance

AppConfigurationLinkDTO applicationInstanceAddConfigurationToApplicationInstance(applicationInstanceId, appConfigurationLinkDTO)

Example

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

Return type

AppConfigurationLinkDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceCreate

ApplicationInstanceDTO applicationInstanceCreate(applicationInstanceDTO)

Example

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

Return type

ApplicationInstanceDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceDelete

String applicationInstanceDelete(id)

Example

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceDeleteAppConfigurationLink

String applicationInstanceDeleteAppConfigurationLink(applicationInstanceId, appConfigurationLinkId)

Example

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceGet

List applicationInstanceGet(instanceId)

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceGetAllApplicationLinkFromApplicationInstance

List applicationInstanceGetAllApplicationLinkFromApplicationInstance(applicationInstanceId2, applicationInstanceId)

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceUpdate

ApplicationInstanceDTO applicationInstanceUpdate(applicationInstanceDTO)

Example

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

Return type

ApplicationInstanceDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

applicationInstanceUpdateApplicationLink

AppConfigurationLinkDTO applicationInstanceUpdateApplicationLink(appConfigurationLinkDTO)

Example

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

Return type

AppConfigurationLinkDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceCreateInstance

InstanceDTO instanceCreateInstance(instanceDTO)

Example

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

Return type

InstanceDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceDeleteInstance

String instanceDeleteInstance(id)

Example

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

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceGet

List instanceGet()

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceGetDetail

InstanceDTO instanceGetDetail(id)

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceGetInstanceByPinCode

InstanceDTO instanceGetInstanceByPinCode(pinCode)

Example

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

Authorization

bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

instanceUpdateinstance

InstanceDTO instanceUpdateinstance(instanceDTO)

Example

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

Return type

InstanceDTO

Authorization

bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]