VRt.Studio
VEEROUTE 2025

VRt.Studio [ST] (7.28.3096)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary Terms of Service

Veeroute Studio API.

Veeroute company website

Description

Server part of the 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 to the web_location_geopoint.icon_name field
FORCED_GEOPROVIDER geo_settings The attribute value determines the geodata provider for rendering flights on the map, which will be used instead of the one specified in the plan_settings.geo_settings.geo_provider field

Entity relationship diagram

erd

Explorer

Virtual filesystem management.

Create folder

Create new folder.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to create a folder. In the parent_key field, you must specify the key of the folder in which the new folder will be created. If parent_key is not specified, the folder is created in the root.

parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-01-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
string <uuid> (unique_key)

New folder key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Getting a filesystem

Getting a filesystem.

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string <uuid> (unique_key)
Example: folder_key=11111111-2222-3333-4444-555555555555

Parent folder key, if not specified - a list of root folders is returned

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Filter for searching by text fields - only those folders that contain a substring from the filter are returned:

  • in folder name
  • in folder comment
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (filesystem_column_type)
Default: "NAME"
Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more
Example: sort_field=CREATION_DATE

The name of the column in the table with folders.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
object (folder)

Folder is an element of a virtual file system.

required
Array of objects (folder) [ 0 .. 2001 ] items

List of folders.

required
object (table_list_counters)

Counters by list.

Response samples

Content type
application/json
{
}

Update folder

Rename and move folder.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-01-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (folder)

Folder is an element of a virtual file system.

required
Array of objects (folder) [ 0 .. 2001 ] items

List of folders.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Folder removal

Folder removal by key.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Folder specification

Getting a folder specification.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json
parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-01-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Response samples

Content type
application/json
{
}

Folder path

Folder path.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type
application/json
{
}

Create folders (batch)

Create new folder (batch).

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to create a group of folders from the root of the virtual file system. If any folder in the path already exists - it will not be created again. The method returns the key of the last folder, even if no folders were created.

Array ([ 0 .. 10 ] items)
string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Last folder key.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Folders removal (batch)

Batch delete folders.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

List of folder keys that need to be deleted.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Folder key

Getting a folder key by path.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If any folder in the path not exists - 404 will be returned.

Array ([ 0 .. 10 ] items)
string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Last folder key.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

File key

Getting a file key by path.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If in the folder multiple files with the same name - the last modified will be returned. If any folder or file in the path not exists - 404 will be returned.

folder_names
required
Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ]
Example: ["folder_1"]

List of folder names from the root of the virtual filesystem.

file_name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

File key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Files removal (batch)

Batch delete files.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

List of file's keys that need to be deleted.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Filesystem counters

Getting a virtual filesystem counters.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
required
object (folder_counters)

Current number of available folders/files.

required
object (folder_counters)

Max number of available folders/files.

Response samples

Content type
application/json
{
}

Backups

Bulk data export and import.

Folder export

Export folder with experiments.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/octet-stream
string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type
application/json
{
}

Folder import

Import folder with experiments. The folder should not be of type ROOT and should be empty.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/octet-stream
required

Data (ZIP).

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Experiments

Experiments management.

Experiment list (table)

Getting a experiments list.

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string <uuid> (unique_key)
Example: folder_key=11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter. If the filter is empty, all experiments in the folder are returned. The results are sorted by editing time.

offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_experiment_column_type)
Default: "CREATION_DATE"
Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more
Example: sort_field=EDIT_DATE

Experiments table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
Array of objects (experiment) [ 0 .. 2001 ] items

A list of experiments.

required
object (table_list_counters)

Counters by list.

Response samples

Content type
application/json
{
}

Create experiment

Create new experiment.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Experiment create request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
string <uuid> (unique_key)

New experiment key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Reading experiment

Getting experiment information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Experiment update

Rename \ move experiment.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Experiment specification update request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Experiment removal

Experiment removal by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Experiment duplicate

Experiment duplicate.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Experiment duplicate request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Duplicated experiment key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Settings update

Experiment settings update.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Experiment settings update request.

required
object (plan_settings)

Planning settings.

required
object (replan_settings)

Replanning settings.

required
object (actualize_settings)

Actualize settings.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Indicators update

Updating the experiment indicators.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Indicators update request.

