anyLogistix
Expand
Font size

Python API

To access anyLogistix APIs you need to get the Java library.

Requirements

Python 3.7+

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 openapi_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 openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://localhost"
)
# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'
# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.OpenApiApi(api_client)
    try:
        # Closes the currently open project.
        api_response = api_instance.close_project()
        print("The response of OpenApiApi->close_project:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling OpenApiApi->close_project: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Method HTTP request Description
close_project GET /open/project/close Closes the currently open project.
create_new_variable_parameter POST /open/variations/create-variable-parameter Creates a new variable parameter.
create_variable_parameter POST /open/variations Creates a new variable parameter.
delete_variable_parameter DELETE /open/variations/delete-variable-parameter Deletes a variation parameter with identifier variationId.
does_variable_parameter_has_selected_data POST /open/variations/has-selected-data Returns whether the variable parameter with identifier variationId has the selected data in the table.
export_dashboard_page GET /open/experiments/export-page Returns an Excel representation of the dashboard page with id pageId.
find_and_open_project_by_name GET /open/project/open-by-name Opens project with name projectName.
get_comparison_result_data POST /open/experiments/comparison-result Returns comparison result data.
get_existing_variable_parameter_table_data GET /open/variations/existing-table-data Returns a table data of a variation with the given variationId.
get_experiment GET /open/experiments/experiment Returns an experiment of a given type available for a given scenario.
get_experiment_dashboard_page GET /open/experiments/dashboard-page Returns statistic page with the given pageName for the result of experiment run.
get_experiment_dashboard_pages GET /open/experiments/dashboard-pages Returns statistics pages for the result of experiment run.
get_experiment_options POST /open/experiments/options Returns a list of possible values for various experiment options.
get_experiment_run_configuration GET /open/experiments/get-run-configuration Returns experiment settings.
get_experiment_run_result GET /open/experiments/result Returns all the results of the specific experiment run.
get_experiment_run_result_chart_graph_data GET /open/experiments/chart-graph-data Returns graph data for the chart with identifier chartId.
get_experiment_run_result_chart_table_data GET /open/experiments/chart-table-data Returns table data for the chart with identifier chartId.
get_experiment_run_result_options GET /open/experiments/result-options Returns options for the result of experiment run.
get_experiment_run_result_page_charts GET /open/experiments/charts Returns charts on the statistics page with the identifier pageId.
get_experiment_run_result_pages GET /open/experiments/pages Returns statistics pages for the result of experiment run.
get_experiment_runs_for_scenario GET /open/experiments/results Returns the results of experiment runs for scenario.
get_experiment_status GET /open/experiments/status Returns the experiment status.
get_experiments GET /open/experiments/list Returns a list of experiments available for a given scenario.
get_import_status GET /open/import/import-status Returns scenario import status.
get_new_variable_parameter_table_data GET /open/variations/new-table-data Returns a table data of a variation with the given variationId.
get_projects GET /open/project/list Returns a list of projects that the user has access to.
get_scenario_validation_status GET /open/experiments/validation-status Returns the validation status of the scenario.
get_scenarios_from_imported_database POST /open/import/scenarios-available-for-import Returns a list of scenarios available for import in the imported database.
get_validation_errors GET /open/experiments/validation-errors Returns validation errors.
get_validation_warnings GET /open/experiments/validation-warnings Returns validation warnings.
get_variable_parameter_object_type GET /open/variations/object-type Return a list of object types that have variable parameters.
get_variable_parameter_object_types GET /open/variations/object-types Returns a list of object types that have variable parameters.
get_variable_parameter_objects GET /open/variations/objects Returns a list of variable parameter objects of the given object type with identifier objectTypeId.
get_variable_parameter_parameters GET /open/variations/parameters Returns a list of parameters of an object with id objectId with type with id objectTypeId.
get_variable_parameter_variation_types GET /open/variations/variation-types Returns a list of parameter variation types for a parameter with id parameterId belonging to an object with id objectId with a type with id objectTypeId.
get_variation_result_data POST /open/experiments/variation-result Returns variation result data.
import_cancel POST /open/import/import-cancel Cancels scenario import job.
import_database POST /open/import/import-database Imports scenarios from the list sourceScenarioNameList from an external database.
import_database_existing POST /open/import/import-database-existing Imports scenario sourceScenarioName from an external database into existing scenario.
import_excel POST /open/import/import-excel Imports scenario from excel file.
import_excel_existing POST /open/import/import-excel-existing Imports scenario from excel file into existing scenario.
import_scenario POST /open/import/import-scenario Import excel
open_project GET /open/project/open Opens project with identifier projectId.
remove_scenario_by_id DELETE /open/scenario Deletes a scenario.
run_experiment GET /open/experiments/run Starts the experiment asynchronously.
run_experiment_synchronously GET /open/experiments/run-synchronously Starts the experiment synchronously.
stop_experiment GET /open/experiments/stop Stops the experiment.
update_existing_variable_parameter_table_data_by_index POST /open/variations/update-table-data-by-index Updates a variation table data by index.
update_experiment_run_configuration POST /open/experiments/update-run-configuration Updates experiment settings.
update_variable_parameter PUT /open/variations/update-variable-parameter Updates the variation parameter represented by the variation object.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header
How can we improve this article?