Skip to content

VueJsApi.md

Latest commit

 

History

History
385 lines (255 loc) · 11.4 KB

VueJsApi.md

File metadata and controls

385 lines (255 loc) · 11.4 KB

opensilexClientToolsPython.VueJsApi

All URIs are relative to https://localhost

Method HTTP request Description
get_config GET /vuejs/config Return the current configuration
get_extension GET /vuejs/extension/js/{module}.js Return the front Vue JS extension file to include
get_extension_style GET /vuejs/extension/css/{module}.css Return the front Vue JS extension css file to include
get_theme_config GET /vuejs/theme/{moduleId}/{themeId}/config Return the front Vue JS theme configuration
get_theme_css GET /vuejs/theme/{moduleId}/{themeId}/style.css Return the theme css file
get_theme_resource GET /vuejs/theme/{moduleId}/{themeId}/resource Return the theme requested resource
get_user_config GET /vuejs/user_config Return the user-specific configuration

get_config

FrontConfigDTO get_config(accept_language=accept_language)

Return the current configuration

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)


try:
    # Return the current configuration
    api_response = api_instance.get_config()
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_config: %s\n" % e)

Parameters

Name Type Description Notes

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]

get_extension

file get_extension(module)

Return the front Vue JS extension file to include

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)
module = 'opensilex' # str | Module identifier


try:
    # Return the front Vue JS extension file to include
    api_response = api_instance.get_extension(module)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_extension: %s\n" % e)

Parameters

Name Type Description Notes
module str Module identifier

Return type

file

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]

get_extension_style

file get_extension_style(module)

Return the front Vue JS extension css file to include

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)
module = 'opensilex' # str | Module identifier


try:
    # Return the front Vue JS extension css file to include
    api_response = api_instance.get_extension_style(module)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_extension_style: %s\n" % e)

Parameters

Name Type Description Notes
module str Module identifier

Return type

file

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]

get_theme_config

ThemeConfigDTO get_theme_config(module_id, theme_id)

Return the front Vue JS theme configuration

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)
module_id = 'opensilex-front' # str | Module identifier
theme_id = 'phis' # str | Theme identifier


try:
    # Return the front Vue JS theme configuration
    api_response = api_instance.get_theme_config(module_id, theme_id)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_theme_config: %s\n" % e)

Parameters

Name Type Description Notes
module_id str Module identifier
theme_id str 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]

get_theme_css

file get_theme_css(module_id, theme_id)

Return the theme css file

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)
module_id = 'opensilex-front' # str | Module identifier
theme_id = 'phis' # str | Theme identifier


try:
    # Return the theme css file
    api_response = api_instance.get_theme_css(module_id, theme_id)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_theme_css: %s\n" % e)

Parameters

Name Type Description Notes
module_id str Module identifier
theme_id str Theme identifier

Return type

file

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]

get_theme_resource

file get_theme_resource(module_id, theme_id, file_path=file_path, accepted_extensions=accepted_extensions)

Return the theme requested resource

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)
module_id = 'opensilex-front' # str | Module identifier
theme_id = 'phis' # str | Theme identifier
file_path = 'images/opensilex.png' # str | Resource path (optional)
accepted_extensions = ['png'] # list[str] | List of supported file extensions (optional)


try:
    # Return the theme requested resource
    api_response = api_instance.get_theme_resource(module_id, theme_id, file_path=file_path, accepted_extensions=accepted_extensions)
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_theme_resource: %s\n" % e)

Parameters

Name Type Description Notes
module_id str Module identifier
theme_id str Theme identifier
file_path str Resource path [optional]
accepted_extensions list[str] List of supported file extensions [optional]

Return type

file

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]

get_user_config

UserFrontConfigDTO get_user_config(accept_language=accept_language)

Return the user-specific configuration

Example

from __future__ import print_function
import time
import opensilexClientToolsPython
from opensilexClientToolsPython.rest import ApiException
from pprint import pprint

# create an instance of the API class
pythonClient = opensilexClientToolsPython.ApiClient()
pythonClient.connect_to_opensilex_ws(identifier="guest@opensilex.org",password="guest",host="https://localhost")
api_instance = opensilexClientToolsPython.VueJsApi(pythonClient)


try:
    # Return the user-specific configuration
    api_response = api_instance.get_user_config()
    pprint(api_response)
except opensilexClientToolsPython.rest.ApiException as e:
    print("Exception when calling VueJsApi->get_user_config: %s\n" % e)

Parameters

Name Type Description Notes

Return type

UserFrontConfigDTO

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]