Array ([ 0 .. 100 ] items)
string [ 2 .. 256 ] characters

Indicator key.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Experiment neighbors

Experiment neighbors.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
sort_field
string (table_experiment_column_type)
Default: "CREATION_DATE"
Enum: "EDIT_DATE" "CREATION_DATE" "CALCULATION_STATE" … 2 more
Example: sort_field=EDIT_DATE

Experiments table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
previous_experiment_key
string or null <uuid>
Example: "11111111-2222-3333-4444-555555555555"

The key of the previous experiment is in the same folder.

next_experiment_key
string or null <uuid>
Example: "11111111-2222-3333-4444-555555555555"

The key of the next experiment is in the same folder.

Response samples

Content type
application/json
{
}

Experiment path

Experiment path.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type
application/json
{
}

Calculation history

Read calculation history.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
Array ([ 0 .. 3000 ] items)
time
required
string <date-time>
Example: "2026-01-21T09:30:00+03:00"

Date and time of receiving statistics in the ISO 8601 format.

required
object (general_statistics)

Summary statistics for one or a set of trips.

Response samples

Content type
application/json
[ ]

Run calculation

Experiment calculation run.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

process_name
required
string (basic_process)
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Process name:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Calculation stop

Calculation stop.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

process_name
required
string (basic_process)
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Process name:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация

Responses

Response samples

Content type
application/json
{
}

Run validation

Experiment validation run.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

process_name
required
string (basic_process)
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Process name:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Run refine

Experiment refine run.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

process_name
required
string (basic_process)
Enum: "PLAN" "REPLAN" "ACTUALIZE"
Example: ACTUALIZE

Process name:

  • PLAN - планирование
  • REPLAN - перепланирование
  • ACTUALIZE - актуализация
query Parameters
remove_locations
boolean
Default: false
Example: remove_locations=true

Flag responsible for deleting a location when cleaning data. If true is specified, locations that are not referenced by any entity in the dataset are deleted.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Recalculate tracks

Starting recalculation of ROAD experiment tracks.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
tracks_full_segments
boolean
Default: false
Example: tracks_full_segments=true

Return a complete or simplified list of route segments.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Recalculate stats

Starting recalculation of experiment stats.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Import (XLSX)

Importing new data from an XLSX file. If an entity is already present (determined by its key), it is updated. If not, a new one is created. The data time zone is taken from the XLSX file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Import (JSON)

Importing new data from VRt.Universal JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data (JSON).

Array of objects (location_list) [ 0 .. 15001 ] items unique

List of locations used for orders and shifts.

Array of objects (order_list) [ 0 .. 15001 ] items unique

List of orders that need to be completed.

Array of objects (performer_list) [ 0 .. 15001 ] items unique

Available performers list. The performer fulfills orders using transport.

Array of objects (transport_list) [ 0 .. 15001 ] items unique

Available transports list. Transport is used by the trip performer to fulfill orders.

Array of objects (hardlink_list) [ 0 .. 15001 ] items unique

Assignments list.

Array of objects (trip_list) [ 0 .. 15001 ] items unique

Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.

Array of objects (fact_list) [ 0 .. 15001 ] items unique

Trip list. A fact is an event that has occurred that affects further trip operations.

plan_statistics (object) or nullable (null)
Default: null

General statistics on the calculation result.

Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique

List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix external_routing, the plan_settings.geo_settings parameters are not taken into account.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

dataset_name
string (dataset_name) [ 0 .. 512 ] characters
Example: "custom_dataset_one"

The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Import by URL (JSON)

Importing new data from a VRt.Universal JSON file by url. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
url
required
string <uri>
Example: url=https://docs.edge7.veeroute.cloud/assets/files/case_1.json

Url to json file.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Import by tracedata

Importing new data from a VRt.Universal JSON file by tracedata.process_code. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

source
required
string (import_source)
Enum: "ACCOUNT" "ADMIN"
Example: ACCOUNT

Source.

process_code
required
string <uuid> (process_code)
Example: 11111111-2222-3333-4444-555555555555

Unique process identifier.

sample
required
string (import_sample)
Enum: "TASK" "FULL"
Example: TASK

Sample of loaded data - input task or input task + calculation result.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

