Metadata-Version: 2.4
Name: vrt_lss_studio
Version: 7.37.3331
Summary: VRt.Studio [ST]
Home-page: 
Author: Veeroute Support Team
Author-email: Veeroute Support Team <support@veeroute.com>
License: Proprietary
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,VRt.Studio [ST]
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# vrt_lss_studio
Programming interface for the Veeroute Studio tool.

# Description

The server side of Veeroute Studio.

## Reserved attributes

These attribute keys are reserved for specific business logic:

| Attribute key        | Parent entity         | Purpose                                                                                                                                                                                                |
| ---------------------| ----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `ICON_NAME`          | location              | The attribute value is written into the `web_location_geopoint.icon_name` field                                                                                                                        |
| `FORCED_GEOPROVIDER` | geo_settings          | The attribute value defines the geo data provider used for drawing trips on the map; it will be used instead of the value specified in `plan_settings.geo_settings.geo_provider`                       |
| `TRIP_VERIFIED`      | trip                  | The attribute value indicates whether the trip has been verified and approved manually                                                                                                                 |

Usage example — overriding the geo provider for drawing trips in Studio:

{
    \"plan_settings\": {
        \"geo_settings\": {
            \"attributes\": [
                {
                    \"key\": \"FORCED_GEOPROVIDER\",
                    \"value\": \"OSRM_EXTERNAL\"
                }
            ]
        }
    }
}

## Additional attributes

Rules for processing additional attributes when using Universal Extension:

* If the entity key does not exist — such an additional attribute is ignored
* If the attribute key for the entity already exists — the attribute value will be overwritten after the calculation finishes

## Roles

Restrictions on working with a virtual folder:

* After creation, a folder cannot change its owner or company.
* When a new folder is created not in ROOT, it inherits the owner and the company from the parent folder.

Effect of the account role on the virtual file system:

### ADMIN, PARTNER, USER, BOT

* Access only to one's own folders (`folder.owner_username = account.username`) and to files inside those folders
* Ability to open any other user's files for editing via a direct file link

### COMPANYOWNER

* Access only to folders of one's own company (`folder.owner_company_key = account.company_key`) and to files inside those folders
* Ability to open any other user's files for editing via a direct file link

### OVERLORD

* Access to all folders in the environment (`folder.owner_company_key = *`) and to files inside those folders

## Entity diagram

![erd](../uml/studio.svg)


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.37.3331
- Package version: 7.37.3331
- Generator version: 7.17.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:

