Skip to content

Latest commit

 

History

History
285 lines (184 loc) · 7.18 KB

VueJsApi.md

File metadata and controls

285 lines (184 loc) · 7.18 KB

swagger.api.VueJsApi

Load the API package

import 'package:swagger/api.dart';

All URIs are relative to https://localhost

Method HTTP request Description
getConfig GET /vuejs/config Return the current configuration
getExtension GET /vuejs/extension/js/{module}.js Return the front Vue JS extension file to include
getExtensionStyle GET /vuejs/extension/css/{module}.css Return the front Vue JS extension css file to include
getThemeConfig GET /vuejs/theme/{moduleId}/{themeId}/config Return the front Vue JS theme configuration
getThemeCss GET /vuejs/theme/{moduleId}/{themeId}/style.css Return the theme css file
getThemeResource GET /vuejs/theme/{moduleId}/{themeId}/resource Return the theme requested resource

getConfig

FrontConfigDTO getConfig(acceptLanguage)

Return the current configuration

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var acceptLanguage = "en"; // String | Request accepted language

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

Parameters

Name Type Description Notes
acceptLanguage String Request accepted language [optional]

Return type

FrontConfigDTO

Authorization

No authorization required

HTTP request headers

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

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

getExtension

MultipartFile getExtension(module)

Return the front Vue JS extension file to include

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var module = "opensilex"; // String | Module identifier

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

Parameters

Name Type Description Notes
module String Module identifier

Return type

MultipartFile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

getExtensionStyle

MultipartFile getExtensionStyle(module)

Return the front Vue JS extension css file to include

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var module = "opensilex"; // String | Module identifier

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

Parameters

Name Type Description Notes
module String Module identifier

Return type

MultipartFile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

getThemeConfig

ThemeConfigDTO getThemeConfig(moduleId, themeId)

Return the front Vue JS theme configuration

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var moduleId = "opensilex-front"; // String | Module identifier
var themeId = "phis"; // String | Theme identifier

try { 
    var result = api_instance.getThemeConfig(moduleId, themeId);
    print(result);
} catch (e) {
    print("Exception when calling VueJsApi->getThemeConfig: $e\n");
}

Parameters

Name Type Description Notes
moduleId String Module identifier
themeId String Theme identifier

Return type

ThemeConfigDTO

Authorization

No authorization required

HTTP request headers

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

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

getThemeCss

MultipartFile getThemeCss(moduleId, themeId)

Return the theme css file

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var moduleId = "opensilex-front"; // String | Module identifier
var themeId = "phis"; // String | Theme identifier

try { 
    var result = api_instance.getThemeCss(moduleId, themeId);
    print(result);
} catch (e) {
    print("Exception when calling VueJsApi->getThemeCss: $e\n");
}

Parameters

Name Type Description Notes
moduleId String Module identifier
themeId String Theme identifier

Return type

MultipartFile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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

getThemeResource

MultipartFile getThemeResource(moduleId, themeId, filePath)

Return the theme requested resource

Example

import 'package:swagger/api.dart';

var api_instance = new VueJsApi();
var moduleId = "opensilex-front"; // String | Module identifier
var themeId = "phis"; // String | Theme identifier
var filePath = "images/opensilex.png"; // String | Resource path

try { 
    var result = api_instance.getThemeResource(moduleId, themeId, filePath);
    print(result);
} catch (e) {
    print("Exception when calling VueJsApi->getThemeResource: $e\n");
}

Parameters

Name Type Description Notes
moduleId String Module identifier
themeId String Theme identifier
filePath String Resource path [optional]

Return type

MultipartFile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

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