progress
integer <int32> (calculation_progress) [ 0 .. 100 ]
Example: "52"

Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

pristine
required
boolean (basic_pristine)
Example: "false"

A flag indicating whether changes to the entity have been made relative to the original data. true - means that the data is original and has not been changed.

sharing
boolean (basic_sharing)
Example: "true"

Experiment sharing flag.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-01-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-01-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Export (XLSX)

Export (XLSX).

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
timezone
integer <int32> (timezone) [ -12 .. 12 ]
Default: 0
Example: timezone=3

Target time zone.

Responses

Response Schema: application/octet-stream
string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type
application/json
{
}

Export (JSON)

Export data to VRt.Universal JSON file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
Array of objects (location_list) [ 0 .. 15001 ] items unique

List of locations used for orders and shifts.

Array of objects (order_list) [ 0 .. 15001 ] items unique

List of orders that need to be completed.

Array of objects (performer_list) [ 0 .. 15001 ] items unique

Available performers list. The performer fulfills orders using transport.

Array of objects (transport_list) [ 0 .. 15001 ] items unique

Available transports list. Transport is used by the trip performer to fulfill orders.

Array of objects (hardlink_list) [ 0 .. 15001 ] items unique

Assignments list.

Array of objects (trip_list) [ 0 .. 15001 ] items unique

Trip list. A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.

Array of objects (fact_list) [ 0 .. 15001 ] items unique

Trip list. A fact is an event that has occurred that affects further trip operations.

plan_statistics (object) or nullable (null)
Default: null

General statistics on the calculation result.

Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique

List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix external_routing, the plan_settings.geo_settings parameters are not taken into account.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

dataset_name
string (dataset_name) [ 0 .. 512 ] characters
Example: "custom_dataset_one"

The name of the dataset. A technical field that does not affect calculation.

Response samples

Content type
application/json
{
}

Locations

Locations management.

Create location

Create location.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "location_01"

Location key, unique identifier.

required
object (geopoint)

Geographical point.

arrival_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time for driving up to the location (or waiting time at parking lot) according to ISO 8601 duration.

departure_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time to leave the location according to ISO 8601 duration.

Array of objects (location_timetable) [ 0 .. 30 ] items

Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.

location_compatibilities (object) or nullable (null)
Default: null

Location compatibilities.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update location

Updating the location by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "location_01"

Location key, unique identifier.

required
object (geopoint)

Geographical point.

arrival_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time for driving up to the location (or waiting time at parking lot) according to ISO 8601 duration.

departure_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time to leave the location according to ISO 8601 duration.

Array of objects (location_timetable) [ 0 .. 30 ] items

Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.

location_compatibilities (object) or nullable (null)
Default: null

Location compatibilities.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read location

Getting location information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove location

Removing a location by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Locations list

Getting a locations list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_location_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more
Example: sort_field=ESSENCE_KEY

Locations table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_location) [ 0 .. 2001 ] items

A list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete locations (batch)

Removing locations from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete locations.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Location geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_location_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Location metrics

Calculate general metrics for selected locations.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_location_fields)

Total values for fields of types int, double, duration.

object (table_location_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Orders

Orders management.

Create order

New order creation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "order01"

Order key, unique identifier.

required
Array of objects (demand) [ 1 .. 1000 ] items unique

Demands list.

Array of objects (cargo) [ 0 .. 1000 ] items unique
Default: []

The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type WORK.

order_compatibilities (object) or nullable (null)
Default: null
name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update order

Updating the essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "order01"

Order key, unique identifier.

required
Array of objects (demand) [ 1 .. 1000 ] items unique

Demands list.

Array of objects (cargo) [ 0 .. 1000 ] items unique
Default: []

The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type WORK.

order_compatibilities (object) or nullable (null)
Default: null
name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading order

Getting order information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Deleting one order

Removing a essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

List orders

Getting a orders list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_order_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more
Example: sort_field=ESSENCE_KEY

Order table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Essence filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_order) [ 0 .. 15001 ] items

List of orders.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete orders (batch)

Removing orders from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete orders.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable orders

Enable orders in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable orders request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable orders

Disable orders in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable orders request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Order geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Orders filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_order_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Order metrics

Calculate general metrics for selected orders.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_order_fields)

Total values for fields of types int, double, duration.

