multiflexi-api-client

MultiFlexi API provides comprehensive access to job execution, application management, and user data operations. The API includes GDPR compliance endpoints for data export (Article 15 - Right of Access) and uses OAuth2 Application Flow for security.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.2.0
• Package version: 1.1.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import multiflexi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import multiflexi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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"
)

# 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 HTTP basic authorization: basicAuth
configuration = multiflexi_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# 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.AppApi(api_client)
    app_id = 56 # int | ID of app to return
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Get App by ID
        api_response = api_instance.get_app_by_id(app_id, suffix, limit=limit)
        print("The response of AppApi->get_app_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AppApi->get_app_by_id: %s\n" % e)

Documentation for API Endpoints

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

Documentation For Models

• App
• AppEnvironmentValue
• AppExitCodesInner
• Company
• ConfField
• Configuration
• Credential
• CredentialType
• Customer
• DataExportData
• DataExportDataActivityLogsInner
• DataExportDataAuditTrails
• DataExportDataAuditTrailsDataExportRequestsInner
• DataExportDataCompanyAssociationsInner
• DataExportDataConsentRecords
• DataExportDataConsentRecordsConsentAuditTrailInner
• DataExportDataConsentRecordsConsentRecordsInner
• DataExportDataCredentialsInner
• DataExportDataExportMetadata
• DataExportDataJobHistoryInner
• DataExportDataSessionHistory
• DataExportDataSessionHistoryCurrentSessionInfo
• DataExportDataUserProfile
• DataExportResponse
• DataExportStatusResponse
• DataExportStatusResponseExportsInner
• ErrorResponse
• GetCredentialType200Response
• GetTopic200Response
• Job
• JobsStatus
• LogoutPostRequest
• RequestDataExport200Response
• RequestDataExportPostRequest
• RunTemplate
• Status
• Tag
• Topic
• UpdateCredentials201Response
• UpdateRunTemplateById400Response
• UpdateRunTemplateById404Response
• UpdateRunTemplateById500Response
• UpdateRunTemplateByIdRequest
• User

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Author