clientapi_atrocore.ComposerApi

All URIs are relative to https://demo.atropim.com/api/v1

Method	HTTP request	Description
cancel_module	POST /Composer/cancel	Cancel module changes
cancel_update_composer	DELETE /Composer/cancelUpdate	Cancel changes
delete_module	DELETE /Composer/deleteModule	Delete module
get_installed_modules	GET /Composer/list	Get installed modules
get_modules_logs	GET /Composer/logs	Get updates logs
install_module	POST /Composer/installModule	Install module
run_update_composer	POST /Composer/runUpdate	Run update

cancel_module

bool cancel_module(install_module_request)

Cancel module changes

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.install_module_request import InstallModuleRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)
    install_module_request = clientapi_atrocore.InstallModuleRequest() # InstallModuleRequest | 

    try:
        # Cancel module changes
        api_response = api_instance.cancel_module(install_module_request)
        print("The response of ComposerApi->cancel_module:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->cancel_module: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_module_request	InstallModuleRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

cancel_update_composer

bool cancel_update_composer()

Cancel changes

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)

    try:
        # Cancel changes
        api_response = api_instance.cancel_update_composer()
        print("The response of ComposerApi->cancel_update_composer:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->cancel_update_composer: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

delete_module

bool delete_module(id)

Delete module

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)
    id = 'id_example' # str | 

    try:
        # Delete module
        api_response = api_instance.delete_module(id)
        print("The response of ComposerApi->delete_module:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->delete_module: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

get_installed_modules

GetInstalledModules200Response get_installed_modules(select=select, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Get installed modules

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_installed_modules200_response import GetInstalledModules200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)
    select = 'name,createdAt' # str |  (optional)
    offset = 0 # int |  (optional)
    max_size = 50 # int |  (optional)
    sort_by = 'name' # str |  (optional)
    asc = true # bool |  (optional)

    try:
        # Get installed modules
        api_response = api_instance.get_installed_modules(select=select, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ComposerApi->get_installed_modules:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->get_installed_modules: %s\n" % e)

Parameters

Name	Type	Notes
select	str	[optional]
offset	int	[optional]
max_size	int	[optional]
sort_by	str	[optional]
asc	bool	[optional]

Return type

GetInstalledModules200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

get_modules_logs

GetModulesLogs200Response get_modules_logs(select=select, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)

Get updates logs

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.get_modules_logs200_response import GetModulesLogs200Response
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)
    select = 'name,createdAt' # str |  (optional)
    offset = 0 # int |  (optional)
    max_size = 50 # int |  (optional)
    sort_by = 'name' # str |  (optional)
    asc = true # bool |  (optional)

    try:
        # Get updates logs
        api_response = api_instance.get_modules_logs(select=select, offset=offset, max_size=max_size, sort_by=sort_by, asc=asc)
        print("The response of ComposerApi->get_modules_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->get_modules_logs: %s\n" % e)

Parameters

Name	Type	Notes
select	str	[optional]
offset	int	[optional]
max_size	int	[optional]
sort_by	str	[optional]
asc	bool	[optional]

Return type

GetModulesLogs200Response

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

install_module

bool install_module(install_module_request)

Install module

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.models.install_module_request import InstallModuleRequest
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)
    install_module_request = clientapi_atrocore.InstallModuleRequest() # InstallModuleRequest | 

    try:
        # Install module
        api_response = api_instance.install_module(install_module_request)
        print("The response of ComposerApi->install_module:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->install_module: %s\n" % e)

Parameters

Name	Type	Description	Notes
install_module_request	InstallModuleRequest

Return type

bool

Authorization

Authorization-Token

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

run_update_composer

bool run_update_composer()

Run update

Example

Api Key Authentication (Authorization-Token):

import time
import os
import clientapi_atrocore
from clientapi_atrocore.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://demo.atropim.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_atrocore.Configuration(
    host = "https://demo.atropim.com/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization-Token
configuration.api_key['Authorization-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization-Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_atrocore.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_atrocore.ComposerApi(api_client)

    try:
        # Run update
        api_response = api_instance.run_update_composer()
        print("The response of ComposerApi->run_update_composer:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ComposerApi->run_update_composer: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

bool

Authorization

Authorization-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
304	Not Modified	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

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

FilesExpand file tree

ComposerApi.md

Latest commit

History

ComposerApi.md

File metadata and controls

clientapi_atrocore.ComposerApi

cancel_module

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

cancel_update_composer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_module

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_installed_modules

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_modules_logs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

install_module

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

run_update_composer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details