VRt.Monitor [MT] (7.19.2779)

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

Veeroute Monitor API.

Description

Server part of the Veeroute Monitor.

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> (unique_key_null)
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.

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 or null <uuid> (unique_key_null)
Default: null
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" … 3 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
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> (unique_key_null)
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.

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
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
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> (unique_key_null)
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.

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
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
{
}

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
{
}

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
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
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
{
}

Crews

Crews management.

Crew creation

New crew creation.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Crew creation request.

key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

Unique username for login.

password
string or null <password> (user_password) [ 10 .. 256 ] characters
Example: "long_strong_password"

Password.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

Unique company key.

required
object (performer)

Performer. Fulfills orders using transport.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (device)

Mobile device.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Crew specification.

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

Linked current deals.

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

Unique username for login.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

Unique company key.

required
object (performer)

Performer. Fulfills orders using transport.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (device)

Mobile device.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Crew specification.

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

Linked current deals.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Crew update

Updating the crew information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Crew update request.

key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

Unique username for login.

password
string or null <password> (user_password) [ 10 .. 256 ] characters
Example: "long_strong_password"

Password.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

Unique company key.

required
object (performer)

Performer. Fulfills orders using transport.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (device)

Mobile device.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Crew specification.

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

Linked current deals.

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

Unique username for login.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

Unique company key.

required
object (performer)

Performer. Fulfills orders using transport.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (device)

Mobile device.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Crew specification.

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

Linked current deals.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Getting crew information

Getting crew information by key.

Authorizations:
ApiKeyAuth
path Parameters
crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: mega_crew

Parameter (path) with crew key.

Responses

Response Schema: application/json
required
object (crew)

Crew.

object (table_crew_fields)

Crew fields for table.

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

A list of linked essences.

Response samples

Content type
application/json
{
}

Crew removal

Removing a crew by key.

Authorizations:
ApiKeyAuth
path Parameters
crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: mega_crew

Parameter (path) with crew key.

Responses

Response samples

Content type
application/json
{
}

Reading crews (table)

Getting a list of crews.

Authorizations:
ApiKeyAuth
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_crew_column_type)
Default: "USERNAME"
Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more
Example: sort_field=DEVICE_ONLINE

Crew table column name.

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

Sort direction.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 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
{
}

Crews removal (batch)

Batch crews delete.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to delete crews.

Array ([ 0 .. 2001 ] items)
string (crew_key) [ 3 .. 256 ] characters \w+

Unique crew key.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Crew geopoints

Getting a crew geopoints.

Authorizations:
ApiKeyAuth
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

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (crew_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
{
}

Self crew information

Getting crew information by login.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

Unique username for login.

company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

Unique company key.

required
object (performer)

Performer. Fulfills orders using transport.

required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (device)

Mobile device.

specification
string or null (user_specification) [ 2 .. 256 ] characters
Example: "User full name"

Crew specification.

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

Linked current deals.

Response samples

Content type
application/json
{
}

Self crew trips

Getting a crew trips by login.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
Array ([ 0 .. 10 ] items)
required
object (trip)

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.

required
object (trip_statistics)

Statistics for a specific trip.

object (table_trip_fields)

Trip\stops fields for table.

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

A list of linked essences.

Response samples

Content type
application/json
[
]

Deals

Deals management.

Deal - the assignment of a team to a specific trip from a specific wave.

Deal creation

New deal creation.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Deal creation request.

crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

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

Key, unique identifier.

trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip-0000-9999"

Unique trip identifier.

Responses

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

Unique deal identifier.

required
object (deal_specification)

Deal description.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Deal update

Updating the deal information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Deal update request.

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

Unique deal identifier.

required
object (deal_specification)

Deal description.

Responses

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

Unique deal identifier.

required
object (deal_specification)

Deal description.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Getting deal information

Getting deal information by key.

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

Key, unique identifier.

Responses

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

Unique deal identifier.

required
object (deal_specification)

Deal description.

Response samples

Content type
application/json
{
}

Deal removal

Removing a deal by key.

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

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Waves

Waves management.

Create wave

Create new wave.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

wave create request.

name
required
string [ 1 .. 100 ] characters
Example: "wave_1"

Wave name.

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

Wave comment.

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

Parent folder key.

Responses

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

New wave key.

Request samples

Content type
application/json
{
}

Response samples

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

Reading wave

Getting wave information by key.

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

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 (wave_specification)

Wave description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

object or null (calculation_state)

Current calculation state.

object or null (experiment_check)

The result of checking the data on the file.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Wave update

Rename \ move wave.

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

Key, unique identifier.

Request Body schema: application/json
required

wave specification update request.

name
required
string [ 1 .. 100 ] characters
Example: "wave_1"

Wave name.

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

Wave comment.

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

Parent folder key.

Responses

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

Key, unique identifier.

required
object (wave_specification)

Wave description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

object or null (calculation_state)

Current calculation state.

object or null (experiment_check)

The result of checking the data on the file.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Wave removal

Wave removal by key.

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

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Reading waves (table)

Getting a table with wave.

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

Folder key, unique identifier.

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_wave_column_type)
Default: "SPECIFICATION_NAME"
Enum: "ESSENCE_KEY" "SPECIFICATION_NAME" "SPECIFICATION_COMMENT" … 1 more
Example: sort_field=SPECIFICATION_FOLDER_KEY

