Skip to content

api_client.api.ConfigApi

Load the API package

import 'package:api_client/api.dart';

All URIs are relative to https://localhost

Method HTTP request Description
explain GET /api/Config/explain
getConfig GET /api/Config/getConfig
getConfiguration POST /api/Config/getConfiguration
saveConfig GET /api/Config/saveConfig

explain

String explain(typeName)

Example

import 'package:api_client/api.dart';

var api_instance = new ConfigApi();
var typeName = typeName_example; // String | 

try { 
    var result = api_instance.explain(typeName);
    print(result);
} catch (e) {
    print("Exception when calling ConfigApi->explain: $e\n");
}

Parameters

Name Type Description Notes
typeName String [optional]

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getConfig

Object getConfig(typeName)

Example

import 'package:api_client/api.dart';

var api_instance = new ConfigApi();
var typeName = typeName_example; // String | 

try { 
    var result = api_instance.getConfig(typeName);
    print(result);
} catch (e) {
    print("Exception when calling ConfigApi->getConfig: $e\n");
}

Parameters

Name Type Description Notes
typeName String [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getConfiguration

ConfigurationServiceModel getConfiguration()

Example

import 'package:api_client/api.dart';

var api_instance = new ConfigApi();

try { 
    var result = api_instance.getConfiguration();
    print(result);
} catch (e) {
    print("Exception when calling ConfigApi->getConfiguration: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

ConfigurationServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

saveConfig

Object saveConfig(typeName, serializedConfig)

Example

import 'package:api_client/api.dart';

var api_instance = new ConfigApi();
var typeName = typeName_example; // String | 
var serializedConfig = new String(); // String | 

try { 
    var result = api_instance.saveConfig(typeName, serializedConfig);
    print(result);
} catch (e) {
    print("Exception when calling ConfigApi->saveConfig: $e\n");
}

Parameters

Name Type Description Notes
typeName String [optional]
serializedConfig String [optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

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


Last update: July 4, 2020