VRt.Monitor [MT] (7.25.3009)

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

Veeroute Monitor API.

Veeroute company website

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> (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: "2025-11-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

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

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 Default: [] List of folders.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"$ref": "explorer.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> (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: "2025-11-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 Default: [] List of folders.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

Response samples

Content type

application/json

{"$ref": "explorer.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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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> (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: "2025-11-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

{"parent_key": "11111111-2222-3333-4444-555555555555",
"name": "folder_1",
"comment": "long long long long text",
"color": "red",
"expiration_date": "2025-11-21T19:45:00Z",
"attributes": [ ]
}

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

Default: []

List of folders.

Response samples

Content type

application/json

{"folders": [ ]
}

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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

"11111111-2222-3333-4444-555555555555"

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

Payload

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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Payload

Content type

application/json

{"folder_names": [ ],
"file_name": "file_1"
}

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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"current": {"folders_count": 12,
"files_count": 16
},
"max": {"folders_count": 12,
"files_count": 16
}
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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.
	performer (object) or nullable (null) Default: "null" Performer specification.
	transport (object) or nullable (null) Default: "null" Transport specification.
	object (device) Mobile device.
	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.
	performer (object) or nullable (null) Default: "null" Performer specification.
	transport (object) or nullable (null) Default: "null" Transport specification.
	object (device) Mobile device.
	Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

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.
	performer (object) or nullable (null) Default: "null" Performer specification.
	transport (object) or nullable (null) Default: "null" Transport specification.
	object (device) Mobile device.
	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.
	performer (object) or nullable (null) Default: "null" Performer specification.
	transport (object) or nullable (null) Default: "null" Transport specification.
	object (device) Mobile device.
	Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals.

Request samples

Payload

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"password": "long_strong_password",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

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": {"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
},
"fields": {"essence_type": "CREW",
"essence_key": "key01",
"username": "AAA",
"company_key": "key01",
"device_phone": "AAA",
"device_online": true
},
"linked_essences": [ ]
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 0 .. 2001 ] items Default: [] A list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"essences": [ ],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

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

Payload

Content type

application/json

["mega_crew"
]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (crew_geopoint) [ 0 .. 2001 ] items Default: [] 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

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"geopoints": [ ],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
},
"geopoints_counters": {"total": 1
}
}

Self crew information APP

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.
	performer (object) or nullable (null) Default: "null" Performer specification.
	transport (object) or nullable (null) Default: "null" Transport specification.
	object (device) Mobile device.
	Array of objects (deal_list) [ 0 .. 30 ] items Linked current deals.

Response samples

Content type

application/json

{"key": "mega_crew",
"username": "username_for_login",
"company_key": "smart_company",
"performer": "null",
"transport": "null",
"device": {"phone": "+71112223333",
"online": true,
"app_version": "7.21",
"os_version": "15.0",
"manufacturer": "samsung",
"model": "S25 Ultra"
},
"deals": [ ]
}

Self crew trips APP

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.
status	string (trip_status) Enum: "FREE" "ASSIGNED" "SENT" … 4 more Example: "FINISHED" Current trip status: `FREE` - trip has no crew `ASSIGNED` - trip has a crew assigned `SENT` - trip has been sent to the crew for approval `CONFIRMED` - trip has been confirmed by the crew `REJECTED` - trip has been rejected by the crew `IN_PROGRESS` - trip is in progress `FINISHED` - trip has been completed
crew_key	string or null (crew_key_null) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key (nullable).

Response samples

Content type

application/json