Wave table column name.

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

Sort direction.

Request Body schema: application/json
optional

Waves filter.

Array of objects (table_wave_filter) [ 0 .. 50 ] items

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_wave) [ 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
{
}

Waves removal (batch)

Batch waves delete.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to delete waves.

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

Key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Wave duplicate

Wave duplicate.

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

Key, unique identifier.

Request Body schema: application/json
required

wave duplicate request.

name
required
string [ 1 .. 100 ] characters
Example: "wave_1"

Wave name.

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

Wave comment.

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

Parent folder key.

Responses

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

Duplicated wave key.

Request samples

Content type
application/json
{
}

Response samples

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

Wave path

Wave path.

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

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
{
}

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
wave_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

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 (wave_specification)

Wave description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

object or null (calculation_state)

Current calculation state.

object or null (experiment_check)

The result of checking the data on the file.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

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
wave_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

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.

object or null (plan_statistics)

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 (wave_specification)

Wave description.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

object or null (calculation_state)

Current calculation state.

object or null (experiment_check)

The result of checking the data on the file.

edit_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

creation_date
required
string <date-time>
Example: "2025-09-21T19:45:00Z"

Creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Export (XLSX)

Export (XLSX).

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

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
wave_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

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.

object or null (plan_statistics)

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.

Orders

Orders management.

Performers

Performers management.

Transports

Transports management.

Trips

Trips management.

Read trip

Getting trip information by key.

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

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 (trip)

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.

required
object (trip_statistics)

Statistics for a specific trip.

object (table_trip_fields)

Trip\stops fields for table.

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

A list of linked essences.

Response samples

Content type
application/json
{
}

Delete trip

Removing a trip by key.

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

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
{
}

Reading trips (table)

Getting a trips list.

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

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_trip_column_type)
Default: "TRIP_NAME"
Enum: "ESSENCE_KEY" "TRIP_NAME" "CREW_KEY" … 30 more
Example: sort_field=DISTANCE

Trip table column name.

sort_customfield
string or null (table_customfields_column_type)
Default: null
Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more
Example: sort_customfield=NONE

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

Trip filter.

Array of objects (table_trip_filter) [ 0 .. 50 ] items

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_trip) [ 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 trips (batch)

Removing trips from the wave.

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

Key, unique identifier.

Request Body schema: application/json
required

Request to delete trips.

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
{
}

Trip tracks

Getting a tracks.

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

Key, unique identifier.

tracks_type
required
string (track_type)
Default: "LINE"
Enum: "LINE" "ROAD" "CUSTOM"
Example: ROAD

Tracks type:

  • LINE - connecting stop points in a straight line
  • ROAD - connecting stop points along roads
  • EXTERNAL - externally loaded custom tracks
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

Trips filter.

Array of objects (table_trip_filter) [ 0 .. 50 ] items

A list of filters.

Responses

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

A list of tracks.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read available crews

Obtaining a list of crews that can perform the specified trip.

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

Key, unique identifier.

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

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_crew_column_type)
Default: "USERNAME"
Enum: "ESSENCE_KEY" "USERNAME" "COMPANY_KEY" … 2 more
Example: sort_field=DEVICE_ONLINE

Crew table column name.

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

Sort direction.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 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
{
}

Run trips (batch)

Run trips (batch). If the trip key list is empty, all trips from the wave are run.

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

Key, unique identifier.

Request Body schema: application/json
required

Request to run trips.

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
{
}

Stop trips (batch)

Stop trips (batch). If the trip key list is empty, all trips from the wave are stop.

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

Key, unique identifier.

Request Body schema: application/json
required

Request to stop trips.

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
{
}

Facts

Facts management.

Create fact

Create new fact.

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

Key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

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

Fact key.

time
required
string <date-time> (fact_time)
Example: "2025-09-21T09:30:00+03:00"

Fact creation time in the ISO 8601 format.

type
required
string (fact_type)
Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more
Example: "NEW_LOCATION"

Possible order (demand) fact types:

  • NEW_LOCATION - the performer changed his location during the trip
  • ORDER_DONE - the performer has finished fulfilling the order (or the order has been cancelled), the cargo associated with the order is no longer in the transport box
  • DEMAND_START - performer started to fulfill the demand
  • DEMAND_DONE - performer finished to fulfill the demand
trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip_01"

Trip key, to which the fact relates.

order_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01"

Order key, required for facts with type ORDER_DONE.

