multiflexi_client.DefaultApi

All URIs are relative to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0

Method	HTTP request	Description
get_api_index	GET /index.{suffix}	Endpoints listing
get_jobs_status	GET /jobs/status.{suffix}	Get Jobs Status
login_suffix_get	GET /login.{suffix}	Return User's token
login_suffix_post	POST /login.{suffix}	Return User's token
logout_post	POST /logout	Odhlášení uživatele (invalidate token/session)
ping_suffix_get	GET /ping.{suffix}	job heartbeat operation
root_get	GET /	Redirect to index
status_suffix_get	GET /status.{suffix}	Get API status

get_api_index

get_api_index(suffix, limit=limit)

Endpoints listing

Show current API

Example

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Endpoints listing
        api_instance.get_api_index(suffix, limit=limit)
    except Exception as e:
        print("Exception when calling DefaultApi->get_api_index: %s\n" % e)

Parameters

Name	Type	Description	Notes
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_jobs_status

List[JobsStatus] get_jobs_status(suffix, limit=limit)

Get Jobs Status

Retrieve all jobs status

Example

import multiflexi_client
from multiflexi_client.models.jobs_status import JobsStatus
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Get Jobs Status
        api_response = api_instance.get_jobs_status(suffix, limit=limit)
        print("The response of DefaultApi->get_jobs_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_jobs_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

List[JobsStatus]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
401	Authentication information is missing or invalid	* WWW_Authenticate -

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

login_suffix_get

login_suffix_get(username, password, suffix, limit=limit)

Return User's token

Send login & password to obtain oAuth token

Example

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    username = 'username_example' # str | existing user name
    password = 'password_example' # str | existing user password
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Return User's token
        api_instance.login_suffix_get(username, password, suffix, limit=limit)
    except Exception as e:
        print("Exception when calling DefaultApi->login_suffix_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	existing user name
password	str	existing user password
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201	OK	-

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

login_suffix_post

login_suffix_post(username, password, suffix, limit=limit)

Return User's token

Send login & password to obtain oAuth token

Example

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    username = 'username_example' # str | existing user name
    password = 'password_example' # str | existing user password
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Return User's token
        api_instance.login_suffix_post(username, password, suffix, limit=limit)
    except Exception as e:
        print("Exception when calling DefaultApi->login_suffix_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	existing user name
password	str	existing user password
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201	OK	-

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

logout_post

logout_post(logout_post_request)

Odhlášení uživatele (invalidate token/session)

Invalidační aktuální uživatelskou session nebo token (OAuth2, JWT, případně session cookie).

Example

import multiflexi_client
from multiflexi_client.models.logout_post_request import LogoutPostRequest
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    logout_post_request = multiflexi_client.LogoutPostRequest() # LogoutPostRequest | 

    try:
        # Odhlášení uživatele (invalidate token/session)
        api_instance.logout_post(logout_post_request)
    except Exception as e:
        print("Exception when calling DefaultApi->logout_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
logout_post_request	LogoutPostRequest

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Odhlášení proběhlo úspěšně	-
401	Uživatel není přihlášen nebo token je neplatný	-

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

ping_suffix_get

ping_suffix_get(suffix, limit=limit)

job heartbeat operation

This operation shows how to override the global security defined above, as we want to open it up for all users.

Example

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # job heartbeat operation
        api_instance.ping_suffix_get(suffix, limit=limit)
    except Exception as e:
        print("Exception when calling DefaultApi->ping_suffix_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	OK	-

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

root_get

root_get(limit=limit)

Redirect to index

Example

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Redirect to index
        api_instance.root_get(limit=limit)
    except Exception as e:
        print("Exception when calling DefaultApi->root_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
301	redirect to index.html	-

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

status_suffix_get

Status status_suffix_get(suffix, limit=limit)

Get API status

This operation shows how to override the global security defined above, as we want to open it up for all users.

Example

import multiflexi_client
from multiflexi_client.models.status import Status
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.DefaultApi(api_client)
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Get API status
        api_response = api_instance.status_suffix_get(suffix, limit=limit)
        print("The response of DefaultApi->status_suffix_get:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->status_suffix_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
suffix	str	force format suffix	[default to html]
limit	int	maximum number of results to return	[optional] [default to 20]

Return type

Status

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Uh oh!

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

multiflexi_client.DefaultApi

get_api_index

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_jobs_status

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

login_suffix_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

login_suffix_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

logout_post

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ping_suffix_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

root_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

status_suffix_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details