object (table_order_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Performers

Performers management.

Create performer

Create performer.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "performer0001"

Performer's key, unique identifier.

required
Array of objects (performer_shift) [ 1 .. 15001 ] items unique

List of working shifts of performer.

own_transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

The type of personal transport that the performer will use to get to his assigned work transport.

performer_compatibilities (object) or nullable (null)
Default: null

Performer compatibilities.

performer_limits (object) or nullable (null)
Default: null

Limitation on the performer's workload.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update performer

Updating the performer by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "performer0001"

Performer's key, unique identifier.

required
Array of objects (performer_shift) [ 1 .. 15001 ] items unique

List of working shifts of performer.

own_transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

The type of personal transport that the performer will use to get to his assigned work transport.

performer_compatibilities (object) or nullable (null)
Default: null

Performer compatibilities.

performer_limits (object) or nullable (null)
Default: null

Limitation on the performer's workload.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read performer

Getting performer information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove performer

Removing a performer by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Performers list

Getting a performers list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_performer_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 12 more
Example: sort_field=ESSENCE_KEY

Performers table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_performer) [ 0 .. 2001 ] items

A list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete performers (batch)

Removing performers from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete performers.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable performers

Enable performers in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable performers request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable performers

Disable performers in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable performers request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Performer geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_performer_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Performer metrics

Calculate general metrics for selected performers.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_performer_fields)

Total values for fields of types int, double, duration.

object (table_performer_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Transports

Transports management.

Create transport

New essences creation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "transport001"

Transport key, unique identifier.

required
Array of objects (transport_shift) [ 1 .. 15001 ] items unique

List of working shifts of transport.

transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

Transport types:

  • CAR - car
  • TRUCK_1500 - truck with permissible weight 1500 kg
  • TRUCK_3000 - truck with permissible weight 3000 kg
  • TRUCK_5000 - truck with permissible weight 5000 kg
  • TRUCK_10000 - truck with permissible weight 10000 kg
  • TRUCK_20000 - truck with permissible weight 20000 kg
  • TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
  • TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
  • TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
  • TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
  • TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
  • TUK_TUK - tuk-tuk
  • BICYCLE - bicycle
  • PEDESTRIAN - pedestrian
  • PUBLIC_TRANSPORT - public transport
  • TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

Array of objects (box) [ 0 .. 100 ] items
Default: []

A list of transport boxes that can accommodate the cargo.

transport_compatibilities (object) or nullable (null)
Default: null

Transport compatibilities.

transport_limits (object) or nullable (null)
Default: null

Transport load limits.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update transport

Updating the essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "transport001"

Transport key, unique identifier.

required
Array of objects (transport_shift) [ 1 .. 15001 ] items unique

List of working shifts of transport.

transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

Transport types:

  • CAR - car
  • TRUCK_1500 - truck with permissible weight 1500 kg
  • TRUCK_3000 - truck with permissible weight 3000 kg
  • TRUCK_5000 - truck with permissible weight 5000 kg
  • TRUCK_10000 - truck with permissible weight 10000 kg
  • TRUCK_20000 - truck with permissible weight 20000 kg
  • TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
  • TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
  • TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
  • TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
  • TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
  • TUK_TUK - tuk-tuk
  • BICYCLE - bicycle
  • PEDESTRIAN - pedestrian
  • PUBLIC_TRANSPORT - public transport
  • TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

Array of objects (box) [ 0 .. 100 ] items
Default: []

A list of transport boxes that can accommodate the cargo.

transport_compatibilities (object) or nullable (null)
Default: null

Transport compatibilities.

transport_limits (object) or nullable (null)
Default: null

Transport load limits.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading transport

Getting transport information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove transport

Removing a transport by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Transport list

Getting a transport list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_transport_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 17 more
Example: sort_field=ESSENCE_KEY

Transport table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Transport filter.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_transport) [ 0 .. 2001 ] items

A list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete transports (batch)

Removing transports from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete transports.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable transports

Enable transports in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable transports request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable transports

Disable transports in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable transports request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Transport geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Transports filter.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_transport_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Transport metrics

Calculate general metrics for selected transports.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_transport_fields)

Total values for fields of types int, double, duration.

object (table_transport_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{