demand_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01_demand_01"

Demand key, required for facts with types DEMAND_DONE and DEMAND_START.

performer_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "performer_01"

Performer key, required for facts with type NEW_LOCATION.

location_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "location_01"

Location key, required for facts with type NEW_LOCATION.

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

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact 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 fact

Updating the fact by key.

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

Key, unique identifier.

Request Body schema: application/json
required

Essence update request.

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

Fact key.

time
required
string <date-time> (fact_time)
Example: "2025-09-21T09:30:00+03:00"

Fact creation time in the ISO 8601 format.

type
required
string (fact_type)
Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 1 more
Example: "NEW_LOCATION"

Possible order (demand) fact types:

  • NEW_LOCATION - the performer changed his location during the trip
  • ORDER_DONE - the performer has finished fulfilling the order (or the order has been cancelled), the cargo associated with the order is no longer in the transport box
  • DEMAND_START - performer started to fulfill the demand
  • DEMAND_DONE - performer finished to fulfill the demand
trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip_01"

Trip key, to which the fact relates.

order_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01"

Order key, required for facts with type ORDER_DONE.

demand_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01_demand_01"

Demand key, required for facts with types DEMAND_DONE and DEMAND_START.

performer_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "performer_01"

Performer key, required for facts with type NEW_LOCATION.

location_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "location_01"

Location key, required for facts with type NEW_LOCATION.

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

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact 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 fact

Getting fact information by key.

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

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 (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact 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 fact

Removing a fact by key.

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

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 of facts

Getting a facts list.

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

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_fact_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more
Example: sort_field=ESSENCE_KEY

Fact table column name.

sort_customfield
string or null (table_customfields_column_type)
Default: null
Enum: "DATETIME_1" "DATETIME_2" "DATETIME_3" … 27 more
Example: sort_customfield=NONE

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

Facts filter.

Array of objects (table_fact_filter) [ 0 .. 50 ] items

A list of filters.

Responses

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

A list of facts.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete facts (batch)

Removing facts from the experiment.

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

Key, unique identifier.

Request Body schema: application/json
required

Request to delete facts.

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
{
}

Analytics

Analytics and forecast.

Reports

Reports.

User

User settings.

Setting the active user settings key

Setting the active user settings key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading user settings list

Reading the list of user settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Create user settings

Create user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

property name*
additional property
any

Responses

Response Schema: application/json
property name*
additional property
any

Request samples

Content type
application/json
"{\"key1\":\"value1\"}"

Response samples

Content type
application/json
"{\"key1\":\"value1\"}"

Reading user settings

Reading user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response Schema: application/json
property name*
additional property
any

Response samples

Content type
application/json
"{\"key1\":\"value1\"}"

Update user settings

Update user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

property name*
additional property
any

Responses

Response Schema: application/json
property name*
additional property
any

Request samples

Content type
application/json
"{\"key1\":\"value1\"}"

Response samples

Content type
application/json
"{\"key1\":\"value1\"}"

Delete user settings

Delete user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

CustomFields

Custom field conversion settings.

The table provides additional columns for displaying values ​​from attributes.

This setting defines the rules for converting attribute values ​​into the corresponding typed fields.

Conversion occurs when reading data - therefore, the conversion rules do not affect the data and can be changed at any time.

Setting the active customfields key

Setting the active customfields key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading fields settings list

Reading the list of custom field settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Create fields settings

Create custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading fields settings

Reading custom field settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Response samples

Content type
application/json
{
}

Update fields settings

Update custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete fields settings

Delete custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

CustomIcons

Icon settings.

Setting the active customicons key

Setting the active customicons key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading icons settings list

Reading the list of custom field settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Update icons settings

Create custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/octet-stream
required

New settings.

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Reading icons settings

Reading custom field settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

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

ZIP archive with data.

Response samples

Content type
application/json
{
}

Update icons settings

Update custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/octet-stream
required

New settings.

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Delete icons settings

Delete custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json
health
required
number <double> [ 0 .. 1 ]
Example: "0.999"

The current health indicator of the service.

  • 0.0 means the service is not ready to perform tasks.
  • 1.0 means the service is fully ready to perform tasks.

Response samples

Content type
application/json
{
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json
major
required
integer <int32> [ 1 .. 100 ]
Example: "7"

Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).

minor
required
integer <int32> [ 0 .. 111 ]
Example: "15"

Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.

build
required
string [ 1 .. 64 ] characters
Example: "3754RC"

Build version.
Contains backwards compatible bug fixes and docs update.

Response samples

Content type
application/json
{
}

Getting the documentation

Getting the file with this service documentation.

path Parameters
filename
required
string [ 6 .. 128 ] characters
Example: file_en.html

File name.

Responses

Response Schema:
string (file_html)

File with data in HTML format.

Response samples

Content type
application/json
{
}