```sh
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:
```python
import vrt_lss_studio
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import vrt_lss_studio
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import vrt_lss_studio
from vrt_lss_studio.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_studio.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# 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 Bearer authorization (JWT): ApiKeyAuth
configuration = vrt_lss_studio.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_studio.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_studio.BackupsApi(api_client)
    target_folder_key = 'target_folder_key_example' # str | Folder key, unique identifier.

    try:
        # Folder export
        api_response = api_instance.create_backup(target_folder_key)
        print("The response of BackupsApi->create_backup:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->create_backup: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.edge7.veeroute.cloud*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BackupsApi* | [**create_backup**](docs/BackupsApi.md#create_backup) | **POST** /studio/backups/{target_folder_key} | Folder export
*BackupsApi* | [**restore_backup**](docs/BackupsApi.md#restore_backup) | **PUT** /studio/backups/{target_folder_key} | Folder import
*CustomFieldsApi* | [**create_customfields_settings**](docs/CustomFieldsApi.md#create_customfields_settings) | **POST** /studio/settings/customfields/{settings_key} | Create fields settings
*CustomFieldsApi* | [**delete_customfields_settings**](docs/CustomFieldsApi.md#delete_customfields_settings) | **DELETE** /studio/settings/customfields/{settings_key} | Delete fields settings
*CustomFieldsApi* | [**list_customfields_settings**](docs/CustomFieldsApi.md#list_customfields_settings) | **GET** /studio/settings/customfields | Reading fields settings list
*CustomFieldsApi* | [**read_customfields_settings**](docs/CustomFieldsApi.md#read_customfields_settings) | **GET** /studio/settings/customfields/{settings_key} | Reading fields settings
*CustomFieldsApi* | [**set_customfields_settings_active_key**](docs/CustomFieldsApi.md#set_customfields_settings_active_key) | **POST** /studio/settings/customfields | Setting the active customfields key
*CustomFieldsApi* | [**update_customfields_settings**](docs/CustomFieldsApi.md#update_customfields_settings) | **PUT** /studio/settings/customfields/{settings_key} | Update fields settings
*CustomIconsApi* | [**create_customicons_settings**](docs/CustomIconsApi.md#create_customicons_settings) | **POST** /studio/settings/customicons/{settings_key} | Update icons settings
*CustomIconsApi* | [**delete_customicons_settings**](docs/CustomIconsApi.md#delete_customicons_settings) | **DELETE** /studio/settings/customicons/{settings_key} | Delete icons settings
*CustomIconsApi* | [**list_customicons_settings**](docs/CustomIconsApi.md#list_customicons_settings) | **GET** /studio/settings/customicons | Reading icons settings list
*CustomIconsApi* | [**read_customicons_settings**](docs/CustomIconsApi.md#read_customicons_settings) | **GET** /studio/settings/customicons/{settings_key} | Reading icons settings
*CustomIconsApi* | [**set_customicons_settings_active_key**](docs/CustomIconsApi.md#set_customicons_settings_active_key) | **POST** /studio/settings/customicons | Setting the active customicons key
*CustomIconsApi* | [**update_customicons_settings**](docs/CustomIconsApi.md#update_customicons_settings) | **PUT** /studio/settings/customicons/{settings_key} | Update icons settings
*ExperimentsApi* | [**create_experiment**](docs/ExperimentsApi.md#create_experiment) | **POST** /studio/experiments | Create experiment
*ExperimentsApi* | [**delete_experiment**](docs/ExperimentsApi.md#delete_experiment) | **DELETE** /studio/experiments/{file_key} | Experiment removal
*ExperimentsApi* | [**duplicate_experiment**](docs/ExperimentsApi.md#duplicate_experiment) | **POST** /studio/experiments/{file_key}/duplication | Experiment duplicate
*ExperimentsApi* | [**export_json**](docs/ExperimentsApi.md#export_json) | **POST** /studio/experiments/{file_key}/export/json | Export (JSON)
*ExperimentsApi* | [**export_xlsx**](docs/ExperimentsApi.md#export_xlsx) | **POST** /studio/experiments/{file_key}/export/xlsx | Export (XLSX)
*ExperimentsApi* | [**global_search**](docs/ExperimentsApi.md#global_search) | **GET** /studio/experiments/search/global | Experiment search
*ExperimentsApi* | [**import_json**](docs/ExperimentsApi.md#import_json) | **POST** /studio/experiments/{file_key}/import/json | Import (JSON)
*ExperimentsApi* | [**import_json_tracedata**](docs/ExperimentsApi.md#import_json_tracedata) | **POST** /studio/experiments/{file_key}/import/json-tracedata/{source}/{process_code}/{sample} | Import by tracedata
*ExperimentsApi* | [**import_json_url**](docs/ExperimentsApi.md#import_json_url) | **POST** /studio/experiments/{file_key}/import/json-url | Import by URL (JSON)
*ExperimentsApi* | [**import_xlsx**](docs/ExperimentsApi.md#import_xlsx) | **POST** /studio/experiments/{file_key}/import/xlsx | Import (XLSX)
*ExperimentsApi* | [**read_experiment**](docs/ExperimentsApi.md#read_experiment) | **GET** /studio/experiments/{file_key} | Reading experiment
*ExperimentsApi* | [**read_experiment_calculation_history**](docs/ExperimentsApi.md#read_experiment_calculation_history) | **GET** /studio/experiments/{file_key}/calculation-history | Calculation history
*ExperimentsApi* | [**read_experiment_neighbors**](docs/ExperimentsApi.md#read_experiment_neighbors) | **GET** /studio/experiments/{file_key}/neighbors | Experiment neighbors
*ExperimentsApi* | [**read_experiment_path**](docs/ExperimentsApi.md#read_experiment_path) | **GET** /studio/experiments/{file_key}/path | Experiment path
*ExperimentsApi* | [**read_folder**](docs/ExperimentsApi.md#read_folder) | **GET** /studio/experiments | Experiment list (table)
*ExperimentsApi* | [**run_experiment_calculation**](docs/ExperimentsApi.md#run_experiment_calculation) | **POST** /studio/experiments/{file_key}/calculation/{process_name} | Run calculation
*ExperimentsApi* | [**run_experiment_recalculate_stats**](docs/ExperimentsApi.md#run_experiment_recalculate_stats) | **POST** /studio/experiments/{file_key}/recalculate-stats | Recalculate stats
*ExperimentsApi* | [**run_experiment_recalculate_tracks**](docs/ExperimentsApi.md#run_experiment_recalculate_tracks) | **POST** /studio/experiments/{file_key}/recalculate-tracks | Recalculate tracks
*ExperimentsApi* | [**run_experiment_refine**](docs/ExperimentsApi.md#run_experiment_refine) | **POST** /studio/experiments/{file_key}/refine/{process_name} | Run refine
*ExperimentsApi* | [**run_experiment_validation**](docs/ExperimentsApi.md#run_experiment_validation) | **POST** /studio/experiments/{file_key}/validation/{process_name} | Run validation
*ExperimentsApi* | [**stop_experiment_calculation**](docs/ExperimentsApi.md#stop_experiment_calculation) | **DELETE** /studio/experiments/{file_key}/calculation/{process_name} | Calculation stop
*ExperimentsApi* | [**update_experiment**](docs/ExperimentsApi.md#update_experiment) | **PUT** /studio/experiments/{file_key} | Experiment update
*ExperimentsApi* | [**update_experiment_indicators**](docs/ExperimentsApi.md#update_experiment_indicators) | **PUT** /studio/experiments/{file_key}/indicators | Indicators update
*ExperimentsApi* | [**update_experiment_settings**](docs/ExperimentsApi.md#update_experiment_settings) | **PUT** /studio/experiments/{file_key}/settings | Settings update
*ExplorerApi* | [**create_folder**](docs/ExplorerApi.md#create_folder) | **POST** /studio/explorer | Create folder
*ExplorerApi* | [**create_folders_batch**](docs/ExplorerApi.md#create_folders_batch) | **POST** /studio/explorer/batch/folders | Create folders (batch)
*ExplorerApi* | [**delete_files_batch**](docs/ExplorerApi.md#delete_files_batch) | **DELETE** /studio/explorer/batch/files | Files removal (batch)
*ExplorerApi* | [**delete_folder**](docs/ExplorerApi.md#delete_folder) | **DELETE** /studio/explorer/{target_folder_key} | Folder removal
*ExplorerApi* | [**delete_folders_batch**](docs/ExplorerApi.md#delete_folders_batch) | **DELETE** /studio/explorer/batch/folders | Folders removal (batch)
*ExplorerApi* | [**disable_sharing_batch**](docs/ExplorerApi.md#disable_sharing_batch) | **DELETE** /studio/explorer/batch/sharing | Disable sharing (batch)
*ExplorerApi* | [**enable_sharing_batch**](docs/ExplorerApi.md#enable_sharing_batch) | **PUT** /studio/explorer/batch/sharing | Enable sharing (batch)
*ExplorerApi* | [**read_file_key**](docs/ExplorerApi.md#read_file_key) | **GET** /studio/explorer/batch/files | File key
*ExplorerApi* | [**read_filesystem**](docs/ExplorerApi.md#read_filesystem) | **GET** /studio/explorer | Getting a filesystem
*ExplorerApi* | [**read_filesystem_counters**](docs/ExplorerApi.md#read_filesystem_counters) | **GET** /studio/explorer/batch/counters | Filesystem counters
*ExplorerApi* | [**read_folder_key**](docs/ExplorerApi.md#read_folder_key) | **POST** /studio/explorer/batch/folder-key | Folder key
*ExplorerApi* | [**read_folder_path**](docs/ExplorerApi.md#read_folder_path) | **GET** /studio/explorer/{target_folder_key}/path | Folder path
*ExplorerApi* | [**read_folder_specification**](docs/ExplorerApi.md#read_folder_specification) | **GET** /studio/explorer/{target_folder_key}/specification | Folder specification
*ExplorerApi* | [**update_folder**](docs/ExplorerApi.md#update_folder) | **PUT** /studio/explorer/{target_folder_key} | Update folder
*ExternalRoutingApi* | [**create_externalrouting**](docs/ExternalRoutingApi.md#create_externalrouting) | **POST** /studio/experiments/{file_key}/externalrouting | Create externalrouting
*ExternalRoutingApi* | [**delete_externalrouting**](docs/ExternalRoutingApi.md#delete_externalrouting) | **DELETE** /studio/experiments/{file_key}/externalrouting | Deleting externalrouting
*ExternalRoutingApi* | [**read_externalrouting**](docs/ExternalRoutingApi.md#read_externalrouting) | **GET** /studio/experiments/{file_key}/externalrouting | Read externalrouting
*ExternalRoutingApi* | [**update_externalrouting**](docs/ExternalRoutingApi.md#update_externalrouting) | **PUT** /studio/experiments/{file_key}/externalrouting | Update externalrouting
*FactsApi* | [**create_fact**](docs/FactsApi.md#create_fact) | **POST** /studio/experiments/{file_key}/facts | Create fact
*FactsApi* | [**delete_fact**](docs/FactsApi.md#delete_fact) | **DELETE** /studio/experiments/{file_key}/facts/{essence_key} | Deleting one fact
*FactsApi* | [**delete_facts_batch**](docs/FactsApi.md#delete_facts_batch) | **DELETE** /studio/experiments/{file_key}/facts/batch/table | Delete facts (batch)
*FactsApi* | [**disable_facts_batch**](docs/FactsApi.md#disable_facts_batch) | **DELETE** /studio/experiments/{file_key}/facts/batch/ability | Disable facts
*FactsApi* | [**enable_facts_batch**](docs/FactsApi.md#enable_facts_batch) | **PUT** /studio/experiments/{file_key}/facts/batch/ability | Enable facts
*FactsApi* | [**read_fact**](docs/FactsApi.md#read_fact) | **GET** /studio/experiments/{file_key}/facts/{essence_key} | Read fact
*FactsApi* | [**read_facts_metrics**](docs/FactsApi.md#read_facts_metrics) | **POST** /studio/experiments/{file_key}/facts/batch/metrics | Fact metrics
*FactsApi* | [**read_facts_table**](docs/FactsApi.md#read_facts_table) | **POST** /studio/experiments/{file_key}/facts/batch/table | List of facts
*FactsApi* | [**update_fact**](docs/FactsApi.md#update_fact) | **PUT** /studio/experiments/{file_key}/facts | Update fact
*HardlinksApi* | [**create_hardlink**](docs/HardlinksApi.md#create_hardlink) | **POST** /studio/experiments/{file_key}/hardlinks | Create hardlink
*HardlinksApi* | [**delete_hardlink**](docs/HardlinksApi.md#delete_hardlink) | **DELETE** /studio/experiments/{file_key}/hardlinks/{essence_key} | Remove hardlink
*HardlinksApi* | [**delete_hardlinks_batch**](docs/HardlinksApi.md#delete_hardlinks_batch) | **DELETE** /studio/experiments/{file_key}/hardlinks/batch/table | Delete hardlinks (batch)
*HardlinksApi* | [**disable_hardlinks_batch**](docs/HardlinksApi.md#disable_hardlinks_batch) | **DELETE** /studio/experiments/{file_key}/hardlinks/batch/ability | Disable hardlinks
*HardlinksApi* | [**enable_hardlinks_batch**](docs/HardlinksApi.md#enable_hardlinks_batch) | **PUT** /studio/experiments/{file_key}/hardlinks/batch/ability | Enable hardlinks
*HardlinksApi* | [**read_hardlink**](docs/HardlinksApi.md#read_hardlink) | **GET** /studio/experiments/{file_key}/hardlinks/{essence_key} | Read hardlink
*HardlinksApi* | [**read_hardlinks_metrics**](docs/HardlinksApi.md#read_hardlinks_metrics) | **POST** /studio/experiments/{file_key}/hardlinks/batch/metrics | Hardlink metrics
*HardlinksApi* | [**read_hardlinks_table**](docs/HardlinksApi.md#read_hardlinks_table) | **POST** /studio/experiments/{file_key}/hardlinks/batch/table | List hardlinks
*HardlinksApi* | [**update_hardlink**](docs/HardlinksApi.md#update_hardlink) | **PUT** /studio/experiments/{file_key}/hardlinks | Update hardlink
*LocationsApi* | [**create_location**](docs/LocationsApi.md#create_location) | **POST** /studio/experiments/{file_key}/locations | Create location
*LocationsApi* | [**delete_location**](docs/LocationsApi.md#delete_location) | **DELETE** /studio/experiments/{file_key}/locations/{essence_key} | Remove location
*LocationsApi* | [**delete_locations_batch**](docs/LocationsApi.md#delete_locations_batch) | **DELETE** /studio/experiments/{file_key}/locations/batch/table | Delete locations (batch)
*LocationsApi* | [**read_location**](docs/LocationsApi.md#read_location) | **GET** /studio/experiments/{file_key}/locations/{essence_key} | Read location
*LocationsApi* | [**read_locations_geopoints**](docs/LocationsApi.md#read_locations_geopoints) | **POST** /studio/experiments/{file_key}/locations/batch/geopoints | Location geopoints
*LocationsApi* | [**read_locations_metrics**](docs/LocationsApi.md#read_locations_metrics) | **POST** /studio/experiments/{file_key}/locations/batch/metrics | Location metrics
*LocationsApi* | [**read_locations_table**](docs/LocationsApi.md#read_locations_table) | **POST** /studio/experiments/{file_key}/locations/batch/table | Locations list
*LocationsApi* | [**update_location**](docs/LocationsApi.md#update_location) | **PUT** /studio/experiments/{file_key}/locations | Update location
*OrdersApi* | [**create_order**](docs/OrdersApi.md#create_order) | **POST** /studio/experiments/{file_key}/orders | Create order
*OrdersApi* | [**delete_order**](docs/OrdersApi.md#delete_order) | **DELETE** /studio/experiments/{file_key}/orders/{essence_key} | Deleting one order
*OrdersApi* | [**delete_orders_batch**](docs/OrdersApi.md#delete_orders_batch) | **DELETE** /studio/experiments/{file_key}/orders/batch/table | Delete orders (batch)
*OrdersApi* | [**disable_orders_batch**](docs/OrdersApi.md#disable_orders_batch) | **DELETE** /studio/experiments/{file_key}/orders/batch/ability | Disable orders
*OrdersApi* | [**enable_orders_batch**](docs/OrdersApi.md#enable_orders_batch) | **PUT** /studio/experiments/{file_key}/orders/batch/ability | Enable orders
*OrdersApi* | [**read_order**](docs/OrdersApi.md#read_order) | **GET** /studio/experiments/{file_key}/orders/{essence_key} | Reading order
*OrdersApi* | [**read_orders_geopoints**](docs/OrdersApi.md#read_orders_geopoints) | **POST** /studio/experiments/{file_key}/orders/batch/geopoints | Order geopoints
*OrdersApi* | [**read_orders_metrics**](docs/OrdersApi.md#read_orders_metrics) | **POST** /studio/experiments/{file_key}/orders/batch/metrics | Order metrics
*OrdersApi* | [**read_orders_table**](docs/OrdersApi.md#read_orders_table) | **POST** /studio/experiments/{file_key}/orders/batch/table | List orders
*OrdersApi* | [**update_order**](docs/OrdersApi.md#update_order) | **PUT** /studio/experiments/{file_key}/orders | Update order
*PerformersApi* | [**create_performer**](docs/PerformersApi.md#create_performer) | **POST** /studio/experiments/{file_key}/performers | Create performer
*PerformersApi* | [**delete_performer**](docs/PerformersApi.md#delete_performer) | **DELETE** /studio/experiments/{file_key}/performers/{essence_key} | Remove performer
*PerformersApi* | [**delete_performers_batch**](docs/PerformersApi.md#delete_performers_batch) | **DELETE** /studio/experiments/{file_key}/performers/batch/table | Delete performers (batch)
*PerformersApi* | [**disable_performers_batch**](docs/PerformersApi.md#disable_performers_batch) | **DELETE** /studio/experiments/{file_key}/performers/batch/ability | Disable performers
*PerformersApi* | [**enable_performers_batch**](docs/PerformersApi.md#enable_performers_batch) | **PUT** /studio/experiments/{file_key}/performers/batch/ability | Enable performers
*PerformersApi* | [**read_performer**](docs/PerformersApi.md#read_performer) | **GET** /studio/experiments/{file_key}/performers/{essence_key} | Read performer
*PerformersApi* | [**read_performers_geopoints**](docs/PerformersApi.md#read_performers_geopoints) | **POST** /studio/experiments/{file_key}/performers/batch/geopoints | Performer geopoints
*PerformersApi* | [**read_performers_metrics**](docs/PerformersApi.md#read_performers_metrics) | **POST** /studio/experiments/{file_key}/performers/batch/metrics | Performer metrics
*PerformersApi* | [**read_performers_table**](docs/PerformersApi.md#read_performers_table) | **POST** /studio/experiments/{file_key}/performers/batch/table | Performers list
*PerformersApi* | [**update_performer**](docs/PerformersApi.md#update_performer) | **PUT** /studio/experiments/{file_key}/performers | Update performer
*SystemApi* | [**check**](docs/SystemApi.md#check) | **GET** /studio/system/check | Checking the availability
*SystemApi* | [**file**](docs/SystemApi.md#file) | **GET** /studio/file/{filename} | Getting the documentation
*SystemApi* | [**version**](docs/SystemApi.md#version) | **GET** /studio/system/version | Getting the service version
*TransportsApi* | [**create_transport**](docs/TransportsApi.md#create_transport) | **POST** /studio/experiments/{file_key}/transports | Create transport
*TransportsApi* | [**delete_transport**](docs/TransportsApi.md#delete_transport) | **DELETE** /studio/experiments/{file_key}/transports/{essence_key} | Remove transport
*TransportsApi* | [**delete_transports_batch**](docs/TransportsApi.md#delete_transports_batch) | **DELETE** /studio/experiments/{file_key}/transports/batch/table | Delete transports (batch)
*TransportsApi* | [**disable_transports_batch**](docs/TransportsApi.md#disable_transports_batch) | **DELETE** /studio/experiments/{file_key}/transports/batch/ability | Disable transports
*TransportsApi* | [**enable_transports_batch**](docs/TransportsApi.md#enable_transports_batch) | **PUT** /studio/experiments/{file_key}/transports/batch/ability | Enable transports
*TransportsApi* | [**read_transport**](docs/TransportsApi.md#read_transport) | **GET** /studio/experiments/{file_key}/transports/{essence_key} | Reading transport
*TransportsApi* | [**read_transports_geopoints**](docs/TransportsApi.md#read_transports_geopoints) | **POST** /studio/experiments/{file_key}/transports/batch/geopoints | Transport geopoints
*TransportsApi* | [**read_transports_metrics**](docs/TransportsApi.md#read_transports_metrics) | **POST** /studio/experiments/{file_key}/transports/batch/metrics | Transport metrics
*TransportsApi* | [**read_transports_table**](docs/TransportsApi.md#read_transports_table) | **POST** /studio/experiments/{file_key}/transports/batch/table | Transport list
*TransportsApi* | [**update_transport**](docs/TransportsApi.md#update_transport) | **PUT** /studio/experiments/{file_key}/transports | Update transport
*TripsApi* | [**approve_trips_batch**](docs/TripsApi.md#approve_trips_batch) | **PUT** /studio/experiments/{file_key}/trips/batch/verification | Approve trips (batch)
*TripsApi* | [**create_trip**](docs/TripsApi.md#create_trip) | **POST** /studio/experiments/{file_key}/trips | Trip create
*TripsApi* | [**delete_custom_tracks**](docs/TripsApi.md#delete_custom_tracks) | **DELETE** /studio/experiments/{file_key}/trips/batch/tracks-custom | Remove custom tracks
*TripsApi* | [**delete_trip**](docs/TripsApi.md#delete_trip) | **DELETE** /studio/experiments/{file_key}/trips/{essence_key} | Delete trip
*TripsApi* | [**delete_trips_batch**](docs/TripsApi.md#delete_trips_batch) | **DELETE** /studio/experiments/{file_key}/trips/batch/table | Delete trips (batch)
*TripsApi* | [**load_custom_tracks**](docs/TripsApi.md#load_custom_tracks) | **POST** /studio/experiments/{file_key}/trips/batch/tracks-custom | Load custom tracks
*TripsApi* | [**read_roundtrips_metrics**](docs/TripsApi.md#read_roundtrips_metrics) | **POST** /studio/experiments/{file_key}/roundtrips/batch/metrics | Roundrips metrics
*TripsApi* | [**read_roundtrips_table**](docs/TripsApi.md#read_roundtrips_table) | **POST** /studio/experiments/{file_key}/roundtrips/batch/table | Reading roundrips (table)
*TripsApi* | [**read_trip**](docs/TripsApi.md#read_trip) | **GET** /studio/experiments/{file_key}/trips/{essence_key} | Read trip
*TripsApi* | [**read_trip_stops**](docs/TripsApi.md#read_trip_stops) | **POST** /studio/experiments/{file_key}/trips/{essence_key}/stops/batch/table | Trip stops list
*TripsApi* | [**read_trips_charts**](docs/TripsApi.md#read_trips_charts) | **POST** /studio/experiments/{file_key}/trips/batch/charts | Trips chart
*TripsApi* | [**read_trips_metrics**](docs/TripsApi.md#read_trips_metrics) | **POST** /studio/experiments/{file_key}/trips/batch/metrics | Trips metrics
*TripsApi* | [**read_trips_table**](docs/TripsApi.md#read_trips_table) | **POST** /studio/experiments/{file_key}/trips/batch/table | Reading trips (table)
*TripsApi* | [**read_trips_tracks**](docs/TripsApi.md#read_trips_tracks) | **POST** /studio/experiments/{file_key}/trips/batch/tracks/{tracks_type} | Trip tracks
*TripsApi* | [**reject_trips_batch**](docs/TripsApi.md#reject_trips_batch) | **DELETE** /studio/experiments/{file_key}/trips/batch/verification | Reject trips (batch)
*TripsApi* | [**update_trip**](docs/TripsApi.md#update_trip) | **PUT** /studio/experiments/{file_key}/trips | Trip update
*UserApi* | [**create_user_settings**](docs/UserApi.md#create_user_settings) | **POST** /studio/settings/user/{settings_key} | Create user settings
*UserApi* | [**delete_user_settings**](docs/UserApi.md#delete_user_settings) | **DELETE** /studio/settings/user/{settings_key} | Delete user settings
*UserApi* | [**list_user_settings**](docs/UserApi.md#list_user_settings) | **GET** /studio/settings/user | Reading user settings list
*UserApi* | [**read_user_settings**](docs/UserApi.md#read_user_settings) | **GET** /studio/settings/user/{settings_key} | Reading user settings
*UserApi* | [**set_user_settings_active_key**](docs/UserApi.md#set_user_settings_active_key) | **POST** /studio/settings/user | Setting the active user settings key
*UserApi* | [**update_user_settings**](docs/UserApi.md#update_user_settings) | **PUT** /studio/settings/user/{settings_key} | Update user settings


## Documentation For Models

 - [ActualizeSettings](docs/ActualizeSettings.md)
 - [AssignedPerformer](docs/AssignedPerformer.md)
 - [AssignedTransport](docs/AssignedTransport.md)
 - [Attribute](docs/Attribute.md)
 - [BasicProcess](docs/BasicProcess.md)
 - [BasicState](docs/BasicState.md)
 - [Box](docs/Box.md)
 - [BoxCompatibilities](docs/BoxCompatibilities.md)
 - [BoxLimits](docs/BoxLimits.md)
 - [BreakRules](docs/BreakRules.md)
 - [CalculationHistoryElement](docs/CalculationHistoryElement.md)
 - [CalculationInfo](docs/CalculationInfo.md)
 - [CalculationSettings](docs/CalculationSettings.md)
 - [CalculationState](docs/CalculationState.md)
 - [CalculationStatus](docs/CalculationStatus.md)
 - [Capacity](docs/Capacity.md)
 - [CapacityCost](docs/CapacityCost.md)
 - [CapacityLimit](docs/CapacityLimit.md)
 - [CapacityMultiplier](docs/CapacityMultiplier.md)
 - [CapacityStatisticsLoad](docs/CapacityStatisticsLoad.md)
 - [CapacityStatisticsRatio](docs/CapacityStatisticsRatio.md)
 - [CapacityStatisticsSum](docs/CapacityStatisticsSum.md)
 - [Cargo](docs/Cargo.md)
 - [CargoAction](docs/CargoAction.md)
 - [CargoActionType](docs/CargoActionType.md)
 - [CargoCompatibilities](docs/CargoCompatibilities.md)
 - [CargoInvoice](docs/CargoInvoice.md)
 - [CargoInvoiceDetail](docs/CargoInvoiceDetail.md)
 - [CargoInvoiceHonestSign](docs/CargoInvoiceHonestSign.md)
 - [CargoInvoiceReceipt](docs/CargoInvoiceReceipt.md)
 - [CargoInvoiceTax](docs/CargoInvoiceTax.md)
 - [CargoRotationType](docs/CargoRotationType.md)
 - [CheckResult](docs/CheckResult.md)
 - [CompatibilityPenalty](docs/CompatibilityPenalty.md)
 - [CustomfieldConvertRule](docs/CustomfieldConvertRule.md)
 - [CustomfieldEntityType](docs/CustomfieldEntityType.md)
 - [CustomfieldsSettings](docs/CustomfieldsSettings.md)
 - [Demand](docs/Demand.md)
 - [DemandExtraDuration](docs/DemandExtraDuration.md)
 - [DemandType](docs/DemandType.md)
 - [EntityError](docs/EntityError.md)
 - [EntityErrorType](docs/EntityErrorType.md)
 - [EntityPath](docs/EntityPath.md)
 - [EntityType](docs/EntityType.md)
 - [EntityWarning](docs/EntityWarning.md)
 - [EntityWarningType](docs/EntityWarningType.md)
 - [Experiment](docs/Experiment.md)
 - [ExperimentCheck](docs/ExperimentCheck.md)
 - [ExperimentList](docs/ExperimentList.md)
 - [ExperimentNeighbors](docs/ExperimentNeighbors.md)
 - [ExperimentSettings](docs/ExperimentSettings.md)
 - [ExperimentStatistics](docs/ExperimentStatistics.md)
 - [ExtensionSettings](docs/ExtensionSettings.md)
 - [Fact](docs/Fact.md)
 - [FactLore](docs/FactLore.md)
 - [FactStatus](docs/FactStatus.md)
 - [FactType](docs/FactType.md)
 - [FeatureLifetime](docs/FeatureLifetime.md)
 - [FileNamePath](docs/FileNamePath.md)
 - [FileSpecification](docs/FileSpecification.md)
 - [Filesystem](docs/Filesystem.md)
 - [FilesystemColumnType](docs/FilesystemColumnType.md)
 - [FilesystemCounters](docs/FilesystemCounters.md)
 - [FilesystemPath](docs/FilesystemPath.md)
 - [Folder](docs/Folder.md)
 - [FolderCounters](docs/FolderCounters.md)
 - [FolderSpecification](docs/FolderSpecification.md)
 - [FolderType](docs/FolderType.md)
 - [General400](docs/General400.md)
 - [General402](docs/General402.md)
 - [General403](docs/General403.md)
 - [General404](docs/General404.md)
 - [General404Detail](docs/General404Detail.md)
 - [General429](docs/General429.md)
 - [General500](docs/General500.md)
 - [GeneralStatistics](docs/GeneralStatistics.md)
 - [GeoSettings](docs/GeoSettings.md)
 - [Geopoint](docs/Geopoint.md)
 - [Hardlink](docs/Hardlink.md)
 - [HardlinkElement](docs/HardlinkElement.md)
 - [HardlinkElementType](docs/HardlinkElementType.md)
 - [ImportSample](docs/ImportSample.md)
 - [ImportSource](docs/ImportSource.md)
 - [LinkedEssence](docs/LinkedEssence.md)
 - [LoadStatistics](docs/LoadStatistics.md)
 - [Location](docs/Location.md)
 - [LocationCargosLimit](docs/LocationCargosLimit.md)
 - [LocationCompatibilities](docs/LocationCompatibilities.md)
 - [LocationLimit](docs/LocationLimit.md)
 - [LocationLimitStatistics](docs/LocationLimitStatistics.md)
 - [LocationStatistics](docs/LocationStatistics.md)
 - [LocationTimetableElement](docs/LocationTimetableElement.md)
 - [LocationTransportsLimit](docs/LocationTransportsLimit.md)
 - [LoreDemandCancelled](docs/LoreDemandCancelled.md)
 - [LoreDemandDone](docs/LoreDemandDone.md)
 - [LoreDemandStart](docs/LoreDemandStart.md)
 - [LoreJobDone](docs/LoreJobDone.md)
 - [LoreNewLocation](docs/LoreNewLocation.md)
 - [LoreOrderDone](docs/LoreOrderDone.md)
 - [LoreTripPrecedenceChanged](docs/LoreTripPrecedenceChanged.md)
 - [Measurements](docs/Measurements.md)
 - [ModelBreak](docs/ModelBreak.md)
 - [Order](docs/Order.md)
 - [OrderCompatibilities](docs/OrderCompatibilities.md)
 - [Performer](docs/Performer.md)
 - [PerformerCompatibilities](docs/PerformerCompatibilities.md)
 - [PerformerLimits](docs/PerformerLimits.md)
 - [PerformerShift](docs/PerformerShift.md)
 - [PerformerTariff](docs/PerformerTariff.md)
 - [PerformerTariffConstraint](docs/PerformerTariffConstraint.md)
 - [PlanSettings](docs/PlanSettings.md)
 - [PlanStatistics](docs/PlanStatistics.md)
 - [PossibleEvent](docs/PossibleEvent.md)
 - [Quality](docs/Quality.md)
 - [RemovedItems](docs/RemovedItems.md)
 - [ReplanSettings](docs/ReplanSettings.md)
 - [ReplanStrategy](docs/ReplanStrategy.md)
 - [Rest](docs/Rest.md)
 - [RestRules](docs/RestRules.md)
 - [RoundtripStatistics](docs/RoundtripStatistics.md)
 - [RoutingMatrix](docs/RoutingMatrix.md)
 - [RoutingMatrixWaypoint](docs/RoutingMatrixWaypoint.md)
 - [RoutingTransportMatrix](docs/RoutingTransportMatrix.md)
 - [SchemaError](docs/SchemaError.md)
 - [Service](docs/Service.md)
 - [SettingsKeyList](docs/SettingsKeyList.md)
 - [StopDemand](docs/StopDemand.md)
 - [StopStatistics](docs/StopStatistics.md)
 - [TableCustomfields](docs/TableCustomfields.md)
 - [TableCustomfieldsColumnType](docs/TableCustomfieldsColumnType.md)
 - [TableDataStats](docs/TableDataStats.md)
 - [TableExperimentColumnType](docs/TableExperimentColumnType.md)
 - [TableFact](docs/TableFact.md)
 - [TableFactColumnType](docs/TableFactColumnType.md)
 - [TableFactFields](docs/TableFactFields.md)
 - [TableFactFilter](docs/TableFactFilter.md)
 - [TableFactFilterList](docs/TableFactFilterList.md)
 - [TableFactList](docs/TableFactList.md)
 - [TableFactMetrics](docs/TableFactMetrics.md)
 - [TableFactMetricsFilterList](docs/TableFactMetricsFilterList.md)
 - [TableFilterBoolList](docs/TableFilterBoolList.md)
 - [TableFilterDatetimeRange](docs/TableFilterDatetimeRange.md)
 - [TableFilterDurationRange](docs/TableFilterDurationRange.md)
 - [TableFilterEnumList](docs/TableFilterEnumList.md)
 - [TableFilterFloatRange](docs/TableFilterFloatRange.md)
 - [TableFilterIntRange](docs/TableFilterIntRange.md)
 - [TableFilterStringList](docs/TableFilterStringList.md)
 - [TableFilterStringSearch](docs/TableFilterStringSearch.md)
 - [TableFilterType](docs/TableFilterType.md)
 - [TableHardlink](docs/TableHardlink.md)
 - [TableHardlinkColumnType](docs/TableHardlinkColumnType.md)
 - [TableHardlinkFields](docs/TableHardlinkFields.md)
 - [TableHardlinkFilter](docs/TableHardlinkFilter.md)
 - [TableHardlinkFilterList](docs/TableHardlinkFilterList.md)
 - [TableHardlinkList](docs/TableHardlinkList.md)
 - [TableHardlinkMetrics](docs/TableHardlinkMetrics.md)
 - [TableHardlinkMetricsFilterList](docs/TableHardlinkMetricsFilterList.md)
 - [TableListCounters](docs/TableListCounters.md)
 - [TableListCountersDetail](docs/TableListCountersDetail.md)
 - [TableLocation](docs/TableLocation.md)
 - [TableLocationColumnType](docs/TableLocationColumnType.md)
 - [TableLocationFields](docs/TableLocationFields.md)
 - [TableLocationFilter](docs/TableLocationFilter.md)
 - [TableLocationFilterList](docs/TableLocationFilterList.md)
 - [TableLocationList](docs/TableLocationList.md)
 - [TableLocationMetrics](docs/TableLocationMetrics.md)
 - [TableLocationMetricsFilterList](docs/TableLocationMetricsFilterList.md)
 - [TableOrder](docs/TableOrder.md)
 - [TableOrderColumnType](docs/TableOrderColumnType.md)
 - [TableOrderFields](docs/TableOrderFields.md)
 - [TableOrderFilter](docs/TableOrderFilter.md)
 - [TableOrderFilterList](docs/TableOrderFilterList.md)
 - [TableOrderList](docs/TableOrderList.md)
 - [TableOrderMetrics](docs/TableOrderMetrics.md)
 - [TableOrderMetricsFilterList](docs/TableOrderMetricsFilterList.md)
 - [TablePerformer](docs/TablePerformer.md)
 - [TablePerformerColumnType](docs/TablePerformerColumnType.md)
 - [TablePerformerFields](docs/TablePerformerFields.md)
 - [TablePerformerFilter](docs/TablePerformerFilter.md)
 - [TablePerformerFilterList](docs/TablePerformerFilterList.md)
 - [TablePerformerList](docs/TablePerformerList.md)
 - [TablePerformerMetrics](docs/TablePerformerMetrics.md)
 - [TablePerformerMetricsFilterList](docs/TablePerformerMetricsFilterList.md)
 - [TableRoundtrip](docs/TableRoundtrip.md)
 - [TableRoundtripColumnType](docs/TableRoundtripColumnType.md)
 - [TableRoundtripFields](docs/TableRoundtripFields.md)
 - [TableRoundtripFilter](docs/TableRoundtripFilter.md)
 - [TableRoundtripFilterList](docs/TableRoundtripFilterList.md)
 - [TableRoundtripList](docs/TableRoundtripList.md)
 - [TableRoundtripMetrics](docs/TableRoundtripMetrics.md)
 - [TableRoundtripMetricsFilterList](docs/TableRoundtripMetricsFilterList.md)
 - [TableTransport](docs/TableTransport.md)
 - [TableTransportColumnType](docs/TableTransportColumnType.md)
 - [TableTransportFields](docs/TableTransportFields.md)
 - [TableTransportFilter](docs/TableTransportFilter.md)
 - [TableTransportFilterList](docs/TableTransportFilterList.md)
 - [TableTransportList](docs/TableTransportList.md)
 - [TableTransportMetrics](docs/TableTransportMetrics.md)
 - [TableTransportMetricsFilterList](docs/TableTransportMetricsFilterList.md)
 - [TableTrip](docs/TableTrip.md)
 - [TableTripColumnType](docs/TableTripColumnType.md)
 - [TableTripFields](docs/TableTripFields.md)
 - [TableTripFilter](docs/TableTripFilter.md)
 - [TableTripFilterList](docs/TableTripFilterList.md)
 - [TableTripList](docs/TableTripList.md)
 - [TableTripMetrics](docs/TableTripMetrics.md)
 - [TableTripMetricsFilterList](docs/TableTripMetricsFilterList.md)
 - [TableTripStop](docs/TableTripStop.md)
 - [TableTripStopColumnType](docs/TableTripStopColumnType.md)
 - [TableTripStopFields](docs/TableTripStopFields.md)
 - [TableTripStopFilter](docs/TableTripStopFilter.md)
 - [TableTripStopFilterList](docs/TableTripStopFilterList.md)
 - [TableTripStopList](docs/TableTripStopList.md)
 - [TaskStatistics](docs/TaskStatistics.md)
 - [TimeWindow](docs/TimeWindow.md)
 - [TimeWindowViolationDetail](docs/TimeWindowViolationDetail.md)
 - [TimeWindowViolations](docs/TimeWindowViolations.md)
 - [Tracedata](docs/Tracedata.md)
 - [Track](docs/Track.md)
 - [TrackList](docs/TrackList.md)
 - [TrackListCustom](docs/TrackListCustom.md)
 - [TrackType](docs/TrackType.md)
 - [Trackpoint](docs/Trackpoint.md)
 - [Translations](docs/Translations.md)
 - [Transport](docs/Transport.md)
 - [TransportCapacityMultiplier](docs/TransportCapacityMultiplier.md)
 - [TransportCompatibilities](docs/TransportCompatibilities.md)
 - [TransportLimits](docs/TransportLimits.md)
 - [TransportLoad](docs/TransportLoad.md)
 - [TransportShift](docs/TransportShift.md)
 - [TransportSpeedMultiplier](docs/TransportSpeedMultiplier.md)
 - [TransportTariff](docs/TransportTariff.md)
 - [TransportTariffConstraint](docs/TransportTariffConstraint.md)
 - [TransportType](docs/TransportType.md)
 - [Trip](docs/Trip.md)
 - [TripAssumptions](docs/TripAssumptions.md)
 - [TripDemandPrecedence](docs/TripDemandPrecedence.md)
 - [TripExpectations](docs/TripExpectations.md)
 - [TripPenalties](docs/TripPenalties.md)
 - [TripStartTimeStrategy](docs/TripStartTimeStrategy.md)
 - [TripState](docs/TripState.md)
 - [TripStateFlag](docs/TripStateFlag.md)
 - [TripStatistics](docs/TripStatistics.md)
 - [TripStatus](docs/TripStatus.md)
 - [TripsSettings](docs/TripsSettings.md)
 - [Universal400WithErrorsAndWarnings](docs/Universal400WithErrorsAndWarnings.md)
 - [UniversalData](docs/UniversalData.md)
 - [UnplannedItems](docs/UnplannedItems.md)
 - [VersionResult](docs/VersionResult.md)
 - [WebFact](docs/WebFact.md)
 - [WebHardlink](docs/WebHardlink.md)
 - [WebLocation](docs/WebLocation.md)
 - [WebLocationGeopoint](docs/WebLocationGeopoint.md)
 - [WebLocationGeopointList](docs/WebLocationGeopointList.md)
 - [WebOrder](docs/WebOrder.md)
 - [WebOrderGeopoint](docs/WebOrderGeopoint.md)
 - [WebOrderGeopointList](docs/WebOrderGeopointList.md)
 - [WebPerformer](docs/WebPerformer.md)
 - [WebPerformerGeopoint](docs/WebPerformerGeopoint.md)
 - [WebPerformerGeopointList](docs/WebPerformerGeopointList.md)
 - [WebTransport](docs/WebTransport.md)
 - [WebTransportGeopoint](docs/WebTransportGeopoint.md)
 - [WebTransportGeopointList](docs/WebTransportGeopointList.md)
 - [WebTrip](docs/WebTrip.md)
 - [WebTripChart](docs/WebTripChart.md)
 - [WebTripChartDemand](docs/WebTripChartDemand.md)
 - [WebTripChartList](docs/WebTripChartList.md)
 - [WorkAndRestRules](docs/WorkAndRestRules.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: Bearer authentication (JWT)


## Author

support@veeroute.com