[{"trip": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"states": [{"time": "2025-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 5.5,
"volume": 4.1,
"capacity_a": 3.7,
"capacity_b": 2.8,
"capacity_c": 2.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [ ],
"roundtrip_statistics": [ ],
"attributes": [ ]
},
"fields": {"essence_type": "TRIP",
"essence_key": "key01",
"trip_name": "X1-ABC",
"crew_key": "mega_crew",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": "null",
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2025-11-21T18:00:00+03:00",
"datetime_1": "2025-11-21T18:00:00+03:00",
"datetime_2": "2025-11-21T18:00:00+03:00",
"datetime_3": "2025-11-21T18:00:00+03:00",
"datetime_4": "2025-11-21T18:00:00+03:00",
"datetime_5": "2025-11-21T18:00:00+03:00",
"datetime_6": "2025-11-21T18:00:00+03:00",
"datetime_7": "2025-11-21T18:00:00+03:00",
"datetime_8": "2025-11-21T18:00:00+03:00",
"datetime_9": "2025-11-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"linked_essences": [ ],
"status": "FINISHED",
"crew_key": "mega_crew"
}
]

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

Payload

Content type

application/json

{"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

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

Payload

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

Response samples

Content type

application/json

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

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

{"key": "11111111-2222-3333-4444-555555555555",
"specification": {"crew_key": "mega_crew",
"wave_key": "11111111-2222-3333-4444-555555555555",
"trip_key": "trip-0000-9999"
}
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Waves

Waves management.

Create wave

Create new wave.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

wave 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 wave key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

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 (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	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.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"$ref": "wave.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 (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.
	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.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

Response samples

Content type

application/json

{"$ref": "wave.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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Waves list (table)

Getting a table with wave.

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 files are returned whose name or description contains a substring from the filter. If the filter is empty, all files 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_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 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.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items Default: [] A list of waves.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"$ref": "table_wave_list.json"
}

Wave search

Wave global search.

Authorizations:

ApiKeyAuth

query Parameters

filter required	string [ 3 .. 128 ] characters Example: filter=example text Filter for searching by text fields - only those configurations are returned whose name or description contains a substring from the filter. If the filter is empty, an empty list is returned. By default 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_wave_column_type) Default: "SPECIFICATION_NAME" Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 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.

Responses

Response Schema: application/json

required	Array of objects (wave) [ 0 .. 2001 ] items Default: [] A list of waves.
required	object (table_list_counters) Counters by list.

Response samples

Content type

application/json

{"$ref": "table_wave_list.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 (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 wave key.

Request samples

Payload

Content type

application/json

{"name": "file_1",
"comment": "long long long long text",
"folder_key": "11111111-2222-3333-4444-555555555555"
}

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

Default: []

List of folders.

Response samples

Content type

application/json

{"folders": [ ]
}

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 (file_specification) File specification.
required	object (experiment_settings) Experiment settings.
required	object (experiment_statistics) Experiment statistics.
	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.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Response samples

Content type

application/json

{"$ref": "wave.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.
	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.
	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.
edit_date required	string <date-time> (file_edit_date) Example: "2025-11-21T19:45:00Z" Last file edit date and time in the ISO 8601 format.
creation_date required	string <date-time> (file_creation_date) Example: "2025-11-21T19:45:00Z" File creation date and time in the ISO 8601 format.

Request samples

Payload

Content type

application/json

{"$ref": "../../universal/examples/convert_task_moscow.json"
}

Response samples

Content type

application/json

{"$ref": "wave.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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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.
	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

{"$ref": "../../universal/examples/convert_task_moscow.json"
}

Locations

Locations management.

Orders

Orders management.

Create order

New order creation.

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.

required	object (order) The order for delivery/transportation, contains a list of demands.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

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

Payload

Content type

application/json

{"$ref": "web_order.json"
}

Response samples

Content type

application/json

{"$ref": "web_order.json"
}

Update order

Updating the essence 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.

required	object (order) The order for delivery/transportation, contains a list of demands.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

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

Payload

Content type

application/json

{"$ref": "web_order.json"
}

Response samples

Content type

application/json

{"$ref": "web_order.json"
}

Reading order

Getting order 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 (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

{"$ref": "web_order.json"
}

Deleting one order

Removing a essence 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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

List orders

Getting a orders 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_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 Default: [] List of orders.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.json"
}

Delete orders (batch)

Removing orders 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 orders.

Array ([ 0 .. 15001 ] items)

string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

Performers

Performers management.

Transports

Transports management.

Hardlinks

Hardlinks 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.
status	string (trip_status) Enum: "FREE" "ASSIGNED" "SENT" … 4 more Example: "FINISHED" Current trip status: `FREE` - trip has no crew `ASSIGNED` - trip has a crew assigned `SENT` - trip has been sent to the crew for approval `CONFIRMED` - trip has been confirmed by the crew `REJECTED` - trip has been rejected by the crew `IN_PROGRESS` - trip is in progress `FINISHED` - trip has been completed
crew_key	string or null (crew_key_null) [ 3 .. 256 ] characters \w+ Example: "mega_crew" Unique crew key (nullable).

Response samples

Content type

application/json

{"trip": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
}
},
"states": [{"time": "2025-11-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [ ],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-11-21T09:30:00+03:00",
"to": "2025-11-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 5.5,
"volume": 4.1,
"capacity_a": 3.7,
"capacity_b": 2.8,
"capacity_c": 2.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [ ],
"roundtrip_statistics": [ ],
"attributes": [ ]
},
"fields": {"essence_type": "TRIP",
"essence_key": "key01",
"trip_name": "X1-ABC",
"crew_key": "mega_crew",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": "null",
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_0": "2025-11-21T18:00:00+03:00",
"datetime_1": "2025-11-21T18:00:00+03:00",
"datetime_2": "2025-11-21T18:00:00+03:00",
"datetime_3": "2025-11-21T18:00:00+03:00",
"datetime_4": "2025-11-21T18:00:00+03:00",
"datetime_5": "2025-11-21T18:00:00+03:00",
"datetime_6": "2025-11-21T18:00:00+03:00",
"datetime_7": "2025-11-21T18:00:00+03:00",
"datetime_8": "2025-11-21T18:00:00+03:00",
"datetime_9": "2025-11-21T18:00:00+03:00",
"int_0": 1,
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"int_6": 1,
"int_7": 1,
"int_8": 1,
"int_9": 1,
"float_0": 2343.3,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"float_6": 2343.3,
"float_7": 2343.3,
"float_8": 2343.3,
"float_9": 2343.3,
"duration_0": "PT2H12M33S",
"duration_1": "PT2H12M33S",
"duration_2": "PT2H12M33S",
"duration_3": "PT2H12M33S",
"duration_4": "PT2H12M33S",
"duration_5": "PT2H12M33S",
"duration_6": "PT2H12M33S",
"duration_7": "PT2H12M33S",
"duration_8": "PT2H12M33S",
"duration_9": "PT2H12M33S",
"bool_0": true,
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"bool_6": true,
"bool_7": true,
"bool_8": true,
"bool_9": true,
"string_0": "value01",
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01",
"string_6": "value01",
"string_7": "value01",
"string_8": "value01",
"string_9": "value01"
}
},
"linked_essences": [ ],
"status": "FINISHED",
"crew_key": "mega_crew"
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Trip filter.

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

Default: []

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

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (track) [ 0 .. 2001 ] items Default: [] A list of tracks.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "track_list.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

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_crew) [ 0 .. 2001 ] items Default: [] A list.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"essences": [ ],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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-11-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

Payload

Content type

application/json

{"$ref": "fact_new_location.json"
}

Response samples

Content type

application/json

{"$ref": "web_fact.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-11-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

Payload

Content type

application/json

{"$ref": "fact_new_location.json"
}

Response samples

Content type

application/json

{"$ref": "web_fact.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

{"$ref": "web_fact.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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

Facts filter.

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

Default: []

A list of filters.

Responses

Response Schema: application/json

required	Array of objects (table_fact) [ 0 .. 2001 ] items Default: [] A list of facts.
required	object (table_list_counters) Counters by list.

Request samples

Payload

Content type

application/json

{"$ref": "filter_list.json"
}

Response samples

Content type

application/json

{"$ref": "empty_table_list.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

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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 ] Default: [] 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

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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 ] Default: [] 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

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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

Payload

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

Payload

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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 ] Default: [] 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

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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 ] Default: [] 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

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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

Default: []

List of rules for converting custom fields.

Responses

Response Schema: application/json

required

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

Default: []

List of rules for converting custom fields.

Request samples

Payload

Content type

application/json

{"$ref": "customfields.json"
}

Response samples

Content type

application/json

{"$ref": "customfields.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

Default: []

List of rules for converting custom fields.

Response samples

Content type

application/json

{"$ref": "customfields.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

Default: []

List of rules for converting custom fields.

Responses

Response Schema: application/json

required

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

Default: []

List of rules for converting custom fields.

Request samples

Payload

Content type

application/json

{"$ref": "customfields.json"
}

Response samples

Content type

application/json

{"$ref": "customfields.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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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 ] Default: [] 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

Payload

Content type

application/json

"path-key-01"

Response samples

Content type

application/json

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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 ] Default: [] 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

{"settings_keys": [ ],
"active_key": "path-key-01"
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-11-21T09:30:00+03:00"
},
"message": "Bad Request",
"schema_errors": [ ]
}

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

200
404
429
500

Content type

application/json

{"health": 0.999
}

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

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

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:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key_one",
"detail": "null"
}

VRt.Monitor [MT] (7.25.3009)

Description

Entity relationship diagram

Explorer

Create folder

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Getting a filesystem

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Update folder

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folder removal

Authorizations:

path Parameters

Responses

Response samples

Folder specification

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Folder path

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Folder key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Create folders (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Folders removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

File key

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Files removal (batch)

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Filesystem counters

Authorizations:

Responses

Response Schema: application/json

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/octet-stream
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional