openapi: 3.1.2
info:
title: VRt.Monitor [MT]
version: 7.43.3521
license:
name: Proprietary
url: https://veeroute.com/
termsOfService: https://veeroute.com/resources/terms_of_service
contact:
name: Veeroute Support Team
email: support@veeroute.com
x-logo:
url: ../images/monitor/monitor.svg
backgroundColor: '#FAFAFA'
altText: VRt.Monitor
description: 'Programming interface for the Veeroute Monitor tool.
# Description
The server side of Veeroute Monitor.
Main responsibilities:
* storage and processing of waves (input data for planning and trips with their
execution results)
* recalculation of trips during their execution
* creation and storage of statistics on trip execution results
* creation and storage of trip execution forecasts
## Order status
An order consists of one or more requests.
The order status is derived from the requests received from the performer during
the trip:
| Status | Description |
Expected Action |
|:------------|:----------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------|
| `FREE` | The order is not assigned to any trip, initial status |
The order will be assigned to a trip |
| `PLANNED` | The order is scheduled for a trip, awaiting execution |
The performer will begin fulfilling the order''s requests |
| `EXECUTING` | The performer has started fulfilling the order (`DEMAND_START`
fact) | The performer will fulfill
all requests for the order |
| `FINISHED` | All requests for the order have been fulfilled (`DEMAND_DONE`
facts) or the `ORDER_DONE` fact has been received | This is the final status |
| `CANCELED` | Order canceled (fact `ORDER_CANCELED`) |
This is the final status |
The order facts `ORDER_DONE` (order completed) and `ORDER_CANCELED` (order canceled)
complete the order and all its requisitions entirely and have **priority** over
the requisition facts—conflicting requisition facts are ignored.
Status transition:
Planning: `FREE` -> `PLANNED`
Execution: `PLANNED` -> `EXECUTING` -> `FINISHED` / `CANCELED`
## Trip status
| Status. | Description | Expected
action |
|:------------|:--------------------------------------------------------|:----------------------------------------------|
| `FREE` | Trip created, crew not assigned | Operator
will assign a crew |
| `ASSIGNED` | Crew assigned | Operator
will send the assignment to the crew |
| `SENT` | Assignment sent to the crew | Crew
will confirm receipt |
| `RECEIVED` | Crew received the trip (fact `TRIP_RECEIVED`) | Crew
will accept or reject the trip |
| `CONFIRMED` | Crew agreed to perform the trip (fact `TRIP_CONFIRMED`) | Crew
will start performing the trip |
| `REJECTED` | Crew refused to perform the trip (fact `TRIP_REJECTED`) | Operator
will assign a new crew or cancel |
| `EXECUTING` | Crew is performing the trip (fact `TRIP_EXECUTING`) | Crew
will finish all tasks |
| `FINISHED` | Trip is finished — no work is left for the trip | This
is a terminal status |
| `CANCELED` | Trip canceled by the operator | This
is a terminal status |
Status transitions:
Operator: `FREE` → `ASSIGNED` → `SENT`
Crew: `RECEIVED` → `CONFIRMED` / `REJECTED` → `EXECUTING`
Conditions: `EXECUTING` → `FINISHED` / `CANCELED`
## Fact status
Any fact is created by a mobile device or external integration with the status
''NEW''.
Facts are processed by the server at a set frequency, and the status changes to
one of the following:
* `APPLIED` - the fact has been processed and the wave data has been successfully
modified
* `ERROR` - the fact has been processed with an error; the sender must correct
the fact and resubmit
## Changes subscription
Instead of polling the server for changes, an external integration can subscribe
to the data changes of the account waves and receive notifications.
How it works:
1. The integration creates a subscription ([create_wave_subscription](#tag/Waves/operation/create_wave_subscription)),
specifying its subscription key (`key`) and the address of its service (`callback_url`)
- the subscription is applied to all waves of the account at once.
2. As soon as the data of an active wave has changed, the server sends a notification
with the wave key (`file_key`) and the statistics on the entities of this wave
(`data_statistics`) to the specified address - but no more often than specified
in `notification_delay`.
3. The integration responds with the `200` code and starts processing the data
- it reads the wave data and updates it on its side.
4. If the external service did not respond with the `200` code within the `request_timeout`,
the server repeats sending the notification `retry_attempts` times with the `retry_interval`
interval.
Features:
* the subscription is created for an account and is applied to all its waves -
the filter cannot be specified yet;
* notifications are sent only while the wave is active (the `ACTIVE` status) -
in an inactive wave, incoming data is not processed and notifications are not
sent, use [activate_wave](#tag/Waves/operation/activate_wave) for activation;
* several subscriptions can be created for an account - for example, one for each
external integration; subscriptions differ by the key (`key`), which is unique
within the account, and work independently of each other;
* a subscription cannot be changed - to change the settings, delete it ([delete_wave_subscription](#tag/Waves/operation/delete_wave_subscription))
and create it again, the list of all account subscriptions is available in [list_wave_subscriptions](#tag/Waves/operation/list_wave_subscriptions);
* the same notification may be received again (for example, if the integration
response did not reach the server), so the statistics in the notification is for
information only, and the source of truth is the wave data read by the integration.
## Entity diagram
'
servers:
- url: https://api.edge7.veeroute.cloud
description: Environment for integration and early access to the new features
- url: https://api.prod7.veeroute.cloud
description: Production environment
security:
- ApiKeyAuth: []
tags:
- name: Explorer
description: 'Virtual filesystem management.
'
- name: Backups
description: 'Bulk data export and import.
'
- name: Store
description: 'Binary data storage.
'
- name: Crews
description: 'A crew combines:
* a real performer (or a group of performers) that performs orders
* a transport that is used to perform orders
* mobile devices to which trips are sent and from which facts about the execution
process are received
For each crew an account is automatically created for authorization. A crew can
connect to the server with a single account from multiple devices simultaneously.
All crews are bound to a company and are available for reading depending on the
role model:
* `USER`: all crews of the company whose `owner_username` matches the user''s
`username` are available
* `COMPANYOWNER`: all crews of the company across all users are available
* `OVERLORD`: all crews of all companies are available
* for other roles, reading crews is not available
Creating and modifying crews is available only for the `CREWMANAGER` role.
A crew is assigned to a trip by a logistician via the web interface or by an integration
module via API using the [create_deal](#tag/Deals/operation/create_deal) method.
At any single moment in time a crew can be performing only one trip from one wave,
while the number of trips assigned to it can be more than one.
'
- name: Waves
description: 'Management of planning and execution waves.
A wave consists of:
- Input data for the calculation (orders, performers, transport, settings)
- Calculation results (trips, statistics)
- Execution results (facts)
A wave can be active or inactive (the `status` field).
In an active wave (`ACTIVE`) processing of incoming facts is enabled and the autopilot
can be turned on.
In an inactive wave (`INACTIVE`) fact processing is disabled.
Wave activity is managed with the activation and deactivation methods.
'
- name: Deals
description: 'Deal management.
A deal is the assignment of a crew to a specific trip from a specific wave.
The object is temporary and is automatically removed after the crew finishes the
trip.
'
- name: Locations
description: 'Locations management.
'
- name: Performers
description: 'Performers management.
'
- name: Transports
description: 'Transports management.
'
- name: Orders
description: 'Orders management.
'
- name: Hardlinks
description: 'Hardlinks management.
'
- name: Trips
description: 'Trips management.
'
- name: Facts
description: 'Facts management.
A fact is an action completed during the execution of a trip, facts are created
by the performer mobile application or by an external integration.'
- name: Autopilot
description: 'Autopilot management.
'
- name: Tracker
description: 'Tracking.
'
- name: Analytics
description: 'Analytics.
Main responsibilities of this block:
- creation and storage of statistics on trip execution results
- creation and storage of trip execution forecasts
'
- name: Reports
description: 'Reports.
'
- name: Scenarios
description: 'Settings for user-defined trip execution scenarios.
'
- name: User
description: 'User interface settings.
'
- name: CustomFields
description: 'Custom field conversion settings.
Additional columns are provided in the table to display values from attributes.
This setting defines the rules for converting attribute values into the corresponding
typed fields.
Conversion happens at read time — therefore, conversion rules do not affect the
data and can be changed at any moment.
'
- name: CustomIcons
description: 'Icon settings.
'
- name: System
description: 'System functions.
Auxiliary functionality common to all services.
'
externalDocs:
description: Veeroute company website
url: https://veeroute.com/
paths:
/monitor/explorer:
post:
tags:
- Explorer
summary: Create folder
description: Create new folder.
operationId: create_folder
x-process-type: TRACE
requestBody:
description: '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.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/folder_specification'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: New folder key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- Explorer
summary: Getting a filesystem
description: Getting a filesystem.
operationId: read_filesystem
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/folder_key'
description: Parent folder key, if not specified - a list of root folders
is returned
- $ref: '#/components/parameters/filter'
description: "Filter for searching by text fields - only those folders that\
\ contain a substring from the filter are returned:\n * in folder name\n\
\ * in folder comment\n"
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/filesystem_column'
- $ref: '#/components/parameters/sort_direction'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/filesystem'
examples:
DataExplorer:
$ref: '#/components/examples/DataExplorer'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/{target_folder_key}:
put:
tags:
- Explorer
summary: Update folder
description: Rename and move folder.
operationId: update_folder
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
requestBody:
description: Folder update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/folder_specification'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/filesystem'
examples:
DataExplorer:
$ref: '#/components/examples/DataExplorer'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Explorer
summary: Folder removal
description: Folder removal by key.
operationId: delete_folder
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
responses:
'204':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/{target_folder_key}/specification:
get:
tags:
- Explorer
summary: Folder specification
description: 'Getting a folder specification.
'
operationId: read_folder_specification
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/folder_specification'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/{target_folder_key}/path:
get:
tags:
- Explorer
summary: Folder path
description: Folder path.
operationId: read_folder_path
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/filesystem_path'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/batch/folders:
post:
tags:
- Explorer
summary: Create folders (batch)
description: Create new folder (batch).
operationId: create_folders_batch
x-process-type: TRACE
requestBody:
description: '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.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/folder_name_list'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: Last folder key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Explorer
summary: Folders removal (batch)
description: Batch delete folders.
operationId: delete_folders_batch
x-process-type: TRACE
requestBody:
description: List of folder keys that need to be deleted.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'204':
description: All folders were successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/batch/folder-key:
post:
tags:
- Explorer
summary: Folder key
description: Getting a folder key by path.
operationId: read_folder_key
x-process-type: TRACE
requestBody:
description: '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.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/folder_name_list'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: Last folder key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/batch/files:
get:
tags:
- Explorer
summary: File key
description: Getting a file key by path.
operationId: read_file_key
x-process-type: TRACE
requestBody:
description: '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.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/file_name_path'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: File key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Explorer
summary: Files removal (batch)
description: Batch delete files.
operationId: delete_files_batch
x-process-type: TRACE
requestBody:
description: List of file's keys that need to be deleted.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'204':
description: All files were successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/batch/sharing:
put:
tags:
- Explorer
summary: Enable sharing (batch)
description: Batch enable sharing.
operationId: enable_sharing_batch
x-process-type: TRACE
requestBody:
description: List of file keys for which sharing should be enabled.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'204':
description: File sharing was successfully enabled for all files
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Explorer
summary: Disable sharing (batch)
description: Batch disable sharing.
operationId: disable_sharing_batch
x-process-type: TRACE
requestBody:
description: List of file keys for which sharing should be disabled.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'204':
description: File sharing was successfully disabled for all files
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/explorer/batch/counters:
get:
tags:
- Explorer
summary: Filesystem counters
description: Getting a virtual filesystem counters.
operationId: read_filesystem_counters
x-process-type: NOTRACE
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/filesystem_counters'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/backups/{target_folder_key}:
post:
tags:
- Backups
summary: Folder export
description: 'Export folder with files.
'
operationId: create_backup
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
responses:
'200':
description: Data export completed successfully
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_zip'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Backups
summary: Folder import
description: 'Import folder with files. The folder should not be of type ROOT
and should be empty.
'
operationId: restore_backup
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/target_folder_key'
requestBody:
description: Data (ZIP).
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_zip'
responses:
'200':
description: Data import completed successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews:
post:
tags:
- Crews
summary: Crew creation
description: "A crew is created by a logistician via the web interface or the\
\ API integration module.\n\nAn authorization account is automatically created\
\ according to the following rules:\n\n* The crew account username is created\
\ by concatenating the following strings:\n\n `company key` + `_2_` + `crew\
\ key`,\n\n This ensures unique logins for crews from different companies.\n\
* The account role is [CREW]\n* The account password is taken from the `crew_specification.password`\
\ field.\n* `owner_username` is set to the `username` of the user calling\
\ the creation method.\n* `owner_company_key` is set to the `company_key`\
\ of the user calling the creation method.\n"
operationId: create_crew
x-process-type: TRACE
requestBody:
description: Crew creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_specification'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/crew'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Crews
summary: Crew update
description: Updating the crew information.
operationId: update_crew
x-process-type: TRACE
requestBody:
description: Crew update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_specification'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/crew'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/{crew_key}:
get:
tags:
- Crews
summary: Getting crew information
description: Getting crew information by key.
operationId: read_crew
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/crew_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_crew'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Crews
summary: Delete crew
description: 'Delete a crew.
A crew cannot be deleted if a trip is assigned to it (i.e. a deal exists).
When a crew is deleted, the account associated with it is also deleted, along
with all audit actions and all statistics for that account.
'
operationId: delete_crew
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/crew_key'
responses:
'204':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/table/batch:
post:
tags:
- Crews
summary: Reading crews (table)
description: Getting a list of crews.
operationId: read_crews_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_crew_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Crews filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_crew_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/table_crew_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Crews
summary: Crews removal (batch)
description: Batch crews delete.
operationId: delete_crews_batch
x-process-type: TRACE
requestBody:
description: Request to delete crews.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_key_list'
responses:
'204':
description: Crews successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/table/trackpoints:
post:
tags:
- Crews
summary: Crew trackpoints
description: Getting a crew trackpoints.
operationId: read_crews_trackpoints
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Crews filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_crew_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/crew_trackpoint_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/actions/import/json:
post:
tags:
- Crews
summary: Import crews (JSON)
description: 'Importing new data from JSON file. If the entity is already present
(determined by its key), it is updated. If not, a new one is created.
'
operationId: import_crews_json
x-process-type: TRACE
requestBody:
description: Data (JSON).
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_specification_list'
responses:
'200':
description: Data import completed successfully
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/actions/import/xlsx:
post:
tags:
- Crews
summary: Import crews (XLSX)
description: 'Importing new data from XLSX file. If the entity is already present
(determined by its key), it is updated. If not, a new one is created.
'
operationId: import_crews_xlsx
x-process-type: TRACE
requestBody:
description: Data (XLSX).
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_xlsx'
responses:
'200':
description: Data import completed successfully
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/actions/export/json:
post:
tags:
- Crews
summary: Export crews (JSON)
description: 'Exporting crews to a JSON file.
'
operationId: export_crews_json
x-process-type: TRACE
responses:
'200':
description: Data export completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/crew_specification_list'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/actions/export/xlsx:
post:
tags:
- Crews
summary: Export crews (XLSX)
description: 'Exporting crews to a XLSX file.
'
operationId: export_crews_xlsx
x-process-type: TRACE
responses:
'200':
description: Data export completed successfully
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_xlsx'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/self/info:
get:
tags:
- Crews
summary: Self crew information
description: 'Getting crew information by login.
Available only for users with `CREW` role.
'
operationId: read_self_crew_info
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/crew'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/self/device:
post:
tags:
- Crews
summary: Update device
description: 'Updating information about your device (by login). Available only
for users with `CREW` role.
'
operationId: update_self_crew_device
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
requestBody:
description: Request to update information about your device.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_device'
responses:
'200':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/crews/self/trackpoint:
post:
tags:
- Crews
summary: Update coordinates
description: 'Updating information about your location (by login). Available
only for users with `CREW` role.
'
operationId: update_self_crew_trackpoint
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
requestBody:
description: Request to update information about your location.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/crew_trackpoint'
responses:
'200':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/deals/{deal_key}:
get:
tags:
- Deals
summary: Getting deal information
description: Getting deal information by key.
operationId: read_deal
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/deal_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/deal'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/crews/availability:
post:
tags:
- Deals
summary: Read available crews
description: Obtaining a list of crews that can perform the specified trip.
operationId: read_trip_available_crews
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_crew_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Crews filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_crew_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/table_crew_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/actions/automatch:
post:
tags:
- Deals
summary: Automatching crews (batch)
description: "Automatic crew selection and trip assignment (batch).\nAutomatic\
\ selection finds suitable crews based on the following parameters:\n\n *\
\ the crew is available (does not have another trip for the searched time\
\ slot)\n * the crew meets the performer compatibility requirements (`crew.performer_compatibilities`\
\ is checked against `performer.compatibilities`)\n * the crew meets the\
\ performer limitations requirements (`crew.performer_limits` is checked against\
\ `performer.limits`)\n * the crew has the same transport type (`crew.transport_type`\
\ is equal to `transport.transport_type`)\n * the crew meets the transport\
\ capacity requirements (`crew.transport_boxes` is checked against `transport.boxes`)\n\
\ * the crew meets the transport compatibility requirements (`crew.transport_compatibilities`\
\ is checked against `transport.compatibilities`)\n * the crew meets the\
\ transport limitations requirements (`crew.transport_limits`) checked against\
\ `transport.limits`)\n"
operationId: automatch_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request for automatic crew matching for trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
responses:
'204':
description: Autoassignment completed successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/actions/assignment:
post:
tags:
- Deals
summary: Assign trips (batch)
description: 'Free trips to a crew (batch).
'
operationId: assign_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to assign trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/trip_assignment_list'
responses:
'204':
description: Trips successfully assigned
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Deals
summary: Free trips (batch)
description: 'Free trips (batch) - removes crew assignments. If the trips key
list is empty, all trips in the wave are released.
'
operationId: free_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to free trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
responses:
'204':
description: Trips successfully free
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/actions/execution:
post:
tags:
- Deals
summary: Run trips (batch)
description: 'Run trips (batch). If the trip key list is empty, all trips from
the wave are run.
'
operationId: run_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to run trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
responses:
'200':
description: Trips successfully run
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Deals
summary: Stop trips (batch)
description: 'Stop trips (batch). If the trip key list is empty, all trips from
the wave are stop.
'
operationId: stop_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to stop trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
responses:
'204':
description: Trips successfully stop
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/deals/self/trips:
get:
tags:
- Deals
summary: Self crew trips
description: Getting a crew trips by login. Available only for users with `CREW`
role.
operationId: read_self_trips
x-process-type: TRACE
x-badges:
- name: APP
position: after
color: '#050505'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/deal_trip_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/data/batch/mobile:
get:
tags:
- Deals
summary: Data from trip
description: Read trip data. Available only for users with `CREW` role.
operationId: read_trip_data
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/mobile_trip_data'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/facts/batch/mobile:
get:
tags:
- Deals
summary: Facts from trip
description: Read facts from trip. Available only for users with `CREW` role.
operationId: read_trip_facts
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/mobile_fact_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/store:
post:
tags:
- Store
summary: Uploading one file
description: Uploading one file.
operationId: upload_binary_file
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: File with data (octet-stream).
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_binary'
responses:
'201':
description: File successfully uploaded, the key is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/store_key'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- Store
summary: Downloading one file
description: Downloading a file by key.
operationId: download_binary_file
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/store_key'
responses:
'200':
description: File successfully downloaded
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_binary'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Store
summary: Deleting one file
description: Removing a file by key.
operationId: delete_binary_file
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/store_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves:
post:
tags:
- Waves
summary: Create wave
description: Create new wave.
operationId: create_wave
x-process-type: TRACE
requestBody:
description: wave create request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/file_specification'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: New wave key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}:
get:
tags:
- Waves
summary: Reading wave
description: Getting wave information by key.
operationId: read_wave
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Waves
summary: Wave update
description: Rename \ move wave.
operationId: update_wave_specification
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: wave specification update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/file_specification'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Waves
summary: Wave removal
description: Wave removal by key.
operationId: delete_wave
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'204':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/batch/table:
get:
tags:
- Waves
summary: Waves list (table)
description: Getting a table with wave.
operationId: read_waves_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/folder_key'
- $ref: '#/components/parameters/filter'
description: '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.
'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_wave_column'
- $ref: '#/components/parameters/sort_direction'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/table_wave_list'
examples:
TableWaveList:
$ref: '#/components/examples/TableWaveList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/batch/search:
get:
tags:
- Waves
summary: Wave search
description: Wave global search.
operationId: search_waves
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/filter_required'
description: '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.
'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_wave_column'
- $ref: '#/components/parameters/sort_direction'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/table_wave_list'
examples:
TableWaveList:
$ref: '#/components/examples/TableWaveList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/batch/subscriptions:
post:
tags:
- Waves
summary: Create wave data changes subscription
description: 'Creating a subscription to the data changes of the account waves
- the filter cannot be specified, the subscription is applied to all waves
of the account at once.
The subscription specifies the subscription key (`key`) and the address of
the external service (`callback_url`) - the server will notify the external
service that the wave data has changed and will send the statistics on the
entities of this wave.
Several subscriptions can be created for an account - for example, one for
each external integration. The subscription key is unique within the account,
the subscriptions work independently of each other.
A subscription cannot be changed - to change the settings, delete the subscription
([delete_wave_subscription](#tag/Waves/operation/delete_wave_subscription))
and create it again.
Notifications are sent only while the wave is active - see [activate_wave](#tag/Waves/operation/activate_wave).
'
operationId: create_wave_subscription
x-process-type: TRACE
requestBody:
description: Wave data changes subscription settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/wave_subscription'
responses:
'200':
description: The subscription has been successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/wave_subscription'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
callbacks:
wave_notification:
callback-url:
post:
tags:
- Waves
summary: Wave data change notification
description: 'The method is implemented by an external integration at
the address specified in the subscription (`callback_url`).
The server sends a notification on any data change of an active wave,
but no more often than specified in `notification_delay`.
The notification contains the wave key (`file_key`) and the statistics
on the wave entities (`data_statistics`) - after receiving it, the
integration reads the required wave data using its own methods.
If the external service did not respond with the `200` code within
the `request_timeout`, the sending is repeated `retry_attempts` times
with the `retry_interval` interval.
'
operationId: notify_wave_data
requestBody:
description: Wave data change notification.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/wave_notification'
responses:
'200':
description: The notification is accepted by the external integration
'400':
description: There are errors in the data, the server will not resend
the same message and will continue to the next cycle
default:
description: The notification was not accepted, the server will
retry sending
get:
tags:
- Waves
summary: Read wave data changes subscription list
description: 'Reading the list of all account subscriptions to the wave data
changes.
If there are no subscriptions, an empty list is returned.
'
operationId: list_wave_subscriptions
x-process-type: NOTRACE
responses:
'200':
description: The subscription list was received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/wave_subscription_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/batch/subscriptions/{subscription_key}:
delete:
tags:
- Waves
summary: Delete wave data changes subscription
description: 'Deleting the wave data changes subscription by the subscription
key - notifications for it stop being sent.
The remaining account subscriptions continue to work.
If a subscription with such a key has not been created, the `404` code is
returned.
'
operationId: delete_wave_subscription
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/subscription_key'
responses:
'204':
description: The subscription has been successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/settings:
put:
tags:
- Waves
summary: Settings update
description: Update wave settings.
operationId: update_wave_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Wave settings update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/experiment_settings'
examples:
ExperimentSettings:
$ref: '#/components/examples/ExperimentSettings'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/duplicate:
post:
tags:
- Waves
summary: Wave duplicate
description: Wave duplicate.
operationId: duplicate_wave
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: wave duplicate request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/file_specification'
description: Parameters of the new wave that will result from duplication.
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key'
description: Duplicated wave key.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/locate:
get:
tags:
- Waves
summary: Wave path
description: Wave path.
operationId: read_wave_path
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/filesystem_path'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/neighbors:
get:
tags:
- Waves
summary: File neighbors
description: File neighbors.
operationId: read_file_neighbors
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/table_wave_column'
- $ref: '#/components/parameters/sort_direction'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/file_neighbors'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/import/xlsx:
post:
tags:
- Waves
summary: Import (XLSX)
description: '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.
'
operationId: import_xlsx
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Data (XLSX).
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_xlsx'
responses:
'200':
description: Data import completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/import/json:
post:
tags:
- Waves
summary: Import (JSON)
description: '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.
'
operationId: import_json
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Data (JSON).
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/universal_data'
examples:
UniversalData:
$ref: '#/components/examples/UniversalData'
responses:
'200':
description: Data import completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/import/json-url:
post:
tags:
- Waves
summary: Import by URL (JSON)
description: 'Importing new data from a VRt.Universal JSON file by url. If the
entity is already present in the wave (determined by its key), it is updated,
if not, a new one is created.
'
operationId: import_json_url
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- name: url
description: Url to json file.
in: query
required: true
schema:
description: Url.
type: string
format: uri
example: https://docs.edge7.veeroute.cloud/dataset/universal/dataset-12-soft-window.json
responses:
'200':
description: Data import completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/import/experiment/{studio_experiment_key}:
post:
tags:
- Waves
summary: Import from Studio
description: 'Importing new data from a VRt.Universal JSON file by experiment
key from VRt.Studio. If the entity is already present in the wave (determined
by its key), it is updated, if not, a new one is created.
'
operationId: import_experiment_from_studio
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- name: studio_experiment_key
description: Experiment key from VRt.Studio, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/unique_key'
responses:
'200':
description: Data import completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Wave:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400_with_errors_and_warnings'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/export/xlsx:
post:
tags:
- Waves
summary: Export (XLSX)
description: Export (XLSX).
operationId: export_xlsx
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/timezone'
responses:
'200':
description: Data export completed successfully
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_xlsx'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/export/json:
post:
tags:
- Waves
summary: Export (JSON)
description: 'Export data to VRt.Universal JSON file.
'
operationId: export_json
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'200':
description: Data export completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/universal_data'
examples:
UniversalData:
$ref: '#/components/examples/UniversalData'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/activation:
post:
tags:
- Waves
summary: Activate wave
description: "Wave activation - switching the wave to the `ACTIVE` status:\n\
\ * processing of incoming facts is enabled\n * autopilot can be turned\
\ on\n"
operationId: activate_wave
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Experiment:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Waves
summary: Deactivate wave
description: 'Wave deactivation - switching the wave to the `INACTIVE` status.
Processing of incoming facts is disabled, the autopilot (if it was running)
is stopped.
'
operationId: deactivate_wave
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'204':
description: Successful execution - the wave has been deactivated
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/validation:
post:
tags:
- Waves
summary: Run validation
description: Validation run.
operationId: run_wave_validation
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Experiment:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/locations:
post:
tags:
- Locations
summary: Create location
description: Create location.
operationId: create_location
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: New essence creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/location'
examples:
RawLocation:
$ref: '#/components/examples/RawLocation'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_location'
examples:
WebLocation:
$ref: '#/components/examples/WebLocation'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Locations
summary: Update location
description: Updating the location by key.
operationId: update_location
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Essence update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/location'
examples:
RawLocation:
$ref: '#/components/examples/RawLocation'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_location'
examples:
WebLocation:
$ref: '#/components/examples/WebLocation'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/locations/{essence_key}:
get:
tags:
- Locations
summary: Read location
description: Getting location information by key.
operationId: read_location
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_location'
examples:
WebLocation:
$ref: '#/components/examples/WebLocation'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Locations
summary: Remove location
description: Removing a location by key.
operationId: delete_location
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/locations/batch/table:
post:
tags:
- Locations
summary: Locations list
description: Getting a locations list.
operationId: read_locations_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_location_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Locations filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_location_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_location_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Locations
summary: Delete locations (batch)
description: Removing locations from the file.
operationId: delete_locations_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete locations.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Locations successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/locations/batch/geopoints:
post:
tags:
- Locations
summary: Location geopoints
description: Getting a geopoints.
operationId: read_locations_geopoints
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Locations filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_location_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_location_geopoint_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/locations/batch/metrics:
post:
tags:
- Locations
summary: Location metrics
description: Calculate general metrics for selected locations.
operationId: read_locations_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_location_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_location_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/performers:
post:
tags:
- Performers
summary: Create performer
description: Create performer.
operationId: create_performer
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Performer creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/performer'
examples:
RawPerformer:
$ref: '#/components/examples/RawPerformer'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_performer'
examples:
WebPerformer:
$ref: '#/components/examples/WebPerformer'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Performers
summary: Update performer
description: Updating the performer by key.
operationId: update_performer
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Performer update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/performer'
examples:
RawPerformer:
$ref: '#/components/examples/RawPerformer'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_performer'
examples:
WebPerformer:
$ref: '#/components/examples/WebPerformer'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/performers/{essence_key}:
get:
tags:
- Performers
summary: Read performer
description: Getting performer information by key.
operationId: read_performer
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_performer'
examples:
WebPerformer:
$ref: '#/components/examples/WebPerformer'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Performers
summary: Remove performer
description: Removing a performer by key.
operationId: delete_performer
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/performers/batch/table:
post:
tags:
- Performers
summary: Performers list
description: Getting a performers list.
operationId: read_performers_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_performer_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Performers filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_performer_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_performer_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Performers
summary: Delete performers (batch)
description: Removing performers from the file.
operationId: delete_performers_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete performers.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Performers successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/performers/batch/geopoints:
post:
tags:
- Performers
summary: Performer geopoints
description: Getting a geopoints.
operationId: read_performers_geopoints
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Performers filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_performer_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_performer_geopoint_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/performers/batch/metrics:
post:
tags:
- Performers
summary: Performer metrics
description: Calculate general metrics for selected performers.
operationId: read_performers_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_performer_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_performer_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/transports:
post:
tags:
- Transports
summary: Create transport
description: Creating a transport.
operationId: create_transport
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Transport creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transport'
examples:
RawTransport:
$ref: '#/components/examples/RawTransport'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_transport'
examples:
WebTransport:
$ref: '#/components/examples/WebTransport'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Transports
summary: Update transport
description: Updating a transport by its key.
operationId: update_transport
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Transport update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/transport'
examples:
RawTransport:
$ref: '#/components/examples/RawTransport'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_transport'
examples:
WebTransport:
$ref: '#/components/examples/WebTransport'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/transports/{essence_key}:
get:
tags:
- Transports
summary: Reading transport
description: Getting transport information by key.
operationId: read_transport
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_transport'
examples:
WebTransport:
$ref: '#/components/examples/WebTransport'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Transports
summary: Remove transport
description: Removing a transport by key.
operationId: delete_transport
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/transports/batch/table:
post:
tags:
- Transports
summary: Transport list
description: Getting a transport list.
operationId: read_transports_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_transport_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Transport filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_transport_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_transport_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Transports
summary: Delete transports (batch)
description: Removing transports from the file.
operationId: delete_transports_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete transports.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Transports successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/transports/batch/geopoints:
post:
tags:
- Transports
summary: Transport geopoints
description: Getting a geopoints.
operationId: read_transports_geopoints
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Transports filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_transport_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_transport_geopoint_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/transports/batch/metrics:
post:
tags:
- Transports
summary: Transport metrics
description: Calculate general metrics for selected transports.
operationId: read_transports_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_transport_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_transport_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders:
post:
tags:
- Orders
summary: Create order
description: New order creation.
operationId: create_order
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: New essence creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/order'
examples:
RawOrder:
$ref: '#/components/examples/RawOrder'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_order'
examples:
WebOrder:
$ref: '#/components/examples/WebOrder'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Orders
summary: Update order
description: Updating the essence by key.
operationId: update_order
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Essence update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/order'
examples:
RawOrder:
$ref: '#/components/examples/RawOrder'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_order'
examples:
WebOrder:
$ref: '#/components/examples/WebOrder'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders/{essence_key}:
get:
tags:
- Orders
summary: Reading order
description: Getting order information by key.
operationId: read_order
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_order'
examples:
WebOrder:
$ref: '#/components/examples/WebOrder'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Orders
summary: Deleting one order
description: Removing a essence by key.
operationId: delete_order
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders/batch/invoices:
put:
tags:
- Orders
summary: Update invoices (batch)
description: 'Updating cargo invoices for the orders of the dataset (batch).
Each cargo is addressed by a pair of keys - the order key and the cargo key.
Only already existing cargoes are updated - new cargoes are not added. If
you need to add or remove cargoes, use the order update function.
'
operationId: update_invoices_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Cargo invoices that need to be updated.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/order_cargo_invoice_list'
examples:
OrderCargoInvoiceList:
$ref: '#/components/examples/OrderCargoInvoiceList'
EmptyList:
$ref: '#/components/examples/EmptyList'
responses:
'204':
description: Cargo invoices updated successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders/batch/table:
post:
tags:
- Orders
summary: List orders
description: Getting a orders list.
operationId: read_orders_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_order_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Essence filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_order_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_order_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Orders
summary: Delete orders (batch)
description: Removing orders from the file.
operationId: delete_orders_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete orders.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Orders successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders/batch/geopoints:
post:
tags:
- Orders
summary: Order geopoints
description: Getting a geopoints.
operationId: read_orders_geopoints
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Orders filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_order_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_order_geopoint_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/orders/batch/metrics:
post:
tags:
- Orders
summary: Order metrics
description: Calculate general metrics for selected orders.
operationId: read_orders_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_order_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_order_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/hardlinks:
post:
tags:
- Hardlinks
summary: Create hardlink
description: Create new hardlink.
operationId: create_hardlink
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: New essence creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/hardlink'
examples:
RawHardlink:
$ref: '#/components/examples/RawHardlink'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_hardlink'
examples:
WebHardlink:
$ref: '#/components/examples/WebHardlink'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Hardlinks
summary: Update hardlink
description: Updating the hardlink by key.
operationId: update_hardlink
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Essence update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/hardlink'
examples:
RawHardlink:
$ref: '#/components/examples/RawHardlink'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_hardlink'
examples:
WebHardlink:
$ref: '#/components/examples/WebHardlink'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/hardlinks/{essence_key}:
get:
tags:
- Hardlinks
summary: Read hardlink
description: Getting hardlink information by key.
operationId: read_hardlink
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_hardlink'
examples:
WebHardlink:
$ref: '#/components/examples/WebHardlink'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Hardlinks
summary: Remove hardlink
description: Removing a essence by key.
operationId: delete_hardlink
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/hardlinks/batch/table:
post:
tags:
- Hardlinks
summary: List hardlinks
description: Getting a hardlinks list.
operationId: read_hardlinks_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_hardlink_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Hardlinks filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_hardlink_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_hardlink_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Hardlinks
summary: Delete hardlinks (batch)
description: Removing hardlinks from the file.
operationId: delete_hardlinks_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete hardlinks.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Hardlinks successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/hardlinks/batch/metrics:
post:
tags:
- Hardlinks
summary: Hardlink metrics
description: Calculate general metrics for selected hardlinks.
operationId: read_hardlinks_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_hardlink_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_hardlink_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips:
post:
tags:
- Trips
summary: Trip create
description: Creating a trip.
operationId: create_trip
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: New essence creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/trip'
examples:
RawTrip:
$ref: '#/components/examples/RawTrip'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_trip'
examples:
WebTrip:
$ref: '#/components/examples/WebTrip'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Trips
summary: Trip update
description: Updating a trip by key.
operationId: update_trip
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Essence update request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/trip'
examples:
RawTrip:
$ref: '#/components/examples/RawTrip'
responses:
'200':
description: Data updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_trip'
examples:
WebTrip:
$ref: '#/components/examples/WebTrip'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}:
get:
tags:
- Trips
summary: Read trip
description: Getting trip information by key.
operationId: read_trip
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_trip'
examples:
WebTrip:
$ref: '#/components/examples/WebTrip'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Trips
summary: Delete trip
description: Removing a trip by key.
operationId: delete_trip
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/batch/table:
post:
tags:
- Trips
summary: Reading trips (table)
description: Getting a trips list.
operationId: read_trips_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_trip_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Trip filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Trips
summary: Delete trips (batch)
description: Removing trips from the wave.
operationId: delete_trips_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete trips.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Trips successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/batch/charts:
post:
tags:
- Trips
summary: Trips chart
description: Getting a trips for chart.
operationId: read_trips_charts
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_trip_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Trips filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/web_trip_chart_list'
examples:
EmptyChartList:
$ref: '#/components/examples/EmptyChartList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/batch/tracks/{tracks_type}:
post:
tags:
- Trips
summary: Trip tracks
description: Getting a tracks.
operationId: read_trips_tracks
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/tracks_type'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
requestBody:
description: Trips filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/track_list'
examples:
TrackList:
$ref: '#/components/examples/TrackList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/batch/tracks-custom:
post:
tags:
- Trips
summary: Load custom tracks
description: Load custom tracks.
operationId: load_custom_tracks
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Custom tracks list.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/track_list_custom'
examples:
TrackListCustom:
$ref: '#/components/examples/TrackListCustom'
responses:
'200':
description: Custom tracks uploaded successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Trips
summary: Remove custom tracks
description: Remove custom all tracks.
operationId: delete_custom_tracks
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'204':
description: All custom tracks have been successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/batch/metrics:
post:
tags:
- Trips
summary: Trips metrics
description: Calculate general metrics for selected trips.
operationId: read_trips_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/stops/batch/table:
post:
tags:
- Trips
summary: Trip stops list (table)
description: Getting a trip stops list.
operationId: read_trip_stops
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_trip_stop_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Trip stops filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_stop_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_trip_stop_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/roundtrips/batch/table:
post:
tags:
- Trips
summary: Reading roundrips (table)
description: Getting a roundrips list.
operationId: read_roundtrips_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_roundtrip_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Trip filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_roundtrip_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_roundtrip_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/roundtrips/batch/metrics:
post:
tags:
- Trips
summary: Roundrips metrics
description: Calculate general metrics for selected roundrips.
operationId: read_roundtrips_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_roundtrip_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_roundtrip_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/tracks-plan:
get:
tags:
- Trips
summary: Planned trip track
description: Read planned trip track.
operationId: read_trip_track_plan
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/geotrack'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/trips/{essence_key}/tracks-history:
get:
tags:
- Trips
summary: Historical trip track
description: Read historical track of the trip.
operationId: read_trip_track_history
x-process-type: NOTRACE
x-badges:
- name: APP
position: after
color: '#050505'
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/geotrack'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts:
post:
tags:
- Facts
summary: Create fact
description: 'Creating a fact. You can only create a new fact with the ''NEW''
status.
'
operationId: create_fact
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: New essence creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/fact'
examples:
RawFact:
$ref: '#/components/examples/RawFact'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_fact'
examples:
WebFact:
$ref: '#/components/examples/WebFact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts/{essence_key}:
get:
tags:
- Facts
summary: Read fact
description: Getting fact information by key.
operationId: read_fact
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/web_fact'
examples:
WebFact:
$ref: '#/components/examples/WebFact'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Facts
summary: Deleting one fact
description: Removing a fact by key.
operationId: delete_fact
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'204':
description: Essence deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts/batch/table:
post:
tags:
- Facts
summary: List of facts
description: Getting a facts list.
operationId: read_facts_table
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/table_fact_column'
- $ref: '#/components/parameters/table_custom_column'
- $ref: '#/components/parameters/sort_direction'
requestBody:
description: Facts filter.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/table_fact_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_fact_list'
examples:
EmptyTableList:
$ref: '#/components/examples/EmptyTableList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Facts
summary: Delete facts (batch)
description: Removing facts from the file.
operationId: delete_facts_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Request to delete facts.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
examples:
EssenceKeyList:
$ref: '#/components/examples/EssenceKeyList'
responses:
'204':
description: Facts successfully deleted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts/batch/metrics:
post:
tags:
- Facts
summary: Fact metrics
description: Calculate general metrics for selected facts.
operationId: read_facts_metrics
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: 'Data for calculating metrics. If entity keys are specified,
metrics are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/table_fact_metrics_filter_list'
examples:
FilterList:
$ref: '#/components/examples/FilterList'
responses:
'200':
description: Data received successfully
content:
application/json:
schema:
$ref: '#/components/schemas/table_fact_metrics'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts/batch/list:
post:
tags:
- Facts
summary: Create facts (batch)
description: 'Creating a facts. You can only create a new fact with the ''NEW''
status.
'
operationId: create_facts_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/batch_key'
requestBody:
description: Facts list creation request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/fact_list'
examples:
EmptyList:
$ref: '#/components/examples/EmptyList'
responses:
'201':
description: Successful execution
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/facts/batch/status:
get:
tags:
- Facts
summary: Checking batch status
description: Obtaining the processing status of a previously uploaded batch
of facts.
operationId: check_facts_batch
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/batch_key_required'
responses:
'200':
description: Current status of the fact batch
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/batch_status'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/waves/{file_key}/actions/autopilot:
post:
tags:
- Autopilot
summary: Run autopilot
description: "Turn on the autopilot — an automatic process that includes:\n\
\ * accounting for all incoming facts\n * processing of data changes\n \
\ * recalculation of existing trips\n * updating analytics on facts and building\
\ a forecast\n * assigning new trips to crews\n\nThe autopilot can only be\
\ turned on for an active wave (wave status is `ACTIVE`).\n"
operationId: run_wave_autopilot
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Autopilot parameters.
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/wave_autopilot_settings'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Experiment:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Autopilot
summary: Update autopilot
description: Update autopilot.
operationId: update_wave_autopilot
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
requestBody:
description: Autopilot parameters.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/wave_autopilot_settings'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/wave'
examples:
Experiment:
$ref: '#/components/examples/Wave'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Autopilot
summary: Stop autopilot
description: Stop autopilot.
operationId: stop_wave_autopilot
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
responses:
'204':
description: Successful execution - autopilot has been stopped
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/tracker/waves/{file_key}/orders/{essence_key}:
post:
tags:
- Tracker
summary: Creating an order tag
description: 'Generating a key-mark to track order.
'
operationId: generate_order_tracker_key
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/file_key'
- $ref: '#/components/parameters/essence_key'
responses:
'201':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/tracker/orders/{tracker_key}:
get:
tags:
- Tracker
summary: Order tracking
description: 'Order tracking by mark.
'
operationId: track_order
x-process-type: TRACE
security: []
parameters:
- $ref: '#/components/parameters/tracker_key'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_order_info'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/tracker:
post:
tags:
- Tracker
summary: Setting the active tracker settings key
description: 'Setting the active tracker settings key.
'
operationId: set_tracker_settings_active_key
x-process-type: NOTRACE
requestBody:
description: New key.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key'
responses:
'200':
description: Update active settings key completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- Tracker
summary: Reading tracker settings list
description: 'Reading the list of tracker settings keys.
'
operationId: list_tracker_settings
x-process-type: NOTRACE
responses:
'200':
description: Reading settings list completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/tracker/{settings_key}:
post:
tags:
- Tracker
summary: Create tracker settings
description: 'Create tracker settings.
'
operationId: create_tracker_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_settings'
responses:
'200':
description: Create settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- Tracker
summary: Reading tracker settings
description: 'Reading tracker settings.
'
operationId: read_tracker_settings
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'200':
description: Reading settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Tracker
summary: Update tracker settings
description: 'Update tracker settings.
'
operationId: update_tracker_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_settings'
responses:
'200':
description: Update settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/tracker_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Tracker
summary: Delete tracker settings
description: 'Delete tracker settings.
'
operationId: delete_tracker_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'204':
description: Settings have been deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/analytics/overview:
post:
tags:
- Analytics
summary: Analytics for the period
description: 'Analytics for the period.
'
operationId: generate_analytics_overview
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/datetime_from'
- $ref: '#/components/parameters/datetime_to'
requestBody:
description: Wave keys list.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/analytics_overview'
examples:
AnalyticsOverview:
$ref: '#/components/examples/AnalyticsOverview'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/reports/xlsx:
post:
tags:
- Reports
summary: Report creating
description: 'Creating report.
'
operationId: generate_report_xlsx
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/datetime_from'
- $ref: '#/components/parameters/datetime_to'
- $ref: '#/components/parameters/report_type'
requestBody:
description: List of wave keys for which data needs to be downloaded.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/unique_key_list'
responses:
'200':
description: Report created successfully
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_xlsx'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/scenarios:
post:
tags:
- Scenarios
summary: Create scenario
description: 'Create scenario.
'
operationId: create_scenario
x-process-type: TRACE
requestBody:
description: New scenario.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/scenario'
examples:
ScenarioSimple:
$ref: '#/components/examples/ScenarioSimple'
ScenarioComplex:
$ref: '#/components/examples/ScenarioComplex'
responses:
'200':
description: Create completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/scenario'
examples:
ScenarioSimple:
$ref: '#/components/examples/ScenarioSimple'
ScenarioComplex:
$ref: '#/components/examples/ScenarioComplex'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- Scenarios
summary: Reading scenario list
description: 'Reading the list of scenario keys.
'
operationId: list_scenarios
x-process-type: NOTRACE
responses:
'200':
description: Reading list completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/basic_essence_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- Scenarios
summary: Update scenario
description: 'Update scenario.
'
operationId: update_scenario
x-process-type: TRACE
requestBody:
description: New scenario.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/scenario'
examples:
ScenarioSimple:
$ref: '#/components/examples/ScenarioSimple'
ScenarioComplex:
$ref: '#/components/examples/ScenarioComplex'
responses:
'200':
description: Update completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/scenario'
examples:
ScenarioSimple:
$ref: '#/components/examples/ScenarioSimple'
ScenarioComplex:
$ref: '#/components/examples/ScenarioComplex'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/scenarios/{scenario_key}:
get:
tags:
- Scenarios
summary: Reading scenario
description: 'Reading scenario.
'
operationId: read_scenario
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/scenario_key'
responses:
'200':
description: Reading completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/scenario'
examples:
ScenarioSimple:
$ref: '#/components/examples/ScenarioSimple'
ScenarioComplex:
$ref: '#/components/examples/ScenarioComplex'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- Scenarios
summary: Delete scenario
description: 'Delete scenario.
'
operationId: delete_scenario
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/scenario_key'
responses:
'204':
description: Scenario have been deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/user:
post:
tags:
- User
summary: Setting the active user settings key
description: 'Setting the active user settings key.
'
operationId: set_user_settings_active_key
x-process-type: NOTRACE
requestBody:
description: New key.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key'
responses:
'200':
description: Update active settings key completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- User
summary: Reading user settings list
description: 'Reading the list of user settings keys.
'
operationId: list_user_settings
x-process-type: NOTRACE
responses:
'200':
description: Reading settings list completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/user/{settings_key}:
post:
tags:
- User
summary: Create user settings
description: 'Create user settings.
'
operationId: create_user_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/user_settings'
responses:
'200':
description: Create settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/user_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- User
summary: Reading user settings
description: 'Reading user settings.
'
operationId: read_user_settings
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'200':
description: Reading settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/user_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- User
summary: Update user settings
description: 'Update user settings.
'
operationId: update_user_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/user_settings'
responses:
'200':
description: Update settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/user_settings'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- User
summary: Delete user settings
description: 'Delete user settings.
'
operationId: delete_user_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'204':
description: Settings have been deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/customfields:
post:
tags:
- CustomFields
summary: Setting the active customfields key
description: 'Setting the active customfields key.
'
operationId: set_customfields_settings_active_key
x-process-type: NOTRACE
requestBody:
description: New key.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key'
responses:
'200':
description: Update active settings key completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- CustomFields
summary: Reading fields settings list
description: 'Reading the list of custom field settings keys.
'
operationId: list_customfields_settings
x-process-type: NOTRACE
responses:
'200':
description: Reading settings list completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/customfields/{settings_key}:
post:
tags:
- CustomFields
summary: Create fields settings
description: 'Create custom fields settings.
'
operationId: create_customfields_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/customfields_settings'
examples:
Customfields:
$ref: '#/components/examples/Customfields'
responses:
'200':
description: Create settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/customfields_settings'
examples:
Customfields:
$ref: '#/components/examples/Customfields'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- CustomFields
summary: Reading fields settings
description: 'Reading custom field settings.
'
operationId: read_customfields_settings
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'200':
description: Reading settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/customfields_settings'
examples:
Customfields:
$ref: '#/components/examples/Customfields'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- CustomFields
summary: Update fields settings
description: 'Update custom fields settings.
'
operationId: update_customfields_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/customfields_settings'
examples:
Customfields:
$ref: '#/components/examples/Customfields'
responses:
'200':
description: Update settings completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/customfields_settings'
examples:
Customfields:
$ref: '#/components/examples/Customfields'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- CustomFields
summary: Delete fields settings
description: 'Delete custom fields settings.
'
operationId: delete_customfields_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'204':
description: Settings have been deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/customicons:
post:
tags:
- CustomIcons
summary: Setting the active customicons key
description: 'Setting the active customicons key.
'
operationId: set_customicons_settings_active_key
x-process-type: NOTRACE
requestBody:
description: New key.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key'
responses:
'200':
description: Update active settings key completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- CustomIcons
summary: Reading icons settings list
description: 'Reading the list of custom field settings keys.
'
operationId: list_customicons_settings
x-process-type: NOTRACE
responses:
'200':
description: Reading settings list completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/settings_key_list'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/settings/customicons/{settings_key}:
post:
tags:
- CustomIcons
summary: Update icons settings
description: 'Create custom icons settings.
'
operationId: create_customicons_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_zip'
responses:
'200':
description: Create settings completed successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
get:
tags:
- CustomIcons
summary: Reading icons settings
description: 'Reading custom field settings.
'
operationId: read_customicons_settings
x-process-type: NOTRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'200':
description: Reading settings completed successfully
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_zip'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
put:
tags:
- CustomIcons
summary: Update icons settings
description: 'Update custom icons settings.
'
operationId: update_customicons_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
requestBody:
description: New settings.
required: true
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/file_zip'
responses:
'200':
description: Update settings completed successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
delete:
tags:
- CustomIcons
summary: Delete icons settings
description: 'Delete custom icons settings.
'
operationId: delete_customicons_settings
x-process-type: TRACE
parameters:
- $ref: '#/components/parameters/settings_key'
responses:
'204':
description: Settings have been deleted successfully
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'402':
$ref: '#/components/responses/402'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/system/check:
get:
tags:
- System
summary: Checking the availability
description: Checking the service availability.
operationId: check
x-process-type: NOTRACE
security: []
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/check_result'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/system/version:
get:
tags:
- System
summary: Getting the service version
description: Getting the service version.
operationId: version
x-process-type: NOTRACE
security: []
responses:
'200':
description: Successful execution
content:
application/json:
schema:
$ref: '#/components/schemas/version_result'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
/monitor/file/{filename}:
get:
tags:
- System
summary: Getting the documentation
description: Getting the file with this service documentation.
operationId: file
x-process-type: NOTRACE
security: []
parameters:
- $ref: '#/components/parameters/filename'
responses:
'200':
description: Successful execution
content:
text/html:
schema:
$ref: '#/components/schemas/file_html'
text/plain:
schema:
$ref: '#/components/schemas/file_json'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'429':
$ref: '#/components/responses/429'
'431':
$ref: '#/components/responses/431'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
'504':
$ref: '#/components/responses/504'
default:
$ref: '#/components/responses/503'
components:
securitySchemes:
ApiKeyAuth:
description: "For client [authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)\
\ \n[JWT token](https://en.wikipedia.org/wiki/JSON_Web_Token) is used,\nwhich\
\ must be specified in the header for each request in the format:\n\n`Authorization:\
\ Bearer `.\n\nToken can be obtained via VRt.Account API.\n"
type: http
scheme: bearer
bearerFormat: JWT
schemas:
unique_key:
description: Key, unique identifier.
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
filesystem_column_type:
description: 'The name of the column in the table with folders.
'
type: string
enum:
- NAME
- OWNER_COMPANY_KEY
- OWNER_USERNAME
- CREATION_DATE
- EXPIRATION_DATE
- FOLDERS_COUNT
- FILES_COUNT
default: NAME
example: CREATION_DATE
folder_type:
description: "Element type:\n * `ROOT` - root object\n * `FOLDER` - folder\n"
type: string
enum:
- ROOT
- FOLDER
example: FOLDER
folder_parent_key:
description: Parent folder key, `null` if the folder is root.
type:
- string
- 'null'
format: uuid
example: 11111111-2222-3333-4444-555555555555
folder_name:
description: Folder name.
type: string
minLength: 1
maxLength: 100
example: folder_1
folder_comment:
description: Folder comment.
type:
- string
- 'null'
default: null
minLength: 0
maxLength: 10000
example: long long long long text
folder_color:
description: Folder color.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 20
example: red
attribute:
description: Attribute.
type: object
additionalProperties: false
properties:
key:
description: Attribute's key.
type: string
minLength: 1
maxLength: 100
example: code
value:
description: Attribute's value.
type: string
minLength: 0
maxLength: 7000
example: X51
strategy:
description: "Attribute processing strategy: \n * `LASTMILE_REF_TIME` -\
\ when sending a task to the scheduler, the value (format [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6))\
\ of the attribute is replaced with a relative time; if the value is not\
\ in the format, the calculation stops with the `FAILED` status.\n"
type:
- string
- 'null'
minLength: 0
maxLength: 100
default: null
example: LASTMILE_REF_TIME
required:
- key
- value
attributes:
description: Attributes. Used to add service information.
type: array
uniqueItems: true
minItems: 0
maxItems: 250
items:
$ref: '#/components/schemas/attribute'
default: []
company_key_null:
description: Unique company key.
type:
- string
- 'null'
format: string
pattern: \w+
default: null
minLength: 3
maxLength: 256
example: smart_company
user_username_null:
description: Unique username for login.
type:
- string
- 'null'
pattern: \w+
default: null
minLength: 2
maxLength: 256
example: username_for_login
folder_expiration_date:
description: 'Date and time of automatic deletion in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
Null means that automatic deletion does not occur.
'
type:
- string
- 'null'
default: null
format: date-time
example: '2026-09-21T19:45:00Z'
folder_counters:
description: 'Current folder counters.
'
type: object
additionalProperties: false
properties:
folders_count:
description: The number of subfolders.
type: integer
format: int32
minimum: 0
maximum: 100000
example: 12
files_count:
description: The number of files.
type: integer
format: int32
minimum: 0
maximum: 100000
example: 16
required:
- folders_count
- files_count
folder:
description: 'Folder is an element of a virtual file system.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/unique_key'
type:
$ref: '#/components/schemas/folder_type'
parent_key:
$ref: '#/components/schemas/folder_parent_key'
name:
$ref: '#/components/schemas/folder_name'
comment:
$ref: '#/components/schemas/folder_comment'
color:
$ref: '#/components/schemas/folder_color'
attributes:
$ref: '#/components/schemas/attributes'
owner_company_key:
$ref: '#/components/schemas/company_key_null'
description: The key of the company that owns the folder, the system root
folder does not contain an owner.
owner_username:
$ref: '#/components/schemas/user_username_null'
description: Folder owner, the system root folder does not contain an owner.
creation_date:
description: 'Creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type:
- string
- 'null'
default: null
format: date-time
example: '2026-09-21T19:45:00Z'
expiration_date:
$ref: '#/components/schemas/folder_expiration_date'
counters:
$ref: '#/components/schemas/folder_counters'
required:
- key
- type
- name
- counters
table_list_counters_detail:
description: Detail counters by list.
type: object
additionalProperties: false
properties:
total:
description: Count.
type: integer
format: int32
minimum: 0
maximum: 100000
example: 1
required:
- total
table_list_counters:
description: Counters by list.
type: object
additionalProperties: false
properties:
overall:
$ref: '#/components/schemas/table_list_counters_detail'
description: General statistics, does not depend on the filter.
filter:
$ref: '#/components/schemas/table_list_counters_detail'
description: Filtered statistics.
required:
- overall
- filter
filesystem:
description: 'Virtual filesystem.
'
type: object
additionalProperties: false
properties:
current_folder:
$ref: '#/components/schemas/folder'
folders:
description: List of folders.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/folder'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- current_folder
- folders
- counters
process_code:
description: 'Unique process identifier. One is created per process, the same
for different requests for the same process.
'
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
request_code:
description: 'Unique identifier of the request. A new one is created for each
request.
'
type: string
format: uuid
example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
user_username:
description: Unique username for login.
type: string
pattern: \w+
minLength: 2
maxLength: 256
example: username_for_login
company_key:
description: Unique company key.
type: string
pattern: \w+
minLength: 3
maxLength: 256
example: smart_company
service:
description: Service name.
type: string
enum:
- UNIVERSAL
- ROUTING
- ACCOUNT
- ADMIN
- STUDIO
- MONITOR
- PACKER
- AGRO
- REGISTRY
- SUPPORT
example: UNIVERSAL
operation:
description: Operation (request) name.
type: string
pattern: \w+
minLength: 3
maxLength: 256
example: run_plan_calculation
tracedata:
description: Data for request tracing.
type: object
additionalProperties: false
properties:
process_code:
$ref: '#/components/schemas/process_code'
request_code:
$ref: '#/components/schemas/request_code'
username:
$ref: '#/components/schemas/user_username'
company:
$ref: '#/components/schemas/company_key'
service:
$ref: '#/components/schemas/service'
operation:
$ref: '#/components/schemas/operation'
env:
description: Environment identifier.
type: string
pattern: \S+
minLength: 2
maxLength: 256
example: edge7
pod:
description: Pod identifier.
type: string
pattern: \S+
minLength: 2
maxLength: 256
example: 11111111-2222-3333-4444-555555555555
time:
description: Date and time service method run in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
required:
- process_code
- request_code
- username
- company
- service
- operation
- env
- pod
- time
error_message:
description: Error message.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 2048
example: bad data
schema_error:
description: Data error by schema.
type: object
additionalProperties: false
properties:
entity:
description: Target entity identifier.
type:
- string
- 'null'
minLength: 1
maxLength: 1024
example: order_0001
message:
description: Error message.
type: string
minLength: 1
maxLength: 2048
example: bad input data
required:
- entity
- message
schema_error_list:
description: List of syntax errors - data does not match the schema.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/schema_error'
default: []
general_400:
description: Error details for 400 `Bad Request`.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
schema_errors:
$ref: '#/components/schemas/schema_error_list'
required:
- tracedata
general_402:
description: Error details for 402 `Payment Required`.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
required:
- tracedata
general_403:
description: Error details for 403 `Forbidden`.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
required:
- tracedata
general_404_detail:
description: Resource details.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
required:
- tracedata
nullable:
description: Null value.
type: 'null'
general_404:
description: 404 Error details.
type: object
additionalProperties: false
properties:
resource_key:
description: Resource identifier.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: resource_key_one
detail:
description: Resource details if possible.
oneOf:
- $ref: '#/components/schemas/general_404_detail'
- $ref: '#/components/schemas/nullable'
default: null
general_429:
description: Error details for 429 `Too Many Requests`.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
required:
- tracedata
general_500:
description: Error details for 500 `Internal Server Error`.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
required:
- tracedata
folder_specification:
description: Folder specification.
type: object
additionalProperties: false
properties:
parent_key:
$ref: '#/components/schemas/folder_parent_key'
name:
$ref: '#/components/schemas/folder_name'
comment:
$ref: '#/components/schemas/folder_comment'
color:
$ref: '#/components/schemas/folder_color'
expiration_date:
$ref: '#/components/schemas/folder_expiration_date'
attributes:
$ref: '#/components/schemas/attributes'
required:
- name
filesystem_path:
description: 'Path from file/folder to the root of the virtual file system.
'
type: object
additionalProperties: false
properties:
folders:
description: List of folders.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/folder'
required:
- folders
folder_name_list:
description: List of folder names from the root of the virtual filesystem.
type: array
uniqueItems: false
minItems: 0
maxItems: 10
items:
$ref: '#/components/schemas/folder_name'
default: []
unique_key_list:
description: A list of unique keys.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/unique_key'
default: []
example:
- 11111111-2222-3333-4444-555555555555
file_name:
description: File name.
type: string
minLength: 1
maxLength: 100
example: file_1
file_name_path:
description: 'The path from the root of the virtual file system to the file
in the form of folder and file names.
'
type: object
additionalProperties: false
properties:
folder_names:
$ref: '#/components/schemas/folder_name_list'
file_name:
$ref: '#/components/schemas/file_name'
required:
- folder_names
- file_name
filesystem_counters:
description: 'Counters across the entire virtual file system.
'
type: object
additionalProperties: false
properties:
current:
$ref: '#/components/schemas/folder_counters'
description: Current number of available folders/files.
max:
$ref: '#/components/schemas/folder_counters'
description: Max number of available folders/files.
required:
- current
- max
file_zip:
description: ZIP archive with data.
type: string
format: byte
crew_key:
description: 'Unique crew key.
'
type: string
pattern: \w+
minLength: 3
maxLength: 256
example: mega_crew
user_password:
description: Password.
type:
- string
- 'null'
default: null
format: password
minLength: 10
maxLength: 256
writeOnly: true
example: long_strong_password
name:
description: Name, information field.
type: string
minLength: 0
maxLength: 128
default: ''
example: X1-ABC
user_phone:
description: User phone.
type:
- string
- 'null'
pattern: ^[+]{1}(?:[0-9\-$$\/\.]\s?){6,15}[0-9]{1}$
default: null
minLength: 5
maxLength: 32
example: '+71112223333'
compatibility_tag:
description: Tag used to determine [compatibility](#section/Description/Compatibilities).
type: string
minLength: 1
maxLength: 256
example: B1
compatibility_tag_list:
description: 'A list of tags that define a property or requirement.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/compatibility_tag'
default: []
time_window:
description: Time window.
type: object
additionalProperties: false
properties:
from:
description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
to:
description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T19:45:00Z'
required:
- from
- to
feature_lifetime:
description: Tag life time window.
type: object
additionalProperties: false
properties:
feature:
$ref: '#/components/schemas/compatibility_tag'
time_windows:
description: 'A list of time windows within which the specified tag exists.
If compatibility is affected by several features with different windows
- entities will be considered compatible within the intersection of windows.
There cannot be more than 4 intersections of the specified windows for
all tags for one performer.
'
type: array
minItems: 1
maxItems: 4
uniqueItems: true
items:
$ref: '#/components/schemas/time_window'
required:
- feature
- time_windows
feature_lifetime_list:
description: 'List of feature tag lifetime.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/feature_lifetime'
default: []
performer_compatibilities:
description: Compatibilities of [the performer with transport and orders](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
performer_features:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Performer''s features list. Used to check whether the performer
is compatible with orders.
'
performer_features_lifetimes:
$ref: '#/components/schemas/feature_lifetime_list'
description: 'List of feature lifetime. Affects on compatibility Performer-Order.
Compatibility operates in time windows that result from the intersection
of the time windows of all specified tags.
'
transport_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'List of transport requirements. Used to check whether the
transport is compatible with the performer.
'
time_duration:
description: Time duration according to `P1DT2H12M34.2S`.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT0S
example: PT1H45M
demand_extra_duration:
description: 'Additional time for the execution of the application by a certain
performer.
'
type: object
additionalProperties: false
properties:
demand_key:
description: The key of the ticket whose events need to increase the execution
time.
type: string
minLength: 1
maxLength: 1024
example: demand01.1
additional_duration:
$ref: '#/components/schemas/time_duration'
description: 'Additional execution time for all events of the specified
order for all shifts of the specified performer. According to `P1DT2H12M34.2S`.
'
required:
- demand_key
- additional_duration
performer_limits:
description: Limitation on the performer's workload.
type: object
additionalProperties: false
properties:
max_work_shifts:
description: Limit of the number of performer's shifts in one planning.
type: integer
format: int32
minimum: 1
maximum: 31
default: 31
example: 3
demand_extra_durations:
description: 'A list of demands for which the performer will spend more
time than indicated in the demand. Valid for the specified performer-order
pair for all performer''s shifts and all demands''s events.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/demand_extra_duration'
default: []
transport_type:
description: "Transport types:\n * `CAR` - car\n * `TRUCK_1500` - truck with\
\ permissible weight 1500 kg\n * `TRUCK_3000` - truck with permissible weight\
\ 3000 kg\n * `TRUCK_5000` - truck with permissible weight 5000 kg\n * `TRUCK_10000`\
\ - truck with permissible weight 10000 kg\n * `TRUCK_20000` - truck with\
\ permissible weight 20000 kg\n * `TRUCK_10000_L75_H35_W24_6000` - a truck\
\ with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5\
\ x 2.4 meters, and a permissible axle load of 6,000 kg\n * `TRUCK_18000_L95_H40_W26_11000`\
\ - a truck with a permitted weight of no more than 18,000 kg, dimensions\
\ of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg\n *\
\ `TRUCK_26000_L120_H40_W26_8000` - a truck with a permitted weight of no\
\ more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible\
\ axle load of 8000 kg\n * `TRUCK_GARBAGE_1` - truck for transporting garbage\
\ (type 1)\n * `TRUCK_GARBAGE_2` - truck for transporting garbage (type 2)\n\
\ * `TUK_TUK` - tuk-tuk\n * `BICYCLE` - bicycle\n * `PEDESTRIAN` - pedestrian\
\ \n * `PUBLIC_TRANSPORT` - public transport\n * `TELEPORT` - teleport\
\ (instant movement between points)\n \n Permissible weight is the weight\
\ of the equipped transport with cargo and driver, set by the manufacturer\
\ as the maximum allowable.\n"
type: string
enum:
- CAR
- TRUCK_1500
- TRUCK_3000
- TRUCK_5000
- TRUCK_10000
- TRUCK_20000
- TRUCK_10000_L75_H35_W24_6000
- TRUCK_18000_L95_H40_W26_11000
- TRUCK_26000_L120_H40_W26_8000
- TRUCK_GARBAGE_1
- TRUCK_GARBAGE_2
- TUK_TUK
- BICYCLE
- PEDESTRIAN
- PUBLIC_TRANSPORT
- TELEPORT
default: CAR
example: CAR
box_key:
description: 'Unique box key. Used to identify the cargo placement in boxes.
'
type: string
minLength: 1
maxLength: 1024
example: box01
capacity:
description: Capacity characteristics.
type: object
additionalProperties: false
properties:
mass:
description: Weight in kilograms.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 10
volume:
description: Volume in cubic meters.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_a:
description: 'Additional parameter (A) for measuring cargoes and boxes in
alternative units. For example, to account for cargo in pieces (this parameter
is equal to one for a cargo and the maximum number of cargo to hold for
a box).
'
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
capacity_b:
description: 'Additional parameter (B) for measuring cargoes and boxes in
alternative units.
'
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_c:
description: 'Additional parameter (C) for measuring cargoes and boxes in
alternative units.
'
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3
box_compatibilities:
description: Transport box [compatibilities](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
width:
description: Width in meters.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
height:
description: Height in meters.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3.1
length:
description: Length in meters.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2.1
box_features:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Box features list. Used to check whether the cargo is compatible
with the box.
'
box_limits:
description: Box limits.
type: object
additionalProperties: false
properties:
max_one_cargo_capacity:
description: Limitation on the maximum size of one cargo.
oneOf:
- $ref: '#/components/schemas/capacity'
- $ref: '#/components/schemas/nullable'
default: null
box:
description: 'A transport box capable to hold a cargo.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/box_key'
capacity:
description: The box capacity, which limits the maximum amount for all `capacity`
fields of *all* the cargoes.
oneOf:
- $ref: '#/components/schemas/capacity'
- $ref: '#/components/schemas/nullable'
default: null
compatibilities:
description: Transport box [compatibilities](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/box_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
limits:
description: Box limits.
oneOf:
- $ref: '#/components/schemas/box_limits'
- $ref: '#/components/schemas/nullable'
default: null
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
transport_compatibilities:
description: Compatibilities of [the transport with performers and locations](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
transport_features:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Transport features list. Used to check whether the transport
is compatible with locations and performers.
'
transport_features_lifetimes:
$ref: '#/components/schemas/feature_lifetime_list'
description: 'List of feature lifetime. Affects on compatibility Transport-Location.
Compatibility operates in time windows that result from the intersection
of the time windows of all specified tags.
'
performer_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'List of necessary requirements for the performer to use this
transport.
'
transport_limits:
description: Transport load limits.
type: object
additionalProperties: false
properties:
max_boxes:
description: 'Limit of the number of transports''s unique locations in one
trip. If not specified or null, number of using boxes is not limited.
The limit should not exceed the number of boxes.
'
type:
- integer
- 'null'
format: int32
default: null
minimum: 0
maximum: 100
example: 2
max_capacity:
description: 'Parameter limits overall transport load. If parameter not
specified - loading is limited only to each box. Applicable only if the
transport has more than one box. Parameter must not be less than the capacity
of any box.
'
oneOf:
- $ref: '#/components/schemas/capacity'
- $ref: '#/components/schemas/nullable'
default: null
crew_composition:
description: Detailed description of the crew composition — used by the automatic
process of assigning crews to trips.
type: object
additionalProperties: false
properties:
name:
$ref: '#/components/schemas/name'
phone:
$ref: '#/components/schemas/user_phone'
attributes:
$ref: '#/components/schemas/attributes'
performer_compatibilities:
description: Compatibilities of the performer with transport and orders.
oneOf:
- $ref: '#/components/schemas/performer_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
performer_limits:
description: Limitation on the performer's workload.
oneOf:
- $ref: '#/components/schemas/performer_limits'
- $ref: '#/components/schemas/nullable'
default: null
transport_type:
$ref: '#/components/schemas/transport_type'
transport_boxes:
description: A list of transport boxes that can accommodate the cargo.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/box'
default: []
transport_compatibilities:
description: Compatibilities of transport with performers and locations.
oneOf:
- $ref: '#/components/schemas/transport_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
transport_limits:
description: Transport load limits.
oneOf:
- $ref: '#/components/schemas/transport_limits'
- $ref: '#/components/schemas/nullable'
default: null
crew_specification:
description: 'Crew specification.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/crew_key'
password:
$ref: '#/components/schemas/user_password'
description: New password.
composition:
$ref: '#/components/schemas/crew_composition'
required:
- key
trip_key:
description: Trip key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: trip-0000-9999
deal:
description: 'Deal - the assignment of a crew to a specific trip from a specific
wave.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/unique_key'
description: Unique deal identifier.
crew_key:
$ref: '#/components/schemas/crew_key'
wave_key:
$ref: '#/components/schemas/unique_key'
trip_key:
$ref: '#/components/schemas/trip_key'
required:
- key
- crew_key
- wave_key
- trip_key
deal_list:
description: A deal list.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/deal'
default: []
crew_status:
description: Crew status.
type: object
additionalProperties: false
properties:
online:
description: Indicates the presence of a active connection.
type: boolean
default: false
example: true
deals:
$ref: '#/components/schemas/deal_list'
description: Linked current deals.
basic_essence_key:
description: Essence key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: key01
crew_device:
description: Information about the mobile device.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/basic_essence_key'
description: Unique device identifier.
app_version:
description: Application version.
type:
- string
- 'null'
default: null
minLength: 2
maxLength: 64
example: '7.51'
os_version:
description: Operation system version.
type:
- string
- 'null'
default: null
minLength: 2
maxLength: 64
example: '15.0'
manufacturer:
description: Mobile device manufacturer.
type:
- string
- 'null'
default: null
minLength: 2
maxLength: 64
example: Samsung
model:
description: Mobile device model.
type:
- string
- 'null'
default: null
minLength: 2
maxLength: 64
example: S25
required:
- key
crew_device_list:
description: List of device.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/crew_device'
crew:
description: Crew.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/crew_key'
account_username:
$ref: '#/components/schemas/user_username'
description: The username of the account that uses the crew.
owner_company_key:
$ref: '#/components/schemas/company_key'
description: The key of the company that owns the crew.
owner_username:
$ref: '#/components/schemas/user_username'
description: The username of the account that owns the crew.
status:
$ref: '#/components/schemas/crew_status'
composition:
$ref: '#/components/schemas/crew_composition'
devices:
$ref: '#/components/schemas/crew_device_list'
edit_date:
description: 'Last edit date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type: string
format: date-time
example: '2026-09-21T19:45:00Z'
required:
- key
- account_username
- owner_company_key
- owner_username
- status
- edit_date
basic_essence_key_null:
description: Essence key, unique identifier, may be `null`.
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: key01
table_string_search_field:
description: 'String table field. For the parent entity, a comma-separated
list of values is specified.
'
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: AAA
table_crew_fields:
description: Crew fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- CREW
default: CREW
example: CREW
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
account_username:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: true
owner_username:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: true
owner_company_key:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: true
composition_phone:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: true
status_online:
description: Indicates the presence of a active connection.
type: boolean
default: false
x-filter-type: BOOL_LIST
x-default-enabled: true
example: true
linked_essence:
description: Link to essence.
type: object
additionalProperties: false
properties:
essence_key:
$ref: '#/components/schemas/basic_essence_key'
essence_type:
description: Essence type.
type: string
enum:
- LOCATION
- ORDER
- ASSIGNED_ORDER
- PERFORMER
- TRANSPORT
- HARDLINK
- TRIP
- FACT
- CREW
example: LOCATION
essence_name:
description: Name, information field.
type:
- string
- 'null'
minLength: 1
maxLength: 128
default: null
example: X1-ABC
required:
- essence_key
- essence_type
linked_essence_list:
description: A list of linked essences.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/linked_essence'
default: []
web_crew:
description: Web Crew.
type: object
additionalProperties: false
properties:
crew:
$ref: '#/components/schemas/crew'
fields:
$ref: '#/components/schemas/table_crew_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- crew
table_crew_column_type:
description: "Column name in the table with crews:\n * `ESSENCE_KEY` - entity\
\ key\n"
type: string
enum:
- ESSENCE_KEY
- ACCOUNT_USERNAME
- OWNER_USERNAME
- OWNER_COMPANY_KEY
- COMPOSITION_PHONE
- STATUS_ONLINE
default: ESSENCE_KEY
example: OWNER_COMPANY_KEY
table_filter_type:
description: "Filter type:\n * `DATETIME_RANGE` - intersection of the time\
\ interval\n * `INT_RANGE` - getting a number inside an integer segment\n\
\ * `FLOAT_RANGE` - hitting the number inside the float segment\n * `DURATION_RANGE`\
\ - hitting inside the duration segment\n * `BOOL_LIST` - exact match of\
\ boolean values\n * `ENUM_LIST` - exact match of string values from enum\n\
\ * `STRING_LIST` - partial match of a subset of string values\n * `STRING_SEARCH`\
\ - partial match of a string\n"
type: string
enum:
- DATETIME_RANGE
- INT_RANGE
- FLOAT_RANGE
- DURATION_RANGE
- BOOL_LIST
- ENUM_LIST
- STRING_LIST
- STRING_SEARCH
example: STRING_SEARCH
table_filter_datetime_range:
description: Time window filter.
type: object
additionalProperties: false
properties:
from:
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type:
- string
- 'null'
format: date-time
example: '2026-09-21T08:45:00+03:00'
to:
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type:
- string
- 'null'
format: date-time
example: '2026-09-21T19:45:00+03:00'
table_filter_int_range:
description: Integer range filter.
type: object
additionalProperties: false
properties:
from:
description: Left side.
type: integer
format: int32
minimum: -10000000000
maximum: 10000000000
default: -999999999
example: 1
to:
description: Right side.
type: integer
format: int32
minimum: -10000000000
maximum: 10000000000
default: 999999999
example: 100
table_filter_float_range:
description: Float range filter.
type: object
additionalProperties: false
properties:
from:
description: Left side.
type: number
format: double
minimum: -1000000000000
maximum: 1000000000000
default: -9999999999.9
example: 1
to:
description: Right side.
type: number
format: double
minimum: -1000000000000
maximum: 1000000000000
default: 9999999999.9
example: 100
table_filter_duration_range:
description: Duration range.
type: object
additionalProperties: false
properties:
from:
$ref: '#/components/schemas/time_duration'
description: Left side.
example: PT10M
to:
$ref: '#/components/schemas/time_duration'
description: Right side.
example: PT30M
table_filter_bool_list:
description: Boolean list filter.
type: object
additionalProperties: false
properties:
elements:
description: A list of booleans.
type: array
uniqueItems: false
minItems: 0
maxItems: 2
items:
description: Boolean.
type: boolean
default: false
example: false
default: []
table_filter_enum_list:
description: Filter by a list of pre-known text values.
type: object
additionalProperties: false
properties:
elements:
description: A list of strings.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
description: Value.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: key01
default: []
table_filter_string_list:
description: String list filter.
type: object
additionalProperties: false
properties:
elements:
description: A list of strings.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
description: String for search.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: key01
default: []
strict:
description: Exact match (`true`) or search by occurrence of a sublist (`false`).
type: boolean
default: false
example: false
table_filter_string_search:
description: String search filter.
type: object
additionalProperties: false
properties:
text:
description: String for search.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: key01
strict:
description: Exact match (`true`) or search by occurrence of a substring
(`false`).
type: boolean
default: false
example: false
table_crew_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_crew_column_type'
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_crew_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_crew_filter'
default: []
table_crew:
description: Crew (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_crew_fields'
elements:
description: A list.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_crew_fields'
required:
- fields
- elements
table_crew_list:
description: A list.
type: object
additionalProperties: false
properties:
essences:
description: A list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_crew'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
crew_key_list:
description: List of essence keys.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/crew_key'
trackpoint:
description: A geographic point with a time reference.
type: object
additionalProperties: false
properties:
latitude:
description: Latitude in degrees.
type: number
format: double
minimum: -90
maximum: 90
example: 55.692789
longitude:
description: Longitude in degrees.
type: number
format: double
minimum: -180
maximum: 180
example: 37.554554
time:
description: Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type:
- string
- 'null'
format: date-time
default: null
example: '2026-09-21T09:30:00+03:00'
required:
- latitude
- longitude
crew_trackpoint:
description: Crew location with time reference.
type: object
additionalProperties: false
properties:
trackpoint:
$ref: '#/components/schemas/trackpoint'
crew_key:
$ref: '#/components/schemas/crew_key'
online:
description: Indicates the presence of a active connection.
type: boolean
default: false
example: true
required:
- trackpoint
- crew_key
crew_trackpoint_list:
description: Crew trackpoints.
type: object
additionalProperties: false
properties:
trackpoints:
description: A list of points.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/crew_trackpoint'
counters:
$ref: '#/components/schemas/table_list_counters'
description: Counters by list of entities.
trackpoints_counters:
$ref: '#/components/schemas/table_list_counters_detail'
description: Counters by list of points.
required:
- trackpoints
- counters
- trackpoints_counters
crew_specification_list:
description: List of data for creating crews.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/crew_specification'
entity_error_type:
description: "Error type:\n * `INCONSISTENT_REFERENCE` - bad reference key\
\ \n * `UNIQUE_IDS_VIOLATION` - all keys must be unique\n * `INVALID_ROUTING_MATRIX`\
\ - bad routing matrix dimension\n * `INVALID_GEO_PROVIDER` - bad geo provider\n\
\ * `INVALID_TIME_WINDOW` - bad time window\n * `COMPATIBILITY_CARGO_BOX`\
\ - no cargo is compatible with any box\n * `COMPATIBILITY_TRANSPORT_PERFORMER`\
\ - no transport is compatible with any performer\n * `COMPATIBILITY_TRANSPORT_LOCATION`\
\ - no transport is compatible with any location\n * `COMPATIBILITY_ORDER_PERFORMER`\
\ - no order is compatible with any performer\n * `INCONSISTENT_HARDLINK`\
\ - essence key must be only in one hardlink\n * `PLANNING_HORIZON_EXCEEDED`\
\ - planning horizon exceeded (difference between earliest and latest timestamp\
\ in dataset)\n * `MEANINGLESS_RESTRICTIONS` - the specified restrictions\
\ do not make sense\n * `LOCATION_LIMITS_VIOLATION` - the time windows of\
\ the constraint's validity must not overlap and their union must correspond\
\ to the location availability window `work_window`; if the `min_cargos`/`min_transports`\
\ constraint is specified, then the `max_cargos`/`max_transports` constraint\
\ must be specified; the `min_cargos`/`min_transports` constraints must be\
\ less than all the `max_cargos`/`max_transports` constraints; the `LOWEST_COST`\
\ time selection strategy is specified (currently not supported)\n * `PERFORMER_WRR_MUST_BE_SET`\
\ - at least one of the fields `rest_rules` or `break_rules` must be set for\
\ the work and rest schedule.\n * `PERFORMER_WRR_INVALID_REST_COUNT` - the\
\ number of rests cannot exceed 14\n * `PERFORMER_WRR_INVALID_BREAK_COUNT`\
\ - no more than 14 breaks can start between rests\n * `PERFORMER_WRR_MEANINGLESS_REST`\
\ - the specified rest cannot be inserted\n * `PERFORMER_WRR_MEANINGLESS_BREAK`\
\ - the specified break cannot be inserted\n * `TOO_MANY_WARNINGS` - the\
\ number of warnings is greater than 15001\n * `UNCLASSIFIED_ERROR` - unclassified\
\ error\n"
type: string
enum:
- INCONSISTENT_REFERENCE
- UNIQUE_IDS_VIOLATION
- INVALID_ROUTING_MATRIX
- INVALID_GEO_PROVIDER
- INVALID_TIME_WINDOW
- COMPATIBILITY_CARGO_BOX
- COMPATIBILITY_TRANSPORT_PERFORMER
- COMPATIBILITY_TRANSPORT_LOCATION
- COMPATIBILITY_ORDER_PERFORMER
- INCONSISTENT_HARDLINK
- PLANNING_HORIZON_EXCEEDED
- MEANINGLESS_RESTRICTIONS
- LOCATION_LIMITS_VIOLATION
- PERFORMER_WRR_MUST_BE_SET
- PERFORMER_WRR_INVALID_REST_COUNT
- PERFORMER_WRR_INVALID_BREAK_COUNT
- PERFORMER_WRR_MEANINGLESS_REST
- PERFORMER_WRR_MEANINGLESS_BREAK
- TOO_MANY_WARNINGS
- UNCLASSIFIED_ERROR
example: INCONSISTENT_REFERENCE
entity_type:
description: Entity type.
type: string
enum:
- TASK
- SETTINGS
- ORDER
- ORDER_LINK
- PERFORMER
- PERFORMER_LINK
- TRANSPORT
- TRANSPORT_LINK
- HARDLINK
- HARDLINK_LINK
- LOCATION
- LOCATION_LINK
- BOX
- BOX_LINK
- TRIP
- TRIP_LINK
- CARGO
- CARGO_LINK
- DEMAND
- DEMAND_LINK
- EVENT
- EVENT_LINK
- PERFORMER_SHIFT
- PERFORMER_SHIFT_LINK
- TRANSPORT_SHIFT
- TRANSPORT_SHIFT_LINK
- FACT
- FACT_LINK
example: ORDER
entity_path:
description: 'The description of the entity and the path to it.
'
type: object
additionalProperties: false
properties:
entity_key:
description: Target entity key.
type:
- string
- 'null'
minLength: 0
maxLength: 1024
example: order_0001
entity_type:
$ref: '#/components/schemas/entity_type'
child_entity:
description: Child entity if possible.
oneOf:
- $ref: '#/components/schemas/entity_path'
x-rust-boxed: true
- $ref: '#/components/schemas/nullable'
default: null
required:
- entity_key
- entity_type
entity_error:
description: Description of the error in the input data.
type: object
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/entity_error_type'
info:
description: Information about error.
type:
- string
- 'null'
minLength: 0
maxLength: 2048
default: null
example: entity error
entities:
description: List of entities related to error.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/entity_path'
required:
- type
- entities
entity_error_list:
description: 'List with fatal errors.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/entity_error'
default: []
entity_warning_type:
description: "Warning type:\n * `NO_AVAILABLE_TRANSPORT` - the order cannot\
\ be fulfilled, since there is no available (by shift limitations) transport\n\
\ * `NO_AVAILABLE_PERFORMER` - the order cannot be fulfilled, since there\
\ is not a single available (by shift limitations) performer\n * `NO_COMPATIBLE_TRANSPORT`\
\ - the order cannot be completed, since there is not a single compatible\
\ (in terms of capacity and \\ or compatibility tags) transport\n * `NO_COMPATIBLE_PERFORMER`\
\ - the order cannot be completed, since there is not a single compatible\
\ (by compatibility tags) performer\n * `NO_AVAILABLE_ORDER_FOR_TRANSPORT`\
\ - the transport is useless, since there are no compatible (by capacity and/or\
\ compatibility tags) orders\n * `NO_AVAILABLE_ORDER_FOR_PERFORMER` - the\
\ performer is useless, since there are no compatible (by capacity and/or\
\ compatibility tags) orders\n * `NO_COMPATIBLE_ORDER_FOR_TRANSPORT` - the\
\ transport is useless, since there are no available (by shift restrictions)\
\ orders\n * `NO_COMPATIBLE_ORDER_FOR_PERFORMER` - the performer is useless,\
\ since there are no available (by shift restrictions) orders\n * `PICKUP_AND_DROP_VIOLATION`\
\ - for each cargo within the order there must be exactly one loading and\
\ exactly one unloading (except for `PICKUP_TO_BOX` and `DROP_FROM_BOX` orders)\n\
\ * `PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_ORDER` - for each cargo within\
\ the order, loading must go before unloading (`precedence_in_order`)\n *\
\ `PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_TRIP` - conflicting requirements\
\ for the precedence of orders were specified (`precedence_in_trip`)\n *\
\ `VIOLATION_PRECEDENCE_IN_TRIP_AND_ORDER` - requirements for the precedence\
\ of orders in the trip (`precedence_in_trip`) and in the order (` precedence_in_order`)\
\ contradict each other\n * `TIME_WINDOW_VIOLATION` - the start time of the\
\ time window is later than the end time of the window or time window exceeds\
\ the maximum allowed\n * `DURATION_VIOLATION` - duration does not correspond\
\ to the allowed interval\n * `ORDER_WINDOWS_INTERSECTION_VIOLATION` - soft\
\ windows should not go beyond the boundaries of the hard window\n * `PERFORMER_SHIFTS_INTERSECTION_VIOLATION`\
\ - time ranges of the performer's work shifts must not overlap, the beginning\
\ of the next window cannot be equal to the end of the previous one\n * `TRANSPORT_SHIFTS_INTERSECTION_VIOLATION`\
\ - time ranges of transport work shifts should not overlap, the beginning\
\ of the next window cannot be equal to the end of the previous one\n * `LOCATION_WINDOWS_INTERSECTION_VIOLATION`\
\ - time ranges of working windows of one location should not intersect, the\
\ beginning of the next window cannot be equal to the end of the previous\
\ one\n * `NO_TRANSPORT_BOXES` - if there are orders with cargo, then the\
\ transport must have at least one box\n * `MAX_CAPACITY_VIOLATION` - `max_capacity`\
\ limit exceeds the total capacity of all boxes or set for only one box or\
\ less than the capacity of some box\n * `MAX_BOXES_VIOLATION` - limit `max_boxes`\
\ is greater than or equal to the total number of boxes or specified for one\
\ box or equal to zero\n * `TOO_MANY_CARGOS_FOR_DROP_VIOLATION` - the number\
\ of loads for an order of the` DROP` / `DROP_FROM_BOX` type must be no more\
\ than one\n * `EMPTY_CARGOES_LIST` - empty list of loads for orders of type\
\ `DROP` / `DROP_FROM_BOX` / `PICKUP` / `PICKUP_TO_BOX`\n * `CARGO_WORK_VIOLATION`\
\ - for a `WORK` order, the cargo list must be empty\n * `GEODATA_TIME_WINDOW_VIOLATION`\
\ - the planning horizon exceeds the maximum available value\n * `SHIFT_RESTRICTIONS_COULD_BE_MORE_PRECISE`\
\ - the `working_window` of the performer's shift does not lie entirely inside\
\ the availability window `availability_window`\n * `DURATION_DOES_NOT_FIT_INTO_HARD_WINDOW`\
\ - the duration of the event does not fit into the hard time window\n *\
\ `DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW` - the duration of the event does\
\ not fit into the soft time window\n * `EXTRA_DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW`\
\ - additional time for demand execution does not fit into the soft time window\n\
\ * `MAX_CALCULATION_TIME_VIOLATION` - the maximum allowable calculation\
\ time has been exceeded\n * `MAX_WAITING_TIME_VIOLATION` - the maximum allowable\
\ waiting time in queue has been exceeded\n * `INVALID_HARDLINK` - it is\
\ impossible to assign an order with demands with the `WORK` type to transport\n\
\ * `CARGO_BOX_VIOLATION` - for requests of all types except `DROP_FROM_BOX`\
\ the key of the box where the cargo is located must be empty\n * `CARGO_MULTIBOX_VIOLATION`\
\ - for a demand of type `DROP_FROM_BOX` the indicated cargos are in boxes\
\ of different transports\n * `CARGO_CAPACITY_VIOLATION` - the specified\
\ cargo on board exceeds the size of the box in which it is located\n * `CARGO_ORDER_VIOLATION`\
\ - the cargo specified in the order is not present in orders\n * `FEATURE_LIFETIME_VIOLATION`\
\ - feature time windows intersect with each other, or the `working_window`\
\ of the performer's or transport's shift does not intersect with the feature\
\ time window\n * `QUOTA_EXCEEDED` - service quota exceeded\n * `MAX_LOCATIONS_LIMITS_PENALTY_EXCEEDED`\
\ - the resulting solution does not satisfy the `max_locations_limits_penalty`\
\ requirement\n * `REMOVED_ITEMS_NOT_EMPTY` - during data validation, items\
\ were removed from the original dataset, the list of removed items is in\
\ the `removed_items` object\n * `INCOMPATIBLE_REQUIREMENTS` - incompatible\
\ requirements are specified: location load accounting and soft window optimization.\n\
\ * `UNCLASSIFIED_WARNING` - unclassified warning\n"
type: string
enum:
- NO_AVAILABLE_TRANSPORT
- NO_AVAILABLE_PERFORMER
- NO_COMPATIBLE_TRANSPORT
- NO_COMPATIBLE_PERFORMER
- NO_AVAILABLE_ORDER_FOR_TRANSPORT
- NO_AVAILABLE_ORDER_FOR_PERFORMER
- NO_COMPATIBLE_ORDER_FOR_TRANSPORT
- NO_COMPATIBLE_ORDER_FOR_PERFORMER
- PICKUP_AND_DROP_VIOLATION
- PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_ORDER
- PICKUP_AND_DROP_VIOLATION_PRECEDENCE_IN_TRIP
- VIOLATION_PRECEDENCE_IN_TRIP_AND_ORDER
- TIME_WINDOW_VIOLATION
- DURATION_VIOLATION
- ORDER_WINDOWS_INTERSECTION_VIOLATION
- PERFORMER_SHIFTS_INTERSECTION_VIOLATION
- TRANSPORT_SHIFTS_INTERSECTION_VIOLATION
- LOCATION_WINDOWS_INTERSECTION_VIOLATION
- NO_TRANSPORT_BOXES
- MAX_CAPACITY_VIOLATION
- MAX_BOXES_VIOLATION
- TOO_MANY_CARGOS_FOR_DROP_VIOLATION
- EMPTY_CARGOES_LIST
- CARGO_WORK_VIOLATION
- GEODATA_TIME_WINDOW_VIOLATION
- SHIFT_RESTRICTIONS_COULD_BE_MORE_PRECISE
- DURATION_DOES_NOT_FIT_INTO_HARD_WINDOW
- DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW
- EXTRA_DURATION_DOES_NOT_FIT_INTO_SOFT_WINDOW
- MAX_CALCULATION_TIME_VIOLATION
- MAX_WAITING_TIME_VIOLATION
- INVALID_HARDLINK
- CARGO_BOX_VIOLATION
- CARGO_MULTIBOX_VIOLATION
- CARGO_CAPACITY_VIOLATION
- CARGO_ORDER_VIOLATION
- FEATURE_LIFETIME_VIOLATION
- QUOTA_EXCEEDED
- MAX_LOCATIONS_LIMITS_PENALTY_EXCEEDED
- REMOVED_ITEMS_NOT_EMPTY
- INCOMPATIBLE_REQUIREMENTS
- UNCLASSIFIED_WARNING
example: TIME_WINDOW_VIOLATION
entity_warning:
description: Description of the warning of the input data.
type: object
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/entity_warning_type'
info:
description: Information about warning.
type:
- string
- 'null'
minLength: 0
maxLength: 2048
example: entity warning
entities:
description: List of entities related to warning.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/entity_path'
required:
- type
- entities
entity_warning_list:
description: Warning list.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/entity_warning'
default: []
universal_400_with_errors_and_warnings:
description: Error 400 details.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
message:
$ref: '#/components/schemas/error_message'
schema_errors:
$ref: '#/components/schemas/schema_error_list'
logical_errors:
$ref: '#/components/schemas/entity_error_list'
warnings:
$ref: '#/components/schemas/entity_warning_list'
required:
- tracedata
file_xlsx:
description: File with data in [XLSX](https://en.wikipedia.org/wiki/Microsoft_Excel)
format.
type: string
format: byte
basic_essence_key_list:
description: List of essence keys.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/basic_essence_key'
default: []
trip_assignment:
description: 'Assignment of a crew to a specific trip.
'
type: object
additionalProperties: false
properties:
crew_key:
$ref: '#/components/schemas/crew_key'
trip_key:
$ref: '#/components/schemas/trip_key'
required:
- crew_key
- trip_key
trip_assignment_list:
description: A deal list.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/trip_assignment'
default: []
assigned_performer:
description: Performer's shift assigned to the specified time (`shift_time`).
type: object
additionalProperties: false
properties:
performer_key:
description: Performer's key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: performer0001
shift_key:
description: Performer's shift key.
type: string
minLength: 1
maxLength: 1024
example: performer0001_shift01
shift_time:
$ref: '#/components/schemas/time_window'
required:
- performer_key
- shift_key
- shift_time
assigned_transport:
description: Transport's shift assigned to the specified time (`shift_time`).
type: object
additionalProperties: false
properties:
transport_key:
description: Transport key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: transport001
shift_key:
description: Transport's shift key.
type: string
minLength: 1
maxLength: 1024
example: performer01
shift_time:
$ref: '#/components/schemas/time_window'
required:
- transport_key
- shift_key
- shift_time
trip_state_flag:
description: '[Flag of state](#section/Description/Trip-model) inside trip.
'
type: string
enum:
- AROUND_LOCATION
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_WORKING_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_EVENT_SOFT_WINDOW
- ON_DEMAND
- WAITING
- RELOCATING
- BREAK
- REST
- DEPARTURE
- ARRIVAL
- DURING_ROUNDTRIP
example: RELOCATING
cargo_key:
description: Cargo key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: cargo01
cargo_action_type:
description: "Types of actions with cargo:\n * `ADD` - moving cargo into the\
\ box\n * `REMOVE` - moving cargo from the box\n"
type: string
enum:
- ADD
- REMOVE
example: ADD
cargo_action:
description: Action with a cargo.
type: object
additionalProperties: false
properties:
box_key:
$ref: '#/components/schemas/box_key'
cargo_key:
$ref: '#/components/schemas/cargo_key'
cargo_action_type:
$ref: '#/components/schemas/cargo_action_type'
required:
- box_key
- cargo_key
- cargo_action_type
cargo_action_list:
description: List of actions with cargo in transport at the beginning of the
state.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/cargo_action'
default: []
trip_state:
description: Trip state.
type: object
additionalProperties: false
properties:
time:
description: Start time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
order_key:
description: Key of the order with which an action is taken.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: order01
demand_key:
description: Key of the demand with which an action is taken.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: order01-demand2
event_key:
description: Key of the event at which an action is taken.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: order01-demand2-event1
location_key:
description: Key of the location at which an action is taken.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: location01
roundtrip_key:
description: Key of the roundtrip at which an action is taken.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: roundtrip01
flags:
description: "List of flags, describing current state. \nValues of flags\
\ responsible for geographic location (there can be several flags at the\
\ same time):\n * `AROUND_LOCATION` - the performer is near the location\
\ - in the process of parking or leaving it.\n * `INSIDE_LOCATION` -\
\ the performer is at the location.\n\nValues of flags responsible for\
\ being in time windows (there can be several flags at the same time):\n\
\ * `INSIDE_WORKING_WINDOW` - the performer is inside the working time\
\ window.\n * `INSIDE_LOCATION_WINDOW` - the performer is inside the\
\ working time of the location.\n * `INSIDE_EVENT_HARD_WINDOW` - the\
\ performer is inside the hard time window.\n * `INSIDE_EVENT_SOFT_WINDOW`\
\ - the performer is inside the soft time window.\n\nValues of flags responsible\
\ for actions (there can be only one flag at a time):\n * `ON_DEMAND`\
\ - the performer has started working on the request.\n * `WAITING` -\
\ the performer has started waiting.\n * `RELOCATING` - the performer\
\ has started moving to the next stop.\n * `BREAK` - the performer has\
\ started a break.\n * `REST` - the performer has started a long rest.\n\
\ * `ARRIVAL` - the performer has started parking.\n * `DEPARTURE` -\
\ the performer has finished leaving the parking lot.\n\nThe values of\
\ the flags responsible for the logical state:\n * `DURING_ROUNDTRIP`\
\ - the performer is making a roundtrip.\n"
type: array
uniqueItems: true
minItems: 0
maxItems: 9
items:
$ref: '#/components/schemas/trip_state_flag'
cargo_actions:
$ref: '#/components/schemas/cargo_action_list'
distance:
description: Cumulative distance from the start of the trip, in meters.
type: integer
format: int32
minimum: 0
maximum: 4000000000
default: 0
example: 5200
cost:
description: Cumulative cost from the start of the trip, calculated based
on the performers' and transport tariffs.
type: number
format: double
minimum: 0
maximum: 10000000000
default: 0
example: 1231.1
reward:
description: Cumulative reward from the start of the trip for orders fulfillment.
type: number
format: double
minimum: 0
maximum: 10000000000
default: 0
example: 2343.3
attributes:
$ref: '#/components/schemas/attributes'
required:
- time
- flags
trip_state_list:
description: List of performer's states.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/trip_state'
trip_waitlist:
description: 'List of order keys assigned to the performer, but not scheduled
for a specific time and not taken into account in the transport load.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
description: Order key.
type: string
minLength: 1
maxLength: 1024
default: []
example:
- order02
trip_status:
description: "Current [trip status](#section/Description/Trip-status-model):\n\
\ * `FREE` - the trip has no assigned crew, initial status, awaiting assignment\
\ by the operator\n * `ASSIGNED` - the trip has a crew assigned, awaiting\
\ dispatch to the crew by the operator\n * `SENT` - the trip has been sent\
\ to the crew, awaiting confirmation of receipt by the crew\n * `RECEIVED`\
\ - the trip has been received by the crew, awaiting acceptance by the crew\n\
\ * `CONFIRMED` - the trip has been accepted by the crew, awaiting work from\
\ the crew\n * `REJECTED` - the trip has been rejected by the crew, awaiting\
\ assignment by the operator\n * `EXECUTING` - the trip is in progress, awaiting\
\ completion by the crew\n * `FINISHED` - the trip has been completed, final\
\ status\n * `CANCELED` - the trip has been canceled, final status\n"
type: string
enum:
- FREE
- ASSIGNED
- SENT
- RECEIVED
- CONFIRMED
- REJECTED
- EXECUTING
- FINISHED
- CANCELED
default: FREE
example: FINISHED
trip:
description: '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](#section/Description/Trip-model)
of the performer.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/trip_key'
performer:
$ref: '#/components/schemas/assigned_performer'
transport:
$ref: '#/components/schemas/assigned_transport'
states:
$ref: '#/components/schemas/trip_state_list'
waitlist:
$ref: '#/components/schemas/trip_waitlist'
name:
$ref: '#/components/schemas/name'
status:
$ref: '#/components/schemas/trip_status'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- performer
- transport
- states
measurements:
description: 'Measurements of times and distances for work on location, individual
trips and planning in general.
'
type: object
additionalProperties: false
properties:
time_window:
$ref: '#/components/schemas/time_window'
driving_time:
$ref: '#/components/schemas/time_duration'
waiting_time:
$ref: '#/components/schemas/time_duration'
working_time:
$ref: '#/components/schemas/time_duration'
break_time:
$ref: '#/components/schemas/time_duration'
rest_time:
$ref: '#/components/schemas/time_duration'
arriving_time:
$ref: '#/components/schemas/time_duration'
departure_time:
$ref: '#/components/schemas/time_duration'
total_time:
$ref: '#/components/schemas/time_duration'
distance:
description: Distance in meters.
type: integer
format: int32
minimum: 0
maximum: 4000000000
example: 5200
required:
- time_window
- driving_time
- waiting_time
- working_time
- break_time
- rest_time
- arriving_time
- departure_time
- total_time
- distance
capacity_statistics_sum:
description: Statistics on capacity characteristics.
type: object
additionalProperties: false
properties:
mass:
description: Total weight in kilograms.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 105500
volume:
description: Total volume in cubic meters.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 220034
capacity_a:
description: Amount for additional parameter (A) for measuring loads in
alternative units of measurement.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 100000
capacity_b:
description: Amount for additional parameter (B) for measuring loads in
alternative units of measurement.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 200000
capacity_c:
description: Amount for additional parameter (C) for measuring loads in
alternative units of measurement.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 300000
required:
- mass
- volume
- capacity_a
- capacity_b
- capacity_c
capacity_statistics_ratio:
description: Statistics on capacity characteristics (ratio). It may be more
than one.
type: object
additionalProperties: false
properties:
mass:
description: Loading by mass, in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1000
example: 5.5
volume:
description: Loading by volume, in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1000
example: 4.1
capacity_a:
description: Loading by additional parameter (A), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1000
example: 3.7
capacity_b:
description: Loading by additional parameter (B), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1000
example: 2.8
capacity_c:
description: Loading by additional parameter (C), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1000
example: 2.9
required:
- mass
- volume
- capacity_a
- capacity_b
- capacity_c
capacity_statistics_load:
description: Statistics on capacity characteristics (ratio). Cannot be greater
than one.
type: object
additionalProperties: false
properties:
mass:
description: Loading by mass, in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1
example: 0.5
volume:
description: Loading by volume, in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1
example: 0.1
capacity_a:
description: Loading by additional parameter (A), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1
example: 0.7
capacity_b:
description: Loading by additional parameter (B), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1
example: 0.8
capacity_c:
description: Loading by additional parameter (C), in fractions of a unit.
type: number
format: double
minimum: 0
maximum: 1
example: 0.9
required:
- mass
- volume
- capacity_a
- capacity_b
- capacity_c
general_statistics:
description: Summary statistics for one or a set of trips.
type: object
additionalProperties: false
properties:
cost:
description: 'Total cost calculated based on the performer''s and transport
tariffs.
'
type: number
format: double
minimum: 0
maximum: 1000000000000
example: 1231.1
reward:
description: The total reward for orders fulfillment.
type: number
format: double
minimum: 0
maximum: 1000000000000
example: 2343.3
profit:
description: 'The total profit is equal to the difference between the total
reward (`reward`) and cost (`cost`).
'
type: number
format: double
minimum: -1000000000000
maximum: 1000000000000
example: 1231.1
measurements:
$ref: '#/components/schemas/measurements'
description: "Measurements of times and distances for aggregate and individual\
\ trips:\n\n * `time_window` - the start time of the first trip and the\
\ end time of the last, if there are no trips, the time of the left border\
\ of the planning horizon is returned, while the from \\ to fields have\
\ the same value\n * `driving_time` - duration of driving time\n * `waiting_time`\
\ - total waiting time for all locations\n * `working_time` - total time\
\ of work execution at all locations included in the trip\n * `break_time`\
\ - total break time for all locations\n * `rest_time` - total rest time\
\ for all locations\n * `arriving_time` - total time to drive / park\
\ at locations\n * `departure_time` - total time for departure from locations\n\
\ * `total_time` - total time, composed of `driving_time` + `waiting_time`\
\ + `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`\n\
\ * `distance` - the total length of the roundtrip/trip/set of trips,\
\ in meters\n"
trips_count:
description: The total number of planned trips.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 250
performers_count:
description: The total number of performers involved in orders fulfillment.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 157
orders_count:
description: The total number of planned and assigned orders.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1700
plan_orders_count:
description: The total number of planned orders.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1003
waitlist_orders_count:
description: The total number of assigned orders.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 697
stops_count:
description: The total number of stops (non-unique locations).
type: integer
format: int32
minimum: 0
maximum: 15001000
example: 87
locations_count:
description: 'The total number of unique locations within one trip. For
general statistics - the sum of unique locations within each trip.
'
type: integer
format: int32
minimum: 0
maximum: 15001000
example: 45
cargo_capacity_sum:
$ref: '#/components/schemas/capacity_statistics_sum'
description: Total additive measures of the transported cargo.
cargo_capacity_ratio:
$ref: '#/components/schemas/capacity_statistics_ratio'
description: 'The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes. In fractions of a unit. It may
be more than one.
'
max_transport_load:
$ref: '#/components/schemas/capacity_statistics_load'
description: 'The ratio of the maximum load of boxes to the total capacity
of boxes. In fractions of a unit. Cannot be greater than one.
'
average_speed:
description: Average speed is the ratio of the total distance to the total
time of movement, km/h.
type: number
format: double
minimum: 0
maximum: 1000000000000
example: 43.1
round_trips_count:
description: Number of [roundtrips](#section/Description/Roundtrips) within
a trip.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 2
average_roundtrip_distance:
description: Average mileage per roundtrip is the ratio of the total mileage
per trip to the number of roundtrips, in meters.
type: number
format: double
minimum: 0
maximum: 1000000000000
example: 23.4
average_roundtrip_time:
$ref: '#/components/schemas/time_duration'
description: Average roundtrip time is the ratio of the total time to the
number of roundtrips.
attributes:
$ref: '#/components/schemas/attributes'
required:
- cost
- reward
- profit
- measurements
- trips_count
- performers_count
- orders_count
- plan_orders_count
- waitlist_orders_count
- stops_count
- locations_count
- cargo_capacity_sum
- cargo_capacity_ratio
- max_transport_load
- average_speed
- round_trips_count
- average_roundtrip_distance
- average_roundtrip_time
transport_load:
description: Total transport load.
type: object
additionalProperties: false
properties:
count:
description: Number of cargos.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1460
capacity:
$ref: '#/components/schemas/capacity_statistics_sum'
required:
- count
- capacity
load_statistics:
description: 'Statistics for a transport load.
'
type: object
additionalProperties: false
properties:
total_load:
$ref: '#/components/schemas/transport_load'
description: Total transport load for the entire trip time.
max_load:
$ref: '#/components/schemas/transport_load'
description: Maximum transport load during the entire trip (for each dimension).
max_transfer_load:
$ref: '#/components/schemas/transport_load'
description: Maximum transport load over the entire trip duration while
in motion (for each dimension).
required:
- total_load
- max_load
- max_transfer_load
stop_demand:
description: An demand made for a specific stop.
type: object
additionalProperties: false
properties:
demand_key:
description: Demand key.
type: string
minLength: 1
maxLength: 1024
example: demand_key_01
event_key:
description: Event key.
type: string
minLength: 1
maxLength: 1024
example: event_key_01
demand_time_window:
$ref: '#/components/schemas/time_window'
description: Time window for completing the demand.
required:
- demand_key
- event_key
- demand_time_window
stop_statistics:
description: 'Statistics for a specific stop during a trip.
'
type: object
additionalProperties: false
properties:
location_key:
description: Location key for stop.
type: string
minLength: 1
maxLength: 1024
example: location_01
stop_demands:
description: List of orders completed at this stop.
type: array
minItems: 0
maxItems: 15001
uniqueItems: false
items:
$ref: '#/components/schemas/stop_demand'
stop_time_window:
$ref: '#/components/schemas/time_window'
description: 'Stop time window - from the beginning of the parking lot to
the complete departure from the location. The window duration is `waiting_time`
+ `working_time` + `break_time` + `rest_time` + `arriving_time` + `departure_time`.
'
measurements:
$ref: '#/components/schemas/measurements'
description: "Measurements of times and distances for work on location:\n\
\n * `time_window` - the time window from the start of movement to the\
\ stop until the end of the departure from the stop\n * `driving_time`\
\ - driving time from the previous stop to the current location\n * `waiting_time`\
\ - the duration of waiting for the execution of work at the location\n\
\ * `working_time` - the time spent on the direct execution of work at\
\ the location\n * `break_time` - duration of the performer's break\n\
\ * `rest_time` - duration of rest for the performer\n * `arriving_time`\
\ - the time spent on the entrance/parking at the location\n * `departure_time`\
\ - the time taken to leave the location\n * `total_time` - total time\
\ for a stop, composed of `driving_time` + `waiting_time` + `working_time`\
\ + `break_time` + `rest_time` + `arriving_time` + `departure_time`\n\
\ * `distance` - the distance from the previous stop to the current location\n"
upload:
$ref: '#/components/schemas/transport_load'
description: Loading to the transport at this stop.
download:
$ref: '#/components/schemas/transport_load'
description: Unloading from the transport at this stop.
max_load:
$ref: '#/components/schemas/transport_load'
description: Maximum load of the transport in the process of loading/unloading
at a stop.
arrival_load:
$ref: '#/components/schemas/transport_load'
description: Transport loading at the time of arrival at this stop.
departure_load:
$ref: '#/components/schemas/transport_load'
description: Transport loading at the moment of departure from this stop.
attributes:
$ref: '#/components/schemas/attributes'
required:
- location_key
- stop_demands
- stop_time_window
- measurements
- upload
- download
- max_load
- arrival_load
- departure_load
stop_statistics_list:
description: Statistics per stop during the trip.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/stop_statistics'
default: []
roundtrip_statistics:
description: 'Statistics for roundtrip.
'
type: object
additionalProperties: false
properties:
roundtrip_key:
description: Roundtrip key.
type: string
minLength: 1
maxLength: 1024
example: trip01_round02
general_statistics:
$ref: '#/components/schemas/general_statistics'
description: General statistics for roundtrip.
required:
- roundtrip_key
- general_statistics
roundtrip_statistics_list:
description: Statistics per roundtrip during the trip.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/roundtrip_statistics'
default: []
trip_statistics:
description: 'Statistics for a specific trip.
'
type: object
additionalProperties: false
properties:
trip_key:
$ref: '#/components/schemas/trip_key'
general_statistics:
$ref: '#/components/schemas/general_statistics'
description: General statistics for trip.
load_statistics:
$ref: '#/components/schemas/load_statistics'
stop_statistics:
$ref: '#/components/schemas/stop_statistics_list'
roundtrip_statistics:
$ref: '#/components/schemas/roundtrip_statistics_list'
attributes:
$ref: '#/components/schemas/attributes'
required:
- trip_key
- general_statistics
- load_statistics
- stop_statistics
- roundtrip_statistics
deal_trip:
description: Deal Trip.
type: object
additionalProperties: false
properties:
deal:
$ref: '#/components/schemas/deal'
trip:
description: Trip.
oneOf:
- $ref: '#/components/schemas/trip'
- $ref: '#/components/schemas/nullable'
default: null
trip_statistics:
description: Statistics.
oneOf:
- $ref: '#/components/schemas/trip_statistics'
- $ref: '#/components/schemas/nullable'
default: null
required:
- deal
deal_trip_list:
description: Trip list.
type: array
uniqueItems: false
minItems: 0
maxItems: 30
items:
$ref: '#/components/schemas/deal_trip'
geopoint:
description: Geographical point.
type: object
additionalProperties: false
properties:
latitude:
description: Latitude in degrees.
type: number
format: double
minimum: -90
maximum: 90
example: 55.692789
longitude:
description: Longitude in degrees.
type: number
format: double
minimum: -180
maximum: 180
example: 37.554554
required:
- latitude
- longitude
capacity_limit:
description: Capacity limits.
type: object
additionalProperties: false
properties:
mass:
description: Weight in kilograms.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 10
volume:
description: Volume in cubic meters.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 2
capacity_a:
description: Additional parameter (A) for measuring cargoes and boxes in
alternative units.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 1
capacity_b:
description: Additional parameter (B) for measuring cargoes and boxes in
alternative units.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 2
capacity_c:
description: Additional parameter (C) for measuring cargoes and boxes in
alternative units.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 3
required:
- mass
- volume
- capacity_a
- capacity_b
- capacity_c
capacity_cost:
description: Cost per capacity element.
type: object
additionalProperties: false
properties:
mass:
description: Cost per kilogram, in conventional monetary units.
type: number
format: double
minimum: 0
maximum: 1000000
example: 11
volume:
description: Cost per cubic meter, in conventional monetary units.
type: number
format: double
minimum: 0
maximum: 1000000
example: 22
capacity_a:
description: Cost per unit of additional parameter (A), in conventional
monetary units.
type: number
format: double
minimum: 0
maximum: 1000000
example: 11
capacity_b:
description: Cost per unit of additional parameter (B), in conventional
monetary units.
type: number
format: double
minimum: 0
maximum: 1000000
example: 22
capacity_c:
description: Cost per unit of additional parameter (C), in conventional
monetary units.
type: number
format: double
minimum: 0
maximum: 1000000
example: 31
required:
- mass
- volume
- capacity_a
- capacity_b
- capacity_c
location_cargos_limit:
description: 'Limiting the location''s ability to handle cargo.
'
type: object
additionalProperties: false
properties:
capacity:
$ref: '#/components/schemas/capacity_limit'
description: Capacity value.
penalty:
$ref: '#/components/schemas/capacity_cost'
description: Penalty for violating the `capacity`.
required:
- capacity
- penalty
location_cargos_limit_function:
description: 'A function that describes the limitation of a location''s ability
to handle cargo and penalties for violating the restrictions. Penalties are
cumulative independently for each qualifying part of the function.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 5
items:
$ref: '#/components/schemas/location_cargos_limit'
default: []
location_transports_limit:
description: 'Limiting the location''s ability to serve transport.
'
type: object
additionalProperties: false
properties:
count:
description: The number of transport serviced on average during a specified
time window.
type: number
format: double
minimum: 0
maximum: 15001
example: 2
penalty:
description: Penalty for violating the `count`.
type: number
format: double
minimum: 0
maximum: 1000000
example: 2000
required:
- count
- penalty
location_transports_limit_function:
description: 'A function that describes the limitation of a location’s ability
to serve transport and penalties for violating the restrictions. Penalties
are cumulative independently for each qualifying part of the function.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 5
items:
$ref: '#/components/schemas/location_transports_limit'
default: []
location_limit:
description: 'Limitation on the capacity of a location during a certain time
period.
'
type: object
additionalProperties: false
properties:
key:
description: Constraint key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_limit_constraint_01
time_window:
$ref: '#/components/schemas/time_window'
description: Time window for the restriction.
min_cargos:
$ref: '#/components/schemas/location_cargos_limit_function'
description: 'The minimum throughput of cargo movement that must be ensured.
Failure to comply with this parameter will result in a fine.
'
max_cargos:
$ref: '#/components/schemas/location_cargos_limit_function'
description: 'Maximum throughput of cargo movement. Exceeding the parameter
is penalized.
'
min_transports:
$ref: '#/components/schemas/location_transports_limit_function'
description: 'The minimum acceptable number of transports serviced on average
during a specified time window. Failure to comply with this parameter
will result in a fine.
'
max_transports:
$ref: '#/components/schemas/location_transports_limit_function'
description: 'The maximum acceptable number of transports serviced on average
during a specified time window. Exceeding the parameter is penalized.
'
required:
- key
- time_window
location_limit_list:
description: 'List of bandwidth restrictions inside the working window of the
location. Constraint time windows cannot overlap and must total `work_window`.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 48
items:
$ref: '#/components/schemas/location_limit'
default: []
location_timetable_element:
description: 'Location - unique geographical location of the object with accessibility
parameters.
'
type: object
additionalProperties: false
properties:
work_window:
$ref: '#/components/schemas/time_window'
description: Time window for location availability.
limits:
$ref: '#/components/schemas/location_limit_list'
required:
- work_window
location_timetable:
description: 'Location timetable - time windows of availability and capacity
restrictions. If the list is empty or not specified, the location works without
restrictions.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 30
items:
$ref: '#/components/schemas/location_timetable_element'
default: []
location_compatibilities:
description: Compatibilities of [the location with transport](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
transport_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'List of transport requirements. Used to check whether the
transport is compatible with the location.
'
location:
description: 'Location - unique geographical location of the object with accessibility
parameters.
'
type: object
additionalProperties: false
properties:
key:
description: Location key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_01
geopoint:
$ref: '#/components/schemas/geopoint'
arrival_duration:
$ref: '#/components/schemas/time_duration'
description: Time for driving up to the location (or waiting time at parking
lot) according to `P1DT2H12M34.2S`.
departure_duration:
$ref: '#/components/schemas/time_duration'
description: Time to leave the location according to `P1DT2H12M34.2S`.
timetable:
$ref: '#/components/schemas/location_timetable'
compatibilities:
description: Compatibilities of [the location with transport](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/location_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
name:
$ref: '#/components/schemas/name'
address:
description: Full location address.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: 24th Line V.O., 15/2, building A, St. Petersburg, 199106
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- geopoint
location_list_required:
description: List of locations used for orders and shifts.
type: array
uniqueItems: true
minItems: 1
maxItems: 15001
items:
$ref: '#/components/schemas/location'
order_key:
description: Order key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: order01
demand_key:
description: Demand key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: order01-demand2
demand_type:
description: "Demand types:\n * `PICKUP` - loading\n * `DROP` - unloading\n\
\ * `WORK` - work at the location\n * `PICKUP_TO_BOX` - loading to box\n\
\ * `DROP_FROM_BOX` - unloading from box\n"
type: string
enum:
- PICKUP
- DROP
- WORK
- PICKUP_TO_BOX
- DROP_FROM_BOX
example: WORK
cargo_keys_list:
description: "The list of cargo keys depends on the type of order in which the\
\ cargoes are located:\n * `PICKUP` - list of keys\n * `DROP` - one key\n\
\ * `WORK` - empty list\n * `PICKUP_TO_BOX` - one key\n * `DROP_FROM_BOX`\
\ - one key\n"
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/cargo_key'
example:
- cargo01
possible_event_key:
description: Event key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: order01-demand2-event1
possible_event_contact:
description: Contact details of the final recipient of the goods or services.
type: object
additionalProperties: false
properties:
recipient_name:
description: Full name of the final recipient of the goods or services.
type: string
minLength: 2
maxLength: 1024
example: Иван Петрович Федоров
recipient_phone:
description: Phone number of the final recipient of the goods or services.
type: string
pattern: ^[+]{1}(?:[0-9\-$$\/\.]\s?){6,15}[0-9]{1}$
minLength: 5
maxLength: 32
example: '+71112223333'
recipient_organization:
description: Name of the organization receiving the cargo or service.
type:
- string
- 'null'
minLength: 2
maxLength: 1024
default: null
example: ЗАО Склад
comment:
description: Free-form commentary on contact information.
type:
- string
- 'null'
minLength: 1
maxLength: 3000
default: null
example: Осторожно злая собака
required:
- recipient_name
- recipient_phone
possible_event:
description: 'Possible event. Combines the geographical location and the time
window, when a demand can be completed.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/possible_event_key'
location_key:
description: Location key, where this event is possible.
type: string
minLength: 1
maxLength: 1024
example: location_01
duration:
$ref: '#/components/schemas/time_duration'
description: Event duration time according to `P1DT2H12M34.2S`.
default: PT0S
reward:
description: Reward for completing this event.
type: number
format: double
minimum: 0
maximum: 2000000000
default: 1000.1
example: 199.9
hard_time_window:
$ref: '#/components/schemas/time_window'
description: 'A hard time window within which an event must occur. The window
duration cannot be less than the `duration` of the event. Cannot be violated
during planning.
'
soft_time_window:
description: 'A soft time window within which an event is desired to occur.
The window duration cannot be less than the `duration` of the event. Must
not exceed the `hard_time_window`. If not specified or equal to `null`,
it is assumed to be equal to the hard time window. May be disrupted during
planning.
'
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
attributes:
$ref: '#/components/schemas/attributes'
contact:
description: Contact details of the final recipient of the goods or services.
oneOf:
- $ref: '#/components/schemas/possible_event_contact'
- $ref: '#/components/schemas/nullable'
default: null
required:
- key
- location_key
- hard_time_window
demand:
description: Request for a single action with a cargo (pickup / drop) or work
at a location.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/demand_key'
demand_type:
$ref: '#/components/schemas/demand_type'
target_cargos:
$ref: '#/components/schemas/cargo_keys_list'
precedence_in_trip:
description: Precedence within a trip, 0 - the precedence is not taken into
account.
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
precedence_in_order:
description: Precedence within an order, 0 - the precedence is not taken
into account.
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
possible_events:
description: List of possible time windows and location keys to fulfil an
order.
type: array
uniqueItems: true
minItems: 1
maxItems: 25
items:
$ref: '#/components/schemas/possible_event'
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- demand_type
- possible_events
cargo_rotation_type:
description: "The ability of the cargo to rotate in 90 degree increments around\
\ the axes:\n * `ALL` - any axes.\n * `YAW` - around the Z axis.\n * `PITCH`\
\ - around the Y axis.\n * `ROLL` - around the X axis.\n"
type: string
enum:
- ALL
- YAW
- PITCH
- ROLL
default: ALL
examples:
- ALL
cargo_rotation:
description: "List of possibilities of a object rotations (90 degree step):\n\
\ * `ALL` - can rotate by any axis\n * `YAW` - can yaw\n * `PITCH` - can\
\ pitch\n * `ROLL` - can roll\n\nEmpty list means object rotations is prohibited.\
\ More about [cargo placement](#section/Description/Cargo-placement).\n"
type: array
uniqueItems: true
minItems: 0
maxItems: 4
items:
$ref: '#/components/schemas/cargo_rotation_type'
default: []
cargo_compatibilities:
description: Compatibilities of [the cargo with the transport box and other
cargos](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
width:
description: Width in meters, used to check the transport box capacity.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
height:
description: Height in meters, used to check the transport box capacity.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.3
length:
description: Length in meters, used to check the transport box capacity.
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2.2
rotation:
$ref: '#/components/schemas/cargo_rotation'
box_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'A list of necessary restrictions for the transport box in
which this cargo can be transported.
'
cargo_features:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Cargo''s features list. Used to check whether the cargo is
compatible with other cargos. Incompatible cargo cannot be located simultaneously
in the same box of the transport.
'
cargo_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Restrictions list for the cargo. Used to check whether the
cargo is compatible with other cargos. Incompatible cargo cannot be located
simultaneously in the same box of the transport.
'
cargo_invoice_product_key:
description: The key of the product or service associated with the cargo, a
unique identifier.
type: string
minLength: 1
maxLength: 1024
example: product-a1
cargo_invoice_tax:
description: Value-added tax (VAT).
type: string
enum:
- VAT_NA
- VAT_00
- VAT_05
- VAT_07
- VAT_10
- VAT_20
- VAT_22
- VAT_05_105
- VAT_07_107
- VAT_10_110
- VAT_20_120
- VAT_22_122
example: VAT_NA
cargo_invoice_honest_sign:
description: Information about the `Honest Sign` marking.
type: object
additionalProperties: false
properties:
label:
description: The label of the `Honest Sign` marking.
type:
- string
- 'null'
minLength: 1
maxLength: 1000
default: null
example: xdd11
marking_required:
description: The product requires the `Honest Sign` marking.
type: boolean
default: false
example: true
cargo_invoice_detail:
description: Invoice details for the product.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/cargo_invoice_product_key'
full_name:
description: Product name.
type: string
minLength: 1
maxLength: 1000
example: Industrial unmanaged switch AKF U-5T 5 ports 10/100Base-T(X) RJ45
unit_name:
description: Product unit name.
type:
- string
- 'null'
minLength: 1
maxLength: 1000
default: null
example: Mango
unit_price:
description: Product unit price.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 500
unit_quantity:
description: Product quantity.
type: number
format: double
minimum: 0.01
maximum: 1000000000
example: 2
external_id:
description: External product identifier.
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: mangoN3
external_url:
description: Link to product description.
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: https://product.link/mangoN3
tax:
$ref: '#/components/schemas/cargo_invoice_tax'
honest_sign:
$ref: '#/components/schemas/cargo_invoice_honest_sign'
scan_code:
description: Barcode or QR-code.
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: xdd1
age_restriction:
description: Age restrictions apply (18+).
type: boolean
default: false
example: true
payment_subject_type:
description: The item being paid. For example, Product or Service.
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: Product
required:
- key
- full_name
- unit_price
- unit_quantity
- tax
- honest_sign
user_email:
description: User e-mail address.
type:
- string
- 'null'
format: email
pattern: ^[A-Za-z0-9+_.-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$
default: null
minLength: 5
maxLength: 256
example: admin@company.com
cargo_invoice_receipt:
description: Information for printing a receipt.
type: object
additionalProperties: false
properties:
email:
$ref: '#/components/schemas/user_email'
phone:
$ref: '#/components/schemas/user_phone'
payment_document:
description: The document used for payment.
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: N1234567
payment_external_id:
description: 'External payment id. Filled out if fiscalization occurs on
the seller''s side.
'
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: X777h333
cargo_invoice_waybill_status:
description: "Current status of the Electronic Waybill - the last completed\
\ title of the waybill:\n * `T1` - ready for shipment\n * `T2` - accepted\
\ for transportation by the performer and is in the transport\n * `T3` -\
\ the client is ready to unload the goods\n * `T4` - unloaded from the transport\
\ and handed over to the client\n * `T5` - the performer has specified the\
\ cost of transportation\n * `T6` - the shipper has confirmed the cost of\
\ transportation, the transportation is completed\n * `T7` - a redirection\
\ has been issued - the delivery address or the consignee has been changed\n\
\ * `T8` - a replacement of the driver and (or) the transport has been issued\n"
type: string
enum:
- T1
- T2
- T3
- T4
- T5
- T6
- T7
- T8
example: T2
store_key_null:
description: 'The key for the binary file uploaded to the repository. The rule
for generating the key is: `company_name/account_name/YYYY/MM/DD/UID.extension`.
May be `null`.
'
type:
- string
- 'null'
minLength: 50
maxLength: 1024
default: null
example: company/client/2027/11/27/11111111-2222-3333-4444-555555555555.jpg
cargo_invoice_waybill:
description: Electronic Waybill.
type: object
additionalProperties: false
properties:
status:
$ref: '#/components/schemas/cargo_invoice_waybill_status'
transportation_qr_key:
$ref: '#/components/schemas/store_key_null'
description: 'The key for the QR-code file uploaded to the data storage
via the Store service. The file must be in PDF format.
'
transportation_file_key:
$ref: '#/components/schemas/store_key_null'
description: 'The key for the shipping file uploaded to the data storage
via the Store service. The file must be in PDF format.
'
required:
- status
cargo_invoice:
description: Cargo invoice.
type: object
additionalProperties: false
properties:
invoice_details:
description: Product data.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
default: []
items:
$ref: '#/components/schemas/cargo_invoice_detail'
payable:
description: "Flag indicating whether payment is required:\n * `true` -\
\ payment required\n * `false` - payment not required\n"
type: boolean
example: true
prepayment:
description: Prepayment amount.
type: number
format: double
minimum: 0
maximum: 1000000000
default: 0
example: 1000
receipt:
description: Information for printing a receipt.
oneOf:
- $ref: '#/components/schemas/cargo_invoice_receipt'
- $ref: '#/components/schemas/nullable'
default: null
waybill:
description: Electronic Waybill.
oneOf:
- $ref: '#/components/schemas/cargo_invoice_waybill'
- $ref: '#/components/schemas/nullable'
default: null
required:
- invoice_details
- payable
cargo:
description: 'Cargo. Regardless of capacity, cargo can only move inside the
transport box.
'
type: object
additionalProperties: false
properties:
key:
description: Cargo key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: cargo01
capacity:
description: Cargo additive measures.
oneOf:
- $ref: '#/components/schemas/capacity'
- $ref: '#/components/schemas/nullable'
default: null
compatibilities:
description: Compatibilities of [the cargo with the transport box and other
cargos](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/cargo_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
target_box_key:
description: 'The key of the transport box in which the cargo is already
located. Applicable only for cargo that is in the order with the type
`DROP_FROM_BOX`. For other order types, the key must be empty.
'
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: box01
invoice:
description: Cargo invoice.
oneOf:
- $ref: '#/components/schemas/cargo_invoice'
- $ref: '#/components/schemas/nullable'
default: null
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
cargo_list:
description: 'The list of cargoes referred to by the demands of this order.
The list must be empty if all demands in the order are of type `WORK`.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/cargo'
default: []
order_compatibilities:
description: Compatibilities of [the order with performers and other orders](#section/Description/Compatibilities).
type: object
additionalProperties: false
properties:
order_features:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'Order features list. Used to check the compatibility of an
order with other orders. Incompatible orders cannot be planned on the
same trip.
'
order_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'List of restrictions for an order carried out on the same
trip. Used to check the compatibility of an order with other orders. Incompatible
orders cannot be planned on the same trip.
'
performer_restrictions:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'A list of necessary requirements for the performer who can
fulfill this order.
'
performer_blacklist:
$ref: '#/components/schemas/compatibility_tag_list'
description: 'A list of requirements that the performer is not allowed to
have. This list should not intersect with `performer_restrictions`.
'
order_status:
description: "Current order status:\n * `FREE` - the order is not assigned\
\ to any trip, initial status, awaiting assignment\n * `PLANNED` - the order\
\ is planned to a trip, awaiting the start of execution\n * `EXECUTING` -\
\ the order is in progress, awaiting completion\n * `FINISHED` - the order\
\ has been completed, all demands are done, final status\n * `CANCELED` -\
\ the order has been canceled, final status\n"
type: string
enum:
- FREE
- PLANNED
- EXECUTING
- FINISHED
- CANCELED
default: FREE
example: FINISHED
order:
description: The order for delivery/transportation, contains a list of demands.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/order_key'
demands:
description: Demands list.
type: array
uniqueItems: true
minItems: 1
maxItems: 1000
items:
$ref: '#/components/schemas/demand'
cargos:
$ref: '#/components/schemas/cargo_list'
compatibilities:
description: Compatibilities of [the order with performers and other orders](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/order_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
status:
$ref: '#/components/schemas/order_status'
required:
- key
- demands
order_list_required:
description: List of orders that need to be completed.
type: array
uniqueItems: true
minItems: 1
maxItems: 15001
items:
$ref: '#/components/schemas/order'
mobile_trip_data:
description: Mobile trip data.
type: object
additionalProperties: false
properties:
locations:
$ref: '#/components/schemas/location_list_required'
description: Locations from the facts of this trip and from the trip itself.
orders:
$ref: '#/components/schemas/order_list_required'
description: Completed orders from the facts of this trip and planned orders
from the trip itself.
required:
- locations
- orders
fact_type:
description: "Possible fact types:\n * `GEOTRACK_UPDATED` - the performer changed\
\ his location during the trip\n * `ORDER_DONE` - the performer has finished\
\ fulfilling the order, the cargo associated with the order is no longer in\
\ the transport box\n * `ORDER_CANCELED` - the order has been canceled, the\
\ cargo associated with the order is no longer in the transport box\n * `DEMAND_START`\
\ - performer started to fulfill the demand\n * `DEMAND_DONE` - performer\
\ finished to fulfill the demand\n * `DEMAND_CANCELED` - the performer canceled\
\ the demand\n * `DEMAND_PAYMENT` - the performer received payment for the\
\ demand\n * `TRIP_PRECEDENCE_CHANGED` - the performer changed the precedence\
\ of the demands in the trip\n * `TRIP_RECEIVED` - the performer has received\
\ the trip\n * `TRIP_CONFIRMED` - the performer has agreed to perform the\
\ trip\n * `TRIP_REJECTED` - the performer has refused to perform the trip\n\
\ * `TRIP_EXECUTING` - the performer has started performing the trip\n *\
\ `TRIP_DONE` - the performer has completed the trip, all orders in the trip\
\ are fulfilled\n * `JOB_DONE` - the performer has finished custom job\n"
type: string
enum:
- GEOTRACK_UPDATED
- ORDER_DONE
- ORDER_CANCELED
- DEMAND_START
- DEMAND_DONE
- DEMAND_CANCELED
- DEMAND_PAYMENT
- TRIP_PRECEDENCE_CHANGED
- TRIP_RECEIVED
- TRIP_CONFIRMED
- TRIP_REJECTED
- TRIP_EXECUTING
- TRIP_DONE
- JOB_DONE
example: GEOTRACK_UPDATED
fact_status:
description: "Current fact status:\n * `NEW` - the fact has been created and\
\ is awaiting system processing\n * `APPLIED` - the fact has been processed\
\ by the system and applied to the data\n * `ERROR` - an error occurred while\
\ processing the fact; the sender must correct the fact and resubmit\n"
type: string
enum:
- NEW
- APPLIED
- ERROR
default: NEW
example: APPLIED
fact_status_error:
description: "Typed fact processing error (set when status is `ERROR`):\n *\
\ `DUPLICATE` - the fact is a duplicate of a previously processed fact\n \
\ * `INCONSISTENT_REFERENCE` - the fact references a non-existent or inconsistent\
\ entity\n * `INCONSISTENT_STATUS` - the fact cannot be applied to the current\
\ status of the entity\n * `INCONSISTENT_TIME` - fact creation time is later\
\ than `current_time` + `fact_processing_threshold`\n"
type: string
enum:
- DUPLICATE
- INCONSISTENT_REFERENCE
- INCONSISTENT_STATUS
- INCONSISTENT_TIME
example: DUPLICATE
geotrack:
description: An array of geographic points with time reference between which
a path is built.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000000
items:
$ref: '#/components/schemas/trackpoint'
default: []
lore_geotrack_updated:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
performer_key:
description: Performer key.
type: string
minLength: 1
maxLength: 1024
example: performer_01
geotrack:
$ref: '#/components/schemas/geotrack'
required:
- performer_key
- geotrack
lore_order_done:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
required:
- order_key
lore_order_canceled:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
comment:
description: Reason for cancellation of order.
type: string
minLength: 1
maxLength: 3000
example: Передумали
required:
- order_key
- comment
lore_demand_start:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
required:
- order_key
- demand_key
product_conclusion_type:
description: "Result of delivering a product or rendering a service:\n * `DELIVERED`\
\ - the product is delivered / the service is rendered\n * `CANCELED` - the\
\ product is not delivered / the service is not rendered\n"
type: string
enum:
- DELIVERED
- CANCELED
example: DELIVERED
product_conclusion:
description: Result of processing a product or service within the demand.
type: object
additionalProperties: false
properties:
product_key:
$ref: '#/components/schemas/cargo_invoice_product_key'
unit_quantity:
description: Product quantity.
type: number
format: double
minimum: 0.01
maximum: 1000000000
example: 2
type:
$ref: '#/components/schemas/product_conclusion_type'
honest_sign_result:
description: Result of processing the `Honest Sign` marking.
type:
- string
- 'null'
minLength: 1
maxLength: 1000
default: null
example: xdd113result
reason:
description: 'Reason for delivery/cancellation of the product. Select from
a customizable list.
'
type:
- string
- 'null'
minLength: 1
maxLength: 3000
default: null
example: Не подошел цвет
comment:
description: Free-form comment on the delivery/cancellation of the product.
type:
- string
- 'null'
minLength: 1
maxLength: 3000
default: null
example: Количество штук не соответствует заказу
required:
- product_key
- unit_quantity
- type
product_conclusion_list:
description: 'List of results of processing products within the cargo.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/product_conclusion'
default: []
lore_demand_done:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
trackpoint:
$ref: '#/components/schemas/trackpoint'
description: Place of creation of the fact.
conclusions:
$ref: '#/components/schemas/product_conclusion_list'
required:
- order_key
- demand_key
- trackpoint
lore_demand_canceled:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
trackpoint:
$ref: '#/components/schemas/trackpoint'
description: Place of creation of the fact.
reason:
description: 'Reason for demand cancellation. Select from a customizable
list.
'
type: string
minLength: 1
maxLength: 3000
example: Получателя на было на месте
comment:
description: Free-form commentary on the cancellation of the demand.
type:
- string
- 'null'
minLength: 1
maxLength: 3000
default: null
example: Количество штук не соответствует заказу
required:
- order_key
- demand_key
- trackpoint
- reason
payment_details:
description: Payment details.
type: object
additionalProperties: false
properties:
invoice:
$ref: '#/components/schemas/cargo_invoice'
description: 'Invoice of the paid goods and services. Contains line items,
prepayment amount, email/phone for sending the receipt.
'
receipt_amount:
description: Total amount of the payment.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 28020
receipt_qr:
description: Receipt QR-code.
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: https://qr.nspk.ru/3D5479A004F048B5A74C99CD232B346?type=02&bank=10000001&sum=10200&cur=RUB&crc=C08B
receipt_processing_number:
description: Receipt number in the payment processor.
type: string
minLength: 1
maxLength: 256
example: APG8R8FXKA3DDL
payment_type:
description: Payment type.
type: string
minLength: 1
maxLength: 256
example: CARD
payment_status:
description: 'Final payment status. The list of values depends on the payment
operator.
'
type: string
minLength: 1
maxLength: 256
example: SUCCESS
payment_status_detail:
description: A detailed description of the payment processing status, used
to clarify payment processing errors.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: detailed status description
payment_time:
description: Payment time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
payment_approval_code:
description: Payment (transaction) approval code.
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: '247805'
payment_external_id:
description: 'External payment identifier. Used to identify the payment
in the seller''s systems.
'
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: ext-8f9e9a85-4ef3-11f1-bf78-6cb31121d731
required:
- invoice
- receipt_amount
- receipt_processing_number
- payment_type
- payment_status
- payment_time
lore_demand_payment:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
payment_details:
$ref: '#/components/schemas/payment_details'
required:
- order_key
- demand_key
- payment_details
trip_demand_precedence:
description: New precedence of demand in the trip.
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
new_precedence_in_trip:
description: New precedence of demand in the trip.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
required:
- order_key
- demand_key
- new_precedence_in_trip
lore_trip_precedence_changed:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
demands_precedence:
description: New precedence of demands in the trip.
type: array
uniqueItems: false
minItems: 1
maxItems: 15001
items:
$ref: '#/components/schemas/trip_demand_precedence'
required:
- demands_precedence
lore_job_done:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
job_key:
$ref: '#/components/schemas/basic_essence_key'
required:
- job_key
fact_lore:
description: Additional data describing the fact.
type: object
additionalProperties: false
properties:
geotrack_updated:
description: Additional data describing the `GEOTRACK_UPDATED` fact.
oneOf:
- $ref: '#/components/schemas/lore_geotrack_updated'
- $ref: '#/components/schemas/nullable'
default: null
order_done:
description: Additional data describing the `ORDER_DONE` fact.
oneOf:
- $ref: '#/components/schemas/lore_order_done'
- $ref: '#/components/schemas/nullable'
default: null
order_canceled:
description: Additional data describing the `ORDER_CANCELED` fact.
oneOf:
- $ref: '#/components/schemas/lore_order_canceled'
- $ref: '#/components/schemas/nullable'
default: null
demand_start:
description: Additional data describing the `DEMAND_START` fact.
oneOf:
- $ref: '#/components/schemas/lore_demand_start'
- $ref: '#/components/schemas/nullable'
default: null
demand_done:
description: Additional data describing the `DEMAND_DONE` fact.
oneOf:
- $ref: '#/components/schemas/lore_demand_done'
- $ref: '#/components/schemas/nullable'
default: null
demand_canceled:
description: Additional data describing the `DEMAND_CANCELED` fact.
oneOf:
- $ref: '#/components/schemas/lore_demand_canceled'
- $ref: '#/components/schemas/nullable'
default: null
demand_payment:
description: Additional data describing the `DEMAND_PAYMENT` fact.
oneOf:
- $ref: '#/components/schemas/lore_demand_payment'
- $ref: '#/components/schemas/nullable'
default: null
demand_precedence:
description: Additional data describing the `TRIP_PRECEDENCE_CHANGED` fact.
oneOf:
- $ref: '#/components/schemas/lore_trip_precedence_changed'
- $ref: '#/components/schemas/nullable'
default: null
job_done:
description: Additional data describing the `JOB_DONE` fact.
oneOf:
- $ref: '#/components/schemas/lore_job_done'
- $ref: '#/components/schemas/nullable'
default: null
fact:
description: Fact is an action completed during the execution of a trip.
type: object
additionalProperties: false
properties:
key:
description: Fact key.
type: string
minLength: 1
maxLength: 1024
example: fact_01
type:
$ref: '#/components/schemas/fact_type'
creation_date:
description: Fact creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
reception_date:
description: Date and time of receipt of the fact by the server in the [ISO
8601](https://tools.ietf.org/html/rfc3339#section-5.6) format.
type:
- string
- 'null'
default: null
format: date-time
readOnly: true
example: '2026-09-21T09:33:00+03:00'
execution_date:
description: Date and time of execution the fact by the server in the [ISO
8601](https://tools.ietf.org/html/rfc3339#section-5.6) format.
type:
- string
- 'null'
default: null
format: date-time
readOnly: true
example: '2026-09-21T09:35:00+03:00'
status:
$ref: '#/components/schemas/fact_status'
status_error:
description: Typed fact processing error (set when status is `ERROR`).
oneOf:
- $ref: '#/components/schemas/fact_status_error'
- $ref: '#/components/schemas/nullable'
default: null
readOnly: true
status_detail:
description: Additional information about the fact status, used to clarify
fact processing errors.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: detailed status description
trip_key:
$ref: '#/components/schemas/trip_key'
lore:
description: "Additional data describing the fact. This field is required\
\ for the following fact types:\n * `GEOTRACK_UPDATED`\n * `ORDER_DONE`\n\
\ * `ORDER_CANCELED`\n * `DEMAND_START`\n * `DEMAND_DONE`\n * `DEMAND_CANCELED`\n\
\ * `DEMAND_PAYMENT`\n * `TRIP_PRECEDENCE_CHANGED`\n * `JOB_DONE`\n"
oneOf:
- $ref: '#/components/schemas/fact_lore'
- $ref: '#/components/schemas/nullable'
default: null
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- creation_date
- type
- status
- trip_key
mobile_fact:
description: Mobile fact.
type: object
additionalProperties: false
properties:
fact:
$ref: '#/components/schemas/fact'
required:
- fact
mobile_fact_list:
description: List of facts related to a specific trip.
type: array
uniqueItems: false
minItems: 0
maxItems: 15000
items:
$ref: '#/components/schemas/mobile_fact'
store_key:
description: 'The key for the binary file uploaded to the repository. The rule
for generating the key is: `company_name/account_name/YYYY/MM/DD/UID.extension`.
'
type: string
minLength: 50
maxLength: 1024
example: company/client/2027/11/27/11111111-2222-3333-4444-555555555555.jpg
file_binary:
description: File with data (octet-stream).
type: string
format: byte
file_comment:
description: File comment.
type:
- string
- 'null'
default: null
minLength: 0
maxLength: 10000
example: long long long long text
file_specification:
description: File specification.
type: object
additionalProperties: false
properties:
name:
$ref: '#/components/schemas/file_name'
comment:
$ref: '#/components/schemas/file_comment'
folder_key:
$ref: '#/components/schemas/unique_key'
description: The key of the folder of type `FOLDER` in which the file is
located.
required:
- name
- comment
- folder_key
plan_configuration:
description: 'Name of the planning configuration.
The configuration determines the result goal and quality.
[List of available](#section/Description/Planning-configuration) planning
configurations.'
type: string
minLength: 1
maxLength: 256
default: default
example: optimize_distance
trip_start_time_strategy:
description: "The strategy of the choosing optimal trip start time:\n * `EARLIEST_FINISH`\n\
\ * `LOWEST_COST`\n"
type: string
enum:
- EARLIEST_FINISH
- LOWEST_COST
default: EARLIEST_FINISH
example: LOWEST_COST
problem_kind:
description: 'Problem kind.
'
type:
- string
- 'null'
minLength: 1
maxLength: 256
default: null
example: LONG_HAUL
trip_expectations:
description: 'Expectations from the calculation result. Affect the trip-building
logic.
'
type: object
additionalProperties: false
properties:
trip_start_time_strategy:
$ref: '#/components/schemas/trip_start_time_strategy'
problem_kind:
$ref: '#/components/schemas/problem_kind'
attributes:
$ref: '#/components/schemas/attributes'
transport_speed_multiplier:
description: Speed change coefficient for the specified transport type.
type: object
additionalProperties: false
properties:
transport_type:
$ref: '#/components/schemas/transport_type'
speed:
description: Average transport speed multiplier.
type: number
format: double
minimum: 0.1
maximum: 100000
example: 2.5
required:
- transport_type
- speed
transport_speed_multiplier_list:
description: Transport speed change coefficients.
type: array
minItems: 0
maxItems: 16
default: []
uniqueItems: true
items:
$ref: '#/components/schemas/transport_speed_multiplier'
capacity_multiplier:
description: Capacity change rate for the specified transport type.
type: object
additionalProperties: false
properties:
mass:
description: Mass multiplier.
type: number
format: double
minimum: 0
maximum: 1000
default: 1
example: 2
volume:
description: Volume multiplier.
type: number
format: double
minimum: 0
maximum: 1000
default: 1
example: 2
capacity_a:
description: Additional parameter (A) multiplier.
type: number
format: double
minimum: 0
maximum: 1000
default: 1
example: 2
capacity_b:
description: Additional parameter (B) multiplier.
type: number
format: double
minimum: 0
maximum: 1000
default: 1
example: 2
capacity_c:
description: Additional parameter (C) multiplier.
type: number
format: double
minimum: 0
maximum: 1000
default: 1
example: 2
transport_capacity_multiplier:
description: Capacity change rate for the specified transport type.
type: object
additionalProperties: false
properties:
transport_type:
$ref: '#/components/schemas/transport_type'
capacity:
$ref: '#/components/schemas/capacity_multiplier'
required:
- transport_type
- capacity
transport_capacity_multiplier_list:
description: 'Transport capacity change coefficients. Change the `capacity`
parameters for all boxes and `max_capacity` for the transport.
'
type: array
minItems: 0
maxItems: 16
default: []
uniqueItems: true
items:
$ref: '#/components/schemas/transport_capacity_multiplier'
trip_assumptions:
description: 'Planning assumptions. Designed to adjust the logic of planning
via mass change of input data.
'
type: object
additionalProperties: false
properties:
transport_speed_multipliers:
$ref: '#/components/schemas/transport_speed_multiplier_list'
transport_capacity_multipliers:
$ref: '#/components/schemas/transport_capacity_multiplier_list'
disable_compatibility:
description: 'Disable the accounting for capacity. If `true` is specified,
all becomes compatible with everything.
'
type: boolean
default: false
example: true
disable_capacity:
description: 'Disable the accounting for capacity. If `true` is specified,
all transports can accommodate an unlimited cargo amount.
'
type: boolean
default: false
example: true
disable_location_limits:
description: 'Disable location bandwidth accounting. If `true` is specified,
`location.timetable.limits` and `trips_settings.penalties.max_locations_limits_penalty`
parameters are not taken into account.
'
type: boolean
default: true
example: false
same_order_time_window:
description: 'Use for calculation the same (specified) time window for orders
and demands. The time window is specified from the beginning of the earliest
window to the end of the latest window from all orders and demands.
'
type: boolean
default: false
example: true
expand_shift_time_window:
description: 'Expand the time window for performer and transport shifts. The
left border of the first shift extends to the left border of the specified
window, right border extends to the right border or to the beginning of
the next window for this entity. Each next shift moves the right border
to the next shift or to the right border of the specified window.
'
type: boolean
default: false
example: true
compatibility_penalty:
description: Penalty for violation of compatibility.
type: object
additionalProperties: false
properties:
tag:
$ref: '#/components/schemas/compatibility_tag'
penalty:
description: 'Penalty for violation of compatibility for the specified tag.
'
type: number
format: double
minimum: 0
maximum: 1000000
example: 2000
required:
- tag
- penalty
compatibility_penalty_list:
description: 'Penalties for violation of compatibility. When taking into account
transport-location compatibility violations, the penalty is applied for each
stop and cannot exceed the `max_penalty_cost` of the performer assigned to
the trip. Only the absence of a property is penalized; the time windows of
the life of a property cannot be violated for a fine.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 1000000
default: []
items:
$ref: '#/components/schemas/compatibility_penalty'
trip_penalties:
description: 'Planning penalties - ability to disrupt a part of the planning
business rules.
'
type: object
additionalProperties: false
properties:
compatibilities:
$ref: '#/components/schemas/compatibility_penalty_list'
max_locations_limits_penalty:
description: The maximum allowable amount of fines for violating location's
capacity limit.
type: number
format: double
minimum: 0
maximum: 1000000000
default: 0
example: 25000
trips_settings:
description: Trip creation settings.
type: object
additionalProperties: false
properties:
configuration:
$ref: '#/components/schemas/plan_configuration'
expectations:
$ref: '#/components/schemas/trip_expectations'
assumptions:
$ref: '#/components/schemas/trip_assumptions'
penalties:
$ref: '#/components/schemas/trip_penalties'
geo_provider:
description: "Geodata provider:\n * `VRT` - geo-data and traffic jams from\
\ Veeroute, work all over the world.\n\nA specific provider may be specified\
\ for a specific region, availability depending on customer settings.\n"
type: string
default: VRT
minLength: 3
maxLength: 256
example: VRT
geo_settings:
description: 'Geodata usage settings.
'
type: object
additionalProperties: false
properties:
geo_provider:
$ref: '#/components/schemas/geo_provider'
toll_roads:
description: Use toll roads.
type: boolean
default: true
example: false
ferry_crossing:
description: Use ferry crossing.
type: boolean
default: true
example: false
traffic_jams:
description: Accounting for traffic during the route planning.
type: boolean
default: true
example: false
flight_distance:
description: 'Use for calculating straight line distances. If `false` is
specified, distances are calculated by roads. When this parameter is enabled,
geo-provider not used and traffic (`traffic_jams`) is automatically disabled.
'
type: boolean
default: false
example: true
attributes:
$ref: '#/components/schemas/attributes'
timezone:
description: Timezone.
type: integer
format: int32
minimum: -12
maximum: 12
default: 0
example: 3
calculation_settings:
description: Calculation settings.
type: object
additionalProperties: false
properties:
max_calculation_time:
description: 'Max calculation time. The countdown starts from the time when
data is uploaded to the server and calculation starts.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT20M
example: PT12M35S
max_waiting_time:
description: 'Max calculation time. The countdown starts from the time when
data is uploaded to the server.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT20M
example: PT2H
result_ttl:
description: 'Calculation result lifetime. The countdown starts from the
time when the calculation is completed.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT20M
example: PT4M30S
result_timezone:
$ref: '#/components/schemas/timezone'
description: The time zone where the calculation result is returned.
default: 0
treat_warnings_as_errors:
description: 'Treat warnings as errors and do not run calculations if at
least one entity contains invalid data.
'
type: boolean
default: false
example: true
precision:
description: 'Specifies the calculation accuracy in the decimal point sequence
number. It equals 3 by default, so the accuracy is 0.001.
'
type: integer
format: int32
minimum: 0
maximum: 6
default: 3
example: 1
worker_tag:
description: Calculation tag, used to select the calculation pool.
type:
- string
- 'null'
minLength: 0
maxLength: 100
default: null
example: custom-worker-x
extension_settings:
description: Settings for using external extensions to adjust calculations.
type: object
additionalProperties: false
properties:
enable_extension:
description: Use a third-party calculation adjuster.
type: boolean
default: false
example: true
extension_url:
description: The address of an external service implementing the Universal
Extension API.
type:
- string
- 'null'
minLength: 9
maxLength: 512
default: null
example: https://universal-extension.veeroute.cloud
request_timeout:
description: The maximum time to wait for a response from the external service
implementing the Universal Extension API (for each request).
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT10M
example: PT1M30S
retry_attempts:
description: The number of attempts to request an external service implementing
the Universal Extension API.
type: integer
format: int32
minimum: 0
maximum: 100
default: 3
example: 2
retry_interval:
description: The time between request attempts to an external service implementing
the Universal Extension API.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT1M
example: PT1M30S
plan_settings:
description: Planning settings.
type: object
additionalProperties: false
properties:
trips_settings:
$ref: '#/components/schemas/trips_settings'
geo_settings:
$ref: '#/components/schemas/geo_settings'
calculation_settings:
$ref: '#/components/schemas/calculation_settings'
extension_settings:
$ref: '#/components/schemas/extension_settings'
replan_strategy:
description: Replanning strategy.
type: object
additionalProperties: false
properties:
reorder:
description: Ability to change the order execution sequence that exists
in the source trips.
type: boolean
default: false
example: true
plan_new_orders:
description: Ability to plan new orders into existing or new trips (if the
`create_new_trips` option is enabled).
type: boolean
default: false
example: true
create_new_trips:
description: Ability to create new trips in addition to the existing ones.
type: boolean
default: false
example: true
allow_possible_events:
description: Ability to select a different possible event after replanning.
type: boolean
default: false
example: true
replan_settings:
description: Replanning settings.
type: object
additionalProperties: false
properties:
replan_strategy:
$ref: '#/components/schemas/replan_strategy'
actualize_settings:
description: 'Actualize settings.
'
type: object
additionalProperties: false
properties:
current_time:
description: 'Current date and time according to the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6).
If not specified, the current time when the request was received by the
server is taken.
'
type:
- string
- 'null'
format: date-time
default: null
example: '2026-09-21T09:30:00+03:00'
max_delay_duration:
description: 'Acceptable delay. Affects the shift of the right boundaries
of hard time windows of orders and time windows of work shifts of performers
and transports.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT3H
example: PT1H30M
fact_processing_threshold:
description: 'Fact processing threshold. If a fact''s `creation_time > current_time
+ fact_processing_threshold`, it is considered invalid.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT10M
example: PT1H
experiment_settings:
description: Experiment settings.
type: object
additionalProperties: false
properties:
plan_settings:
$ref: '#/components/schemas/plan_settings'
replan_settings:
$ref: '#/components/schemas/replan_settings'
actualize_settings:
$ref: '#/components/schemas/actualize_settings'
required:
- plan_settings
- replan_settings
- actualize_settings
indicators:
description: 'List of indicators. An indicator refers to a specific metric from
statistics.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
description: Indicator key.
type: string
minLength: 2
maxLength: 256
default: []
example:
- total_statistics_cost
- total_statistics_measurements_waiting_time
task_statistics:
description: General statistics on input data.
type: object
additionalProperties: false
properties:
planning_horizon:
$ref: '#/components/schemas/time_window'
description: "Planning horizon is a time window where:\n * `from` - the\
\ left border of the time windows of all entities from the input data\n\
\ * `to` - the right border of the time windows of all entities from\
\ the input data\n"
required:
- planning_horizon
time_window_violation_detail:
description: Time window violation detail information.
type: object
additionalProperties: false
properties:
demand_keys:
description: List of object's keys.
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
description: Demand's key.
type: string
minLength: 1
maxLength: 1024
example:
- obj1
count:
description: The total number of demands.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1700
required:
- demand_keys
- count
time_window_violations:
description: 'Statistics of time window violation.
'
type: object
additionalProperties: false
properties:
before:
$ref: '#/components/schemas/time_window_violation_detail'
description: Count and order's keys, what planned before permitted time
window.
after:
$ref: '#/components/schemas/time_window_violation_detail'
description: Count and order's keys, what planned after permitted time window.
required:
- before
- after
quality:
description: Quality metrics.
type: object
additionalProperties: false
properties:
locations_limits_penalty:
description: Amount of fines for violating location's capacity limit.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 25000
soft_time_window_violations:
$ref: '#/components/schemas/time_window_violations'
description: Statistics of soft time window violations.
hard_time_window_violations:
$ref: '#/components/schemas/time_window_violations'
description: Statistics of hard time window violations.
required:
- locations_limits_penalty
- soft_time_window_violations
- hard_time_window_violations
table_data_stats:
description: Data statistics.
type: object
additionalProperties: false
readOnly: true
properties:
locations:
description: Locations count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
orders:
description: Orders count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
performers:
description: Performers count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
transports:
description: Transports count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
hardlinks:
description: Hardlinks count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
trips:
description: Trips count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
facts:
description: Facts count.
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
external_routing:
description: Using external routing.
type: boolean
example: false
required:
- locations
- orders
- performers
- transports
- hardlinks
- trips
- facts
- external_routing
execution_statistics:
description: Statistics on the execution of trips within a wave.
type: object
additionalProperties: false
readOnly: true
properties:
progress:
description: 'Execution progress as a percentage. Progress reflects the
ratio of orders with final statuses `FINISHED` and `CANCELED` to all orders.
'
type: integer
format: int32
minimum: 0
maximum: 100
example: 52
order_free_count:
description: Number of orders with `FREE` status (not assigned to any trip).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 3
order_planned_count:
description: Number of orders with `PLANNED` status (planned to a trip).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 5
order_executing_count:
description: Number of orders with `EXECUTING` status (in progress).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 2
order_finished_count:
description: Number of orders with `FINISHED` status (completed).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 10
order_canceled_count:
description: Number of orders with `CANCELED` status (canceled).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
trip_free_count:
description: Number of trips with `FREE` status (no assigned crew).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 2
trip_assigned_count:
description: Number of trips with `ASSIGNED` status (crew assigned).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 4
trip_sent_count:
description: Number of trips with `SENT` status (sent to the crew).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 7
trip_received_count:
description: Number of trips with `RECEIVED` status (received by the crew).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 10
trip_confirmed_count:
description: Number of trips with `CONFIRMED` status (accepted by the crew).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 4
trip_rejected_count:
description: Number of trips with `REJECTED` status (rejected by the crew).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
trip_executing_count:
description: Number of trips with `EXECUTING` status (in progress).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1988
trip_finished_count:
description: Number of trips with `FINISHED` status (completed).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 4
trip_canceled_count:
description: Number of trips with `CANCELED` status (canceled).
type: integer
format: int32
minimum: 0
maximum: 15001
example: 1
required:
- progress
- order_free_count
- order_planned_count
- order_executing_count
- order_finished_count
- order_canceled_count
- trip_free_count
- trip_assigned_count
- trip_sent_count
- trip_received_count
- trip_confirmed_count
- trip_rejected_count
- trip_executing_count
- trip_finished_count
- trip_canceled_count
wave_statistics:
description: Wave statistics.
type: object
additionalProperties: false
properties:
indicators:
$ref: '#/components/schemas/indicators'
total_statistics:
$ref: '#/components/schemas/general_statistics'
task_statistics:
$ref: '#/components/schemas/task_statistics'
quality:
$ref: '#/components/schemas/quality'
data_statistics:
$ref: '#/components/schemas/table_data_stats'
execution_statistics:
$ref: '#/components/schemas/execution_statistics'
required:
- indicators
- total_statistics
- task_statistics
- quality
- data_statistics
- execution_statistics
wave_status:
description: "Current wave status:\n * `ACTIVE` - the wave is active: processing\
\ of incoming facts is enabled, autopilot can be turned on\n * `INACTIVE`\
\ - the wave is inactive: processing of incoming facts is disabled, autopilot\
\ is not available\n"
type: string
enum:
- ACTIVE
- INACTIVE
default: INACTIVE
example: ACTIVE
wave_autopilot_status:
description: "Current autopilot status:\n * `PREPARING` - autopilot is in the\
\ process of starting\n * `RUNNING` - the autopilot is started and running\n\
\ * `STOPPED` - the autopilot is stopped\n * `ERROR` - the autopilot is\
\ stopped due to an error\n"
type: string
enum:
- PREPARING
- RUNNING
- STOPPED
- ERROR
default: STOPPED
example: RUNNING
wave_autopilot_status_error:
description: "Typed autopilot error (set when status is `ERROR`):\n * `INCONSISTENT_REFERENCE`\
\ - data contains errors in the refs, automatic processing is not possible\n"
type: string
enum:
- INCONSISTENT_REFERENCE
example: INCONSISTENT_REFERENCE
wave_autopilot_settings:
description: 'Autopilot settings.
'
type: object
additionalProperties: false
properties:
automatch_delay:
description: Time delay between iterations of automatic crew assignment
to trips and their launch.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT15M
example: PT2M30S
replan_delay:
description: Time delay between iterations of replan.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT15M
example: PT2M30S
wave_autopilot_timers:
description: 'Autopilot timers.
'
type: object
additionalProperties: false
properties:
automatch_timer:
description: Time remaining until the next automatic assignment of crews
to trip and their launch.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT15M
example: PT2M30S
replan_timer:
description: The time remaining until the next replan starts.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT15M
example: PT2M30S
wave_autopilot_event:
description: Autopilot event.
type: object
additionalProperties: false
properties:
time:
description: 'Event date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type: string
format: date-time
example: '2026-09-21T19:45:00Z'
message:
description: Event message text.
type: string
minLength: 1
maxLength: 1000
example: Запущена итерация перепланирования.
required:
- time
- message
wave_autopilot_events_log:
description: Autopilot events log, sorted by time.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/wave_autopilot_event'
default: []
wave_autopilot:
description: 'Autopilot state and settings.
'
type: object
additionalProperties: false
properties:
status:
$ref: '#/components/schemas/wave_autopilot_status'
status_error:
description: Typed autopilot error (set when status is `ERROR`).
oneOf:
- $ref: '#/components/schemas/wave_autopilot_status_error'
- $ref: '#/components/schemas/nullable'
default: null
readOnly: true
settings:
$ref: '#/components/schemas/wave_autopilot_settings'
timers:
$ref: '#/components/schemas/wave_autopilot_timers'
events_log:
$ref: '#/components/schemas/wave_autopilot_events_log'
required:
- status
- settings
- timers
- events_log
calculation_progress:
description: 'Calculation progress as a percentage. The progress displays the
current number of completed steps.
'
type: integer
format: int32
default: 0
minimum: 0
maximum: 100
example: 52
calculation_status:
description: "Calculation status:\n * `WAITING` - the calculation is waiting\
\ to be launched.\n * `IN_PROGRESS` - calculation in progress.\n * `FINISHED_IN_TIME`\
\ - the calculation completed correctly before the specified maximum time.\n\
\ * `FINISHED_OUT_OF_TIME` - the calculation ended because the specified\
\ time for calculation has expired, which can affect the quality of the result\
\ for the worse.\n * `CANCELED` - the calculation was canceled because a\
\ cancel command was received.\n * `CANCELED_BY_TIMEOUT` - the calculation\
\ was canceled automatically because the waiting time in the queue was exceeded.\n\
\ * `CANCELED_BY_QUOTA` - the calculation was canceled because the quota\
\ for this calculation type was exceeded.\n * `FAILED` - calculation completed\
\ with an error.\n"
type: string
enum:
- WAITING
- IN_PROGRESS
- FINISHED_IN_TIME
- FINISHED_OUT_OF_TIME
- CANCELED
- CANCELED_BY_TIMEOUT
- CANCELED_BY_QUOTA
- FAILED
example: FINISHED_IN_TIME
calculation_info:
description: Calculation information.
type: object
additionalProperties: false
properties:
status:
$ref: '#/components/schemas/calculation_status'
message:
description: Message with additional information about the calculation status.
type:
- string
- 'null'
minLength: 0
maxLength: 10000
default: null
example: detail error message
result_version:
description: Planning result version.
type: integer
format: int32
minimum: 0
maximum: 1000000
example: 133
preparing_time:
$ref: '#/components/schemas/time_duration'
description: Time to prepare for calculation, format `P1DT2H12M34.2S`.
business_validation_time:
$ref: '#/components/schemas/time_duration'
description: Business validation duration, format `P1DT2H12M34.2S`.
math_validation_time:
$ref: '#/components/schemas/time_duration'
description: Math validation duration, format `P1DT2H12M34.2S`.
waiting_time:
$ref: '#/components/schemas/time_duration'
description: Time to waiting for calculation, format `P1DT2H12M34.2S`.
calculation_time:
$ref: '#/components/schemas/time_duration'
description: Actual calculation time, format `P1DT2H12M34.2S`.
postprocessing_time:
$ref: '#/components/schemas/time_duration'
description: Post-processing time calculation using Universal Extension,
format `P1DT2H12M34.2S`.
required:
- status
- result_version
- preparing_time
- business_validation_time
- math_validation_time
- waiting_time
- calculation_time
calculation_state:
description: Current calculation state.
type: object
additionalProperties: false
properties:
tracedata:
$ref: '#/components/schemas/tracedata'
calculation_progress:
$ref: '#/components/schemas/calculation_progress'
calculation_info:
$ref: '#/components/schemas/calculation_info'
required:
- tracedata
- calculation_progress
- calculation_info
experiment_check:
description: Result of checking the dataset.
type: object
additionalProperties: false
properties:
logical_errors:
$ref: '#/components/schemas/entity_error_list'
warnings:
$ref: '#/components/schemas/entity_warning_list'
file_sharing:
description: 'File sharing flag.
'
type: boolean
default: true
readOnly: true
example: false
file_edit_date:
description: 'Last file edit date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type: string
format: date-time
readOnly: true
example: '2026-09-21T19:45:00Z'
file_creation_date:
description: 'File creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
'
type: string
format: date-time
readOnly: true
example: '2026-09-21T19:45:00Z'
wave:
description: Wave.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/unique_key'
specification:
$ref: '#/components/schemas/file_specification'
settings:
$ref: '#/components/schemas/experiment_settings'
statistics:
$ref: '#/components/schemas/wave_statistics'
status:
$ref: '#/components/schemas/wave_status'
autopilot:
description: Current autopilot state and settings.
oneOf:
- $ref: '#/components/schemas/wave_autopilot'
- $ref: '#/components/schemas/nullable'
default: null
calculation:
description: Current calculation state if possible.
oneOf:
- $ref: '#/components/schemas/calculation_state'
- $ref: '#/components/schemas/nullable'
default: null
check:
description: Result of checking the dataset.
oneOf:
- $ref: '#/components/schemas/experiment_check'
- $ref: '#/components/schemas/nullable'
default: null
sharing:
$ref: '#/components/schemas/file_sharing'
edit_date:
$ref: '#/components/schemas/file_edit_date'
creation_date:
$ref: '#/components/schemas/file_creation_date'
required:
- key
- specification
- settings
- statistics
- status
- edit_date
- creation_date
table_wave_column_type:
description: "Column name in the table with waves:\n * `ESSENCE_KEY` - wave\
\ key\n"
type: string
enum:
- ESSENCE_KEY
- SHARING
- EDIT_DATE
- CREATION_DATE
- SPECIFICATION_NAME
- SPECIFICATION_COMMENT
- SPECIFICATION_FOLDER_KEY
default: SPECIFICATION_NAME
example: SPECIFICATION_FOLDER_KEY
table_wave_list:
description: A list of waves (table).
type: object
additionalProperties: false
properties:
essences:
description: A list of waves.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/wave'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
subscription_key:
description: 'Unique (within the account) key of the wave data changes subscription.
Set by the integration when creating a subscription and cannot be changed.
'
type: string
pattern: \w+
minLength: 3
maxLength: 256
example: erp_integration
wave_subscription:
description: 'Wave data changes subscription - notification settings for informing
an external integration about changes in the active waves of the account.
'
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/subscription_key'
callback_url:
description: The address of the external service to which the data change
notification will be sent.
type: string
minLength: 9
maxLength: 512
example: https://waves-integration.veeroute.cloud/waves/notification
notification_delay:
description: 'The minimum delay between notifications for one wave. The
changes that occurred during this time are included in one notification.
'
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT1M
example: PT1M30S
request_timeout:
description: The maximum time to wait for a response from the external service
(for each request).
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT1M
example: PT30S
retry_attempts:
description: The number of retries to send a notification if the external
service did not respond successfully.
type: integer
format: int32
minimum: 0
maximum: 100
default: 3
example: 2
retry_interval:
description: The time between retries to send a notification.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: PT1M
example: PT1M30S
required:
- key
- callback_url
wave_subscription_list:
description: A list of wave data changes subscriptions.
type: array
uniqueItems: false
minItems: 0
maxItems: 20
items:
$ref: '#/components/schemas/wave_subscription'
default: []
wave_notification:
description: 'Wave data change notification - sent to the address specified
in the subscription.
'
type: object
additionalProperties: false
properties:
file_key:
$ref: '#/components/schemas/unique_key'
description: The key of the wave in which the data has changed.
data_statistics:
$ref: '#/components/schemas/table_data_stats'
description: Statistics on the wave entities at the time of sending the
notification.
required:
- file_key
- data_statistics
file_neighbors:
description: Neighbors.
type: object
additionalProperties: false
properties:
previous_file_key:
description: The key of the previous file is in the same folder.
type:
- string
- 'null'
format: uuid
example: 11111111-2222-3333-4444-555555555555
next_file_key:
description: The key of the next file is in the same folder.
type:
- string
- 'null'
format: uuid
example: 11111111-2222-3333-4444-555555555555
location_list:
description: List of locations used for orders and shifts.
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/location'
order_list:
description: List of orders that need to be completed.
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/order'
performer_tariff_constraint:
description: The paid period of time is an integral part of the tariff.
type: object
additionalProperties: false
properties:
stage_length:
description: Length of the paid period according to `P1DT2H12M34.2S`.
type: string
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: P30D
example: P1DT8H30M20S
cost_per_unit:
description: 'Cost within the paid period, monetary unit per second of work.
'
type: number
format: double
minimum: 0.001
maximum: 10000
default: 0.001
example: 5.05
performer_tariff:
description: The tariff determines the cost and time limits of the shift.
type: object
additionalProperties: false
properties:
cost_per_shift:
description: Price for using the shift, monetary unit.
type: number
format: double
minimum: 0.001
maximum: 1000000
default: 0.001
example: 2000
constraints:
description: A list of tariff components that apply from the start of movement
or execution of work on orders.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/performer_tariff_constraint'
max_penalty_cost:
description: 'Max sum of penalties for performer or transport using this
shift, monetary unit. If not specified or null, the performer can violate
without restrictions.
'
type:
- number
- 'null'
format: double
minimum: 0
maximum: 1000000
default: null
example: 2000
time_duration_null:
description: Time duration according to `P1DT2H12M34.2S`.
type:
- string
- 'null'
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: null
example: PT2H12M33S
rest:
description: The condition for the onset and characteristics of a rest.
type: object
additionalProperties: false
properties:
relocating_duration_sum:
$ref: '#/components/schemas/time_duration'
description: 'Total relocation time between locations, no later than which
you need to take a rest according to `P1DT2H12M34.2S`.
'
operating_duration_sum:
$ref: '#/components/schemas/time_duration_null'
description: 'The total trip time (excluding waiting time), no later than
which a long rest stop must be made, in ISO 8601 duration format. If the
break is not included during a waiting time, its duration is counted as
work.
'
duration:
$ref: '#/components/schemas/time_duration'
description: Length of break period according to `P1DT2H12M34.2S`.
required:
- relocating_duration_sum
- duration
rest_rules:
description: Rules for accounting for rest.
type: object
additionalProperties: false
properties:
consecutive:
$ref: '#/components/schemas/rest'
description: The condition for the onset and characteristics of a consecutive
rest.
required:
- consecutive
break:
description: The condition for the onset and characteristics of a break.
type: object
additionalProperties: false
properties:
relocating_duration_sum:
$ref: '#/components/schemas/time_duration'
description: Total relocation time between locations, no later which you
need to take a break according to `P1DT2H12M34.2S`.
operating_duration_sum:
$ref: '#/components/schemas/time_duration_null'
description: Total trip time (excluding waiting), no later which you need
to take a break according to `P1DT2H12M34.2S`.
duration:
$ref: '#/components/schemas/time_duration'
description: Length of break period according to `P1DT2H12M34.2S`.
required:
- relocating_duration_sum
- duration
break_rules:
description: Rules for accounting for breaks.
type: object
additionalProperties: false
properties:
first:
$ref: '#/components/schemas/break'
description: The condition for the onset and characteristics of a first
break.
consecutive:
description: The condition for the onset and characteristics of a consecutive
break.
oneOf:
- $ref: '#/components/schemas/break'
- $ref: '#/components/schemas/nullable'
default: null
relocating_duration_type:
description: Type of accounting for time spent moving between locations
(total or continuous).
type: string
enum:
- TOTAL
- CONTINUOUS
default: TOTAL
example: CONTINUOUS
required:
- first
work_and_rest_rules:
description: Performer's work and rest rules.
type: object
additionalProperties: false
properties:
rest_rules:
description: Rules for accounting for rest.
oneOf:
- $ref: '#/components/schemas/rest_rules'
- $ref: '#/components/schemas/nullable'
default: null
break_rules:
description: Rules for accounting for breaks.
oneOf:
- $ref: '#/components/schemas/break_rules'
- $ref: '#/components/schemas/nullable'
default: null
reset_location_keys:
description: A list of locations keys in which the counters for breaks and
rest are reset when located.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
description: Location key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_01
default: []
ignore_location_keys:
description: List of location keys whose stay is not taken into account
in the total trip execution time counter.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
description: Location key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_01
default: []
performer_shift:
description: 'Performer''s shift that determines the availability of the resource
for planning within its time window.
'
type: object
additionalProperties: false
properties:
key:
description: Shift key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: shift01
availability_time:
$ref: '#/components/schemas/time_window'
description: Time shift window when the performer can perform work at locations
and drive between locations.
working_time:
$ref: '#/components/schemas/time_window'
description: Working time window, when the performer can perform work at
locations, must be inside the time window.
start_location_key:
description: 'Start location key. If not specified, the trip starts from
the first order location.
'
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: start_location_01
finish_location_key:
description: 'Finish location key. If not specified, the trip finishes
on the last order location.
'
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: finish_location_01
max_locations:
description: 'Limit of the number of unique locations in one trip. If not
specified or null, number of locations is not limited.
'
type:
- integer
- 'null'
format: int32
minimum: 1
maximum: 1000
default: null
example: 15
max_stops:
description: 'Limit of the number of stops in one trip. If not specified
or null, number of stops is not limited.
'
type:
- integer
- 'null'
format: int32
minimum: 1
maximum: 1000
default: null
example: 15
tariff:
$ref: '#/components/schemas/performer_tariff'
work_and_rest_rules:
description: Performer's work and rest rules.
oneOf:
- $ref: '#/components/schemas/work_and_rest_rules'
- $ref: '#/components/schemas/nullable'
default: null
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- availability_time
- working_time
performer:
description: 'Performer. Fulfills orders using transport.
'
type: object
additionalProperties: false
properties:
key:
description: Performer's key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: performer0001
shifts:
description: List of working shifts of performer.
type: array
uniqueItems: true
minItems: 1
maxItems: 15001
items:
$ref: '#/components/schemas/performer_shift'
own_transport_type:
$ref: '#/components/schemas/transport_type'
description: The type of personal transport that the performer will use
to get to his assigned work transport.
default: CAR
compatibilities:
description: Compatibilities of [the performer with transport and orders](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/performer_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
limits:
description: Limitation on the performer's workload.
oneOf:
- $ref: '#/components/schemas/performer_limits'
- $ref: '#/components/schemas/nullable'
default: null
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- shifts
performer_list:
description: 'Available performers list. The performer fulfills orders using
transport.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/performer'
transport_tariff_constraint:
description: Paid mileage is an integral part of the tariff.
type: object
additionalProperties: false
properties:
stage_length:
description: The length of the paid part of the way, in meters.
type: integer
format: int32
minimum: 1
maximum: 100000000
default: 100000000
example: 200000
cost_per_unit:
description: 'The cost within the paid part of the way, monetary unit per
meter.
'
type: number
format: double
minimum: 0.001
maximum: 10000
default: 0.001
example: 5.05
transport_tariff:
description: The tariff determines the cost of transport operation and restrictions
on mileage per shift.
type: object
additionalProperties: false
properties:
cost_per_shift:
description: Price for using the shift, monetary unit.
type: number
format: double
minimum: 0.001
maximum: 1000000
default: 0.001
example: 2000
constraints:
description: List of components of the tariff.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/transport_tariff_constraint'
transportation_cost:
description: The cost of moving 1 unit of measure of cargo per 1 meter (for
each capacity field, respectively), monetary unit.
oneOf:
- $ref: '#/components/schemas/capacity_cost'
- $ref: '#/components/schemas/nullable'
default: null
transport_shift:
description: 'Working shift of transport. Specifies the availability of transport
for scheduling. The end of the shift resets the cargo remaining in the body
after the execution of demands of the `DROP_FROM_BOX` and `PICKUP_TO_BOX`
types.
'
type: object
additionalProperties: false
properties:
key:
description: Shift key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: shift01
availability_time:
$ref: '#/components/schemas/time_window'
description: The shift time window in which the transport can move between
locations and be used by the performer in work on locations.
start_location_key:
description: 'Start location key. If the key is not set, then the transport
path starts on the first order.
'
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: start_location_01
finish_location_key:
description: 'Finish location key. If the key is not set, then the transport
path ends at the last order.
'
type:
- string
- 'null'
minLength: 1
maxLength: 1024
default: null
example: finish_location_01
tariff:
$ref: '#/components/schemas/transport_tariff'
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- availability_time
transport:
description: 'Transport. Used by performer for relocating and cargo transfer.
'
type: object
additionalProperties: false
properties:
key:
description: Transport key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: transport001
shifts:
description: List of working shifts of transport.
type: array
uniqueItems: true
minItems: 1
maxItems: 15001
items:
$ref: '#/components/schemas/transport_shift'
transport_type:
$ref: '#/components/schemas/transport_type'
default: CAR
boxes:
description: A list of transport boxes that can accommodate the cargo.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/box'
default: []
compatibilities:
description: Compatibilities of [the transport with performers and locations](#section/Description/Compatibilities).
oneOf:
- $ref: '#/components/schemas/transport_compatibilities'
- $ref: '#/components/schemas/nullable'
default: null
limits:
description: Transport load limits.
oneOf:
- $ref: '#/components/schemas/transport_limits'
- $ref: '#/components/schemas/nullable'
default: null
name:
$ref: '#/components/schemas/name'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- shifts
transport_list:
description: 'Available transports list. Transport is used by the trip performer
to fulfill orders.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/transport'
hardlink_element_type:
description: 'Type of goal entity. It can be an order or a performer\transport
shift.
'
type: string
enum:
- ORDER
- PERFORMER_SHIFT
- TRANSPORT_SHIFT
example: ORDER
hardlink_element:
description: Assignment group element.
type: object
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/hardlink_element_type'
entity_key:
description: Key of the target entity (an order or a shift).
type: string
minLength: 1
maxLength: 1024
example: ord0001
required:
- type
- entity_key
hardlink:
description: "Assignment required to associate entities in a single group. It\
\ can consist of two or more entities. Example:\n * driver assignment to\
\ the transport (connection between the performer's shifts and the transport).\n\
\ * order assignment to the performer (link the order to a performer's shift).\n\
\ * specifying the need to perform multiple orders during a single trip (linking\
\ orders to deliver them within one trip).\n"
type: object
additionalProperties: false
properties:
key:
description: Hardlink key.
type: string
minLength: 1
maxLength: 1024
example: group01
links:
description: List of items in the assignment group.
type: array
uniqueItems: false
minItems: 2
maxItems: 1000
items:
$ref: '#/components/schemas/hardlink_element'
attributes:
$ref: '#/components/schemas/attributes'
required:
- key
- links
hardlink_list:
description: Assignments list.
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/hardlink'
trip_list:
description: '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](#section/Description/Trip-model) of the performer.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/trip'
fact_list:
description: 'List of facts. A fact is an event that has occurred that affects
further trip operations.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 45003
items:
$ref: '#/components/schemas/fact'
trip_statistics_list:
description: 'List of statistics for each scheduled trip separately.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/trip_statistics'
location_limit_statistics:
description: 'Statistics on the implementation of location capacity limits within
one time window.
'
type: object
additionalProperties: false
properties:
location_limit_key:
description: Location limit key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_limit_constraint_01
cargos_statistics:
$ref: '#/components/schemas/location_cargos_limit'
description: For time window - the amount of measures of cargos moved and
the amount of fines for violating restrictions on the movement of cargos.
transports_statistics:
$ref: '#/components/schemas/location_transports_limit'
description: For time window - the number of transports serviced on average
during a specified time window and the amount of fines for violating transport
service restrictions.
location_limit_penalty:
description: The amount of fines for violating the location's capacity within
the limit.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 25000
required:
- location_limit_key
- location_limit_penalty
- cargos_statistics
- transports_statistics
location_statistics:
description: Statistics for a specific trip.
type: object
additionalProperties: false
properties:
location_key:
description: Location key.
type: string
minLength: 1
maxLength: 1024
example: location_01
location_limits_penalty:
description: Amount of fines for violating location's capacity limit.
type: number
format: double
minimum: 0
maximum: 1000000000
example: 25000
total_cargos_statistics:
$ref: '#/components/schemas/location_cargos_limit'
description: For location - The amount of measures of cargos moved and the
amount of fines for violating restrictions on the movement of cargos.
deprecated: true
total_transports_statistics:
$ref: '#/components/schemas/location_transports_limit'
description: For location - the number of transports serviced on average
during a specified time window and the amount of fines for violating transport
service restrictions.
deprecated: true
limits_statistics:
description: Location capacity limit statistics.
type: array
uniqueItems: false
minItems: 0
maxItems: 48
items:
$ref: '#/components/schemas/location_limit_statistics'
required:
- location_key
- location_limits_penalty
- total_cargos_statistics
- total_transports_statistics
- limits_statistics
location_statistics_list:
description: Statistics on the loading of locations for which bandwidth restrictions
have been set.
type: array
minItems: 0
maxItems: 15001
uniqueItems: false
items:
$ref: '#/components/schemas/location_statistics'
default: []
plan_statistics:
description: 'General statistics on the calculation result.
'
type: object
additionalProperties: false
properties:
total_statistics:
$ref: '#/components/schemas/general_statistics'
trips_statistics:
$ref: '#/components/schemas/trip_statistics_list'
locations_statistics:
$ref: '#/components/schemas/location_statistics_list'
task_statistics:
$ref: '#/components/schemas/task_statistics'
quality:
$ref: '#/components/schemas/quality'
required:
- total_statistics
- trips_statistics
- locations_statistics
- task_statistics
- quality
routing_matrix_waypoint:
description: 'Routing matrix waypoint.
'
type: object
additionalProperties: false
properties:
geopoint:
$ref: '#/components/schemas/geopoint'
name:
description: 'Name of the point. Can be used as an identifier to match the
task and the calculation result.
'
type:
- string
- 'null'
default: null
minLength: 0
maxLength: 1024
example: waypoint_1
required:
- geopoint
routing_matrix_line:
description: Values line in the route distances matrix (in meters) or in the
route durations matrix (in seconds), between points.
type: array
minItems: 2
maxItems: 15001
uniqueItems: false
items:
description: 'Route distance (in meters) or duration (in seconds) between
locations. A negative value (-1) means that it is not possible to drive
between the specified locations.
'
type: integer
format: int64
minimum: -1
maximum: 10000000
example: 1500
routing_matrix:
description: 'Routing matrix. Contains durations and distances between points.
'
type: object
additionalProperties: false
properties:
waypoints:
description: Array of geographical points with distances and times calculated
between them.
type: array
uniqueItems: false
minItems: 2
maxItems: 15001
items:
$ref: '#/components/schemas/routing_matrix_waypoint'
distances:
description: 'Routes length between two neighbors locations, in meters.
The values in the array are ordered according to the elements order in
the `waypoints` parameter. Each matrix row is an array of distances from
the desired point to every other point. A negative value (-1) means that
it is not possible to drive between the specified locations.
'
type: array
uniqueItems: false
minItems: 2
maxItems: 15001
items:
$ref: '#/components/schemas/routing_matrix_line'
example:
- - 0
- 1500
- - 1500
- 0
durations:
description: 'An array of route durations between points, in seconds. The
values in the array are ordered according to the order of the elements
in the `waypoints` parameter. Each row of the matrix is an array of travel
times from the desired point to each other point. A negative value (-1)
means that it is impossible to travel between the specified points.
'
type: array
uniqueItems: false
minItems: 2
maxItems: 15001
items:
$ref: '#/components/schemas/routing_matrix_line'
example:
- - 0
- 3600
- - 3600
- 0
required:
- waypoints
- distances
- durations
routing_transport_matrix:
description: Time-distance matrix for a specific transport type.
type: object
additionalProperties: false
properties:
transport_type:
$ref: '#/components/schemas/transport_type'
matrix:
$ref: '#/components/schemas/routing_matrix'
required:
- transport_type
- matrix
routing_transport_matrix_list:
description: '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.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 16
default: []
items:
$ref: '#/components/schemas/routing_transport_matrix'
dataset_name:
description: 'The name of the dataset.
A technical field that does not affect calculation.
'
type: string
minLength: 0
maxLength: 512
default: ''
example: custom_dataset_one
universal_data:
description: 'VRt.Universal JSON format. A general list of data and settings
that combines all data for planning, replaning and actualization.
'
type: object
additionalProperties: false
properties:
locations:
$ref: '#/components/schemas/location_list'
orders:
$ref: '#/components/schemas/order_list'
performers:
$ref: '#/components/schemas/performer_list'
transports:
$ref: '#/components/schemas/transport_list'
hardlinks:
$ref: '#/components/schemas/hardlink_list'
trips:
$ref: '#/components/schemas/trip_list'
facts:
$ref: '#/components/schemas/fact_list'
statistics:
description: General statistics on the calculation result.
oneOf:
- $ref: '#/components/schemas/plan_statistics'
- $ref: '#/components/schemas/nullable'
default: null
external_routing:
$ref: '#/components/schemas/routing_transport_matrix_list'
plan_settings:
$ref: '#/components/schemas/plan_settings'
replan_settings:
$ref: '#/components/schemas/replan_settings'
actualize_settings:
$ref: '#/components/schemas/actualize_settings'
dataset_name:
$ref: '#/components/schemas/dataset_name'
basic_enabled:
description: Using essence for calculations.
type: boolean
default: true
readOnly: false
example: false
basic_pristine:
description: 'A flag indicating whether changes to the entity have been made
relative to the original data. `true` - means that the data is original and
has not been changed.
'
type: boolean
default: true
readOnly: true
example: false
table_attributes:
description: List of attributes as a string.
type: string
minLength: 0
maxLength: 1000000
default: ''
example: key1:value1, key2:value2
customfield_datetime:
description: 'A custom field containing date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format. Supported filter type is `DATETIME_RANGE`.
'
x-filter-type: DATETIME_RANGE
type:
- string
- 'null'
format: date-time
default: null
example: '2026-09-21T18:00:00+03:00'
customfield_int:
description: 'A custom field containing an integer value. Supported filter type
is `INT_RANGE`.
'
x-filter-type: INT_RANGE
type:
- integer
- 'null'
format: int32
default: null
minimum: -1000000000000
maximum: 1000000000000
example: 1
customfield_float:
description: 'A custom field containing a floating point value. Supported filter
type is `FLOAT_RANGE`.
'
x-filter-type: FLOAT_RANGE
type:
- number
- 'null'
format: double
minimum: -1000000000000
maximum: 1000000000000
default: null
example: 2343.3
customfield_duration:
description: 'A custom field containing the duration of the time period. Supported
filter type is `DURATION_RANGE`.
'
x-filter-type: DURATION_RANGE
type:
- string
- 'null'
format: duration
x-custom-format: duration
pattern: ^P(?!$)(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+(\.\d{1,9})?S)?)?$
minLength: 3
maxLength: 16
default: null
example: PT2H12M33S
customfield_bool:
description: 'A custom field containing a boolean value. Supported filter type
is `BOOL_LIST`.
'
x-filter-type: BOOL_LIST
type:
- boolean
- 'null'
format: boolean
default: null
example: true
customfield_string:
description: 'A custom field containing an string value. Supported filter type
is `STRING_SEARCH`.
'
x-filter-type: STRING_SEARCH
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 2000
example: value01
table_customfields:
description: Custom fields for table.
type: object
additionalProperties: false
properties:
datetime_0:
$ref: '#/components/schemas/customfield_datetime'
datetime_1:
$ref: '#/components/schemas/customfield_datetime'
datetime_2:
$ref: '#/components/schemas/customfield_datetime'
datetime_3:
$ref: '#/components/schemas/customfield_datetime'
datetime_4:
$ref: '#/components/schemas/customfield_datetime'
datetime_5:
$ref: '#/components/schemas/customfield_datetime'
datetime_6:
$ref: '#/components/schemas/customfield_datetime'
datetime_7:
$ref: '#/components/schemas/customfield_datetime'
datetime_8:
$ref: '#/components/schemas/customfield_datetime'
datetime_9:
$ref: '#/components/schemas/customfield_datetime'
int_0:
$ref: '#/components/schemas/customfield_int'
int_1:
$ref: '#/components/schemas/customfield_int'
int_2:
$ref: '#/components/schemas/customfield_int'
int_3:
$ref: '#/components/schemas/customfield_int'
int_4:
$ref: '#/components/schemas/customfield_int'
int_5:
$ref: '#/components/schemas/customfield_int'
int_6:
$ref: '#/components/schemas/customfield_int'
int_7:
$ref: '#/components/schemas/customfield_int'
int_8:
$ref: '#/components/schemas/customfield_int'
int_9:
$ref: '#/components/schemas/customfield_int'
float_0:
$ref: '#/components/schemas/customfield_float'
float_1:
$ref: '#/components/schemas/customfield_float'
float_2:
$ref: '#/components/schemas/customfield_float'
float_3:
$ref: '#/components/schemas/customfield_float'
float_4:
$ref: '#/components/schemas/customfield_float'
float_5:
$ref: '#/components/schemas/customfield_float'
float_6:
$ref: '#/components/schemas/customfield_float'
float_7:
$ref: '#/components/schemas/customfield_float'
float_8:
$ref: '#/components/schemas/customfield_float'
float_9:
$ref: '#/components/schemas/customfield_float'
duration_0:
$ref: '#/components/schemas/customfield_duration'
duration_1:
$ref: '#/components/schemas/customfield_duration'
duration_2:
$ref: '#/components/schemas/customfield_duration'
duration_3:
$ref: '#/components/schemas/customfield_duration'
duration_4:
$ref: '#/components/schemas/customfield_duration'
duration_5:
$ref: '#/components/schemas/customfield_duration'
duration_6:
$ref: '#/components/schemas/customfield_duration'
duration_7:
$ref: '#/components/schemas/customfield_duration'
duration_8:
$ref: '#/components/schemas/customfield_duration'
duration_9:
$ref: '#/components/schemas/customfield_duration'
bool_0:
$ref: '#/components/schemas/customfield_bool'
bool_1:
$ref: '#/components/schemas/customfield_bool'
bool_2:
$ref: '#/components/schemas/customfield_bool'
bool_3:
$ref: '#/components/schemas/customfield_bool'
bool_4:
$ref: '#/components/schemas/customfield_bool'
bool_5:
$ref: '#/components/schemas/customfield_bool'
bool_6:
$ref: '#/components/schemas/customfield_bool'
bool_7:
$ref: '#/components/schemas/customfield_bool'
bool_8:
$ref: '#/components/schemas/customfield_bool'
bool_9:
$ref: '#/components/schemas/customfield_bool'
string_0:
$ref: '#/components/schemas/customfield_string'
string_1:
$ref: '#/components/schemas/customfield_string'
string_2:
$ref: '#/components/schemas/customfield_string'
string_3:
$ref: '#/components/schemas/customfield_string'
string_4:
$ref: '#/components/schemas/customfield_string'
string_5:
$ref: '#/components/schemas/customfield_string'
string_6:
$ref: '#/components/schemas/customfield_string'
string_7:
$ref: '#/components/schemas/customfield_string'
string_8:
$ref: '#/components/schemas/customfield_string'
string_9:
$ref: '#/components/schemas/customfield_string'
table_location_fields:
description: Location fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- LOCATION
- WORK_WINDOW
default: LOCATION
example: LOCATION
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
working_time:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: true
name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: false
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
web_location:
description: Web location.
type: object
additionalProperties: false
properties:
location:
$ref: '#/components/schemas/location'
location_statistics:
description: Statistics for a specific trip.
oneOf:
- $ref: '#/components/schemas/location_statistics'
- $ref: '#/components/schemas/nullable'
default: null
fields:
$ref: '#/components/schemas/table_location_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- location
table_location_column_type:
description: "Column name in the table with locations:\n * `ESSENCE_KEY` -\
\ entity key\n * `ENABLED` - participation in calculation\n * `PRISTINE`\
\ - data change flag\n * `WORKING_TIME` - working time window\n * `ATTRIBUTES`\
\ - list of attributes in one line\n * `CUSTOMFIELDS` - custom table fields\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- WORKING_TIME
- NAME
- ATTRIBUTES
- CUSTOMFIELDS
default: NAME
example: ESSENCE_KEY
table_customfields_column_type:
description: 'The name of the additional column in the table. Used for filters
of the `CUSTOMFIELDS` type.
'
type: string
enum:
- DATETIME_0
- DATETIME_1
- DATETIME_2
- DATETIME_3
- DATETIME_4
- DATETIME_5
- DATETIME_6
- DATETIME_7
- DATETIME_8
- DATETIME_9
- INT_0
- INT_1
- INT_2
- INT_3
- INT_4
- INT_5
- INT_6
- INT_7
- INT_8
- INT_9
- FLOAT_0
- FLOAT_1
- FLOAT_2
- FLOAT_3
- FLOAT_4
- FLOAT_5
- FLOAT_6
- FLOAT_7
- FLOAT_8
- FLOAT_9
- DURATION_0
- DURATION_1
- DURATION_2
- DURATION_3
- DURATION_4
- DURATION_5
- DURATION_6
- DURATION_7
- DURATION_8
- DURATION_9
- BOOL_0
- BOOL_1
- BOOL_2
- BOOL_3
- BOOL_4
- BOOL_5
- BOOL_6
- BOOL_7
- BOOL_8
- BOOL_9
- STRING_0
- STRING_1
- STRING_2
- STRING_3
- STRING_4
- STRING_5
- STRING_6
- STRING_7
- STRING_8
- STRING_9
example: STRING_1
table_location_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_location_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_location_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_location_filter'
default: []
table_location:
description: Location (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_location_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_location_fields'
required:
- fields
- elements
table_location_list:
description: Locations table.
type: object
additionalProperties: false
properties:
essences:
description: Locations list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_location'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
web_location_geopoint:
description: Geopoint for map.
type: object
additionalProperties: false
properties:
geopoint:
$ref: '#/components/schemas/geopoint'
location_key:
description: Location key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: location_01
name:
$ref: '#/components/schemas/name'
example: Warehouse
icon_name:
description: 'The name of the icon. Obtained from the value of the location
attribute with the key `ICON_NAME`.
'
type:
- string
- 'null'
minLength: 1
maxLength: 64
default: null
example: location_whs
linked:
description: Flag indicating the presence of links to the location.
type: boolean
default: false
example: true
required:
- geopoint
- location_key
- linked
web_location_geopoint_list:
description: Geopoints for map.
type: object
additionalProperties: false
properties:
geopoints:
description: A list of points.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/web_location_geopoint'
counters:
$ref: '#/components/schemas/table_list_counters'
description: Counters by list of entities.
geopoints_counters:
$ref: '#/components/schemas/table_list_counters_detail'
description: Counters by list of points.
required:
- geopoints
- counters
- geopoints_counters
table_location_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_location_filter'
default: []
table_location_metrics:
description: General metrics for selected locations.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_location_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_location_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
basic_state:
description: "Entity state that determines its relation to the dataset:\n *\
\ `UNPLANNED` - new entity\n * `PLANNED` - the entity is planned in a specific\
\ trip at a specific time\n * `ASSIGNED` - the entity is assigned to a specific\
\ trip without a specific time\n * `INVALID` - the entity contains incorrect\
\ data and is not involved in planning\n"
type: string
enum:
- UNPLANNED
- PLANNED
- ASSIGNED
- INVALID
default: UNPLANNED
example: PLANNED
table_performer_fields:
description: Performer and shift fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- PERFORMER
- PERFORMER_SHIFT
default: PERFORMER
example: PERFORMER
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
state:
$ref: '#/components/schemas/basic_state'
x-filter-type: ENUM_LIST
x-default-enabled: true
working_time:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
availability_time:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
location_keys:
$ref: '#/components/schemas/table_string_search_field'
description: A comma-separated list of location keys that are associated
with this entity.
x-filter-type: STRING_SEARCH
x-default-enabled: true
example: location01,location02
performer_features:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
transport_restrictions:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
trips_count:
description: The number of trips in which the performer participates (for
a shift - 0 or 1).
x-filter-type: INT_RANGE
x-default-enabled: true
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
shifts_count:
description: The number of shifts for the performer.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: false
warnings:
$ref: '#/components/schemas/table_string_search_field'
description: List of warnings by entity.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: NO_AVAILABLE_TRANSPORT, NO_AVAILABLE_PERFORMER
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
web_performer:
description: Web Performer.
type: object
additionalProperties: false
properties:
performer:
$ref: '#/components/schemas/performer'
fields:
$ref: '#/components/schemas/table_performer_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- performer
table_performer_column_type:
description: "Column name in the table with performers:\n * `ESSENCE_KEY` -\
\ entity key\n * `ENABLED` - participation in calculation\n * `PRISTINE`\
\ - data change flag\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- STATE
- WORKING_TIME
- AVAILABILITY_TIME
- TRIP_KEY
- TRIP_NAME
- LOCATION_KEYS
- PERFORMER_FEATURES
- TRANSPORT_RESTRICTIONS
- TRIPS_COUNT
- SHIFTS_COUNT
- NAME
- WARNINGS
- ATTRIBUTES
- CUSTOMFIELDS
default: NAME
example: ESSENCE_KEY
table_performer_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_performer_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_performer_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_performer_filter'
default: []
table_performer:
description: Performer (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_performer_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_performer_fields'
required:
- fields
- elements
table_performer_list:
description: Performers table.
type: object
additionalProperties: false
properties:
essences:
description: Performers list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_performer'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
web_performer_geopoint:
description: Geopoint for map.
type: object
additionalProperties: false
properties:
geopoint:
$ref: '#/components/schemas/geopoint'
performer_key:
description: Performer's key.
type: string
minLength: 1
maxLength: 1024
example: performer_01
shift_key:
description: Shift key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: shift01
point_type:
description: The point type.
type: string
enum:
- START
- FINISH
example: START
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
trip_name:
$ref: '#/components/schemas/name'
stop_number:
description: Sequence number of the stop in the trip.
type: integer
format: int32
minimum: 0
maximum: 1000
default: 0
example: 10
required:
- geopoint
- performer_key
- shift_key
- point_type
web_performer_geopoint_list:
description: Geopoints for map.
type: object
additionalProperties: false
properties:
geopoints:
description: A list of points.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/web_performer_geopoint'
counters:
$ref: '#/components/schemas/table_list_counters'
description: Counters by list of entities.
geopoints_counters:
$ref: '#/components/schemas/table_list_counters_detail'
description: Counters by list of points.
required:
- geopoints
- counters
- geopoints_counters
table_performer_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_performer_filter'
default: []
table_performer_metrics:
description: General metrics for selected performers.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_performer_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_performer_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
table_transport_fields:
description: Transport and shift fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- TRANSPORT
- TRANSPORT_SHIFT
default: TRANSPORT
example: TRANSPORT
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
state:
$ref: '#/components/schemas/basic_state'
x-filter-type: ENUM_LIST
x-default-enabled: true
availability_time:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
transport_type:
$ref: '#/components/schemas/transport_type'
x-filter-type: ENUM_LIST
x-default-enabled: true
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
location_keys:
$ref: '#/components/schemas/table_string_search_field'
description: A comma-separated list of location keys that are associated
with this entity.
x-filter-type: STRING_SEARCH
x-default-enabled: true
example: location01,location02
mass:
description: Weight in kilograms (the sum of all boxes).
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 10
volume:
description: Volume in cubic meters (the sum of all boxes).
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_a:
description: 'Additional capacity parameter (A) in alternative units (the
sum of all boxes).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
capacity_b:
description: 'Additional capacity parameter (B) in alternative units (the
sum of all boxes).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_c:
description: 'Additional capacity parameter (C) in alternative units (the
sum of all boxes).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3
transport_features:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
performer_restrictions:
$ref: '#/components/schemas/table_string_search_field'
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
trips_count:
description: The number of trips in which the transport participates (for
a shift - 0 or 1).
x-filter-type: INT_RANGE
x-default-enabled: true
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
roundtrips_count:
description: The number of roundtrips in which the transport participates.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
shifts_count:
description: The number of shifts for the performer.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: false
warnings:
$ref: '#/components/schemas/table_string_search_field'
description: List of warnings by entity.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: NO_AVAILABLE_TRANSPORT, NO_AVAILABLE_PERFORMER
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
web_transport:
description: Web Transport.
type: object
additionalProperties: false
properties:
transport:
$ref: '#/components/schemas/transport'
fields:
$ref: '#/components/schemas/table_transport_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- transport
table_transport_column_type:
description: "Column name in the transport table:\n * `ESSENCE_KEY` - entity\
\ key\n * `ENABLED` - participation in calculation\n * `PRISTINE` - data\
\ change flag\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- STATE
- AVAILABILITY_TIME
- TRANSPORT_TYPE
- TRIP_KEY
- TRIP_NAME
- LOCATION_KEYS
- MASS
- VOLUME
- CAPACITY_A
- CAPACITY_B
- CAPACITY_C
- TRANSPORT_FEATURES
- PERFORMER_RESTRICTIONS
- TRIPS_COUNT
- ROUNDTRIPS_COUNT
- SHIFTS_COUNT
- NAME
- WARNINGS
- ATTRIBUTES
- CUSTOMFIELDS
default: NAME
example: ESSENCE_KEY
table_transport_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_transport_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_transport_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_transport_filter'
default: []
table_transport:
description: Transport (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_transport_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_transport_fields'
required:
- fields
- elements
table_transport_list:
description: Transports table.
type: object
additionalProperties: false
properties:
essences:
description: Transports list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_transport'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
web_transport_geopoint:
description: Geopoint for map.
type: object
additionalProperties: false
properties:
geopoint:
$ref: '#/components/schemas/geopoint'
transport_key:
description: Transport's key.
type: string
minLength: 1
maxLength: 1024
example: transport_01
shift_key:
description: Shift key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: shift01
point_type:
description: The point type.
type: string
enum:
- START
- FINISH
default: START
example: FINISH
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
trip_name:
$ref: '#/components/schemas/name'
stop_number:
description: Sequence number of the stop in the trip.
type: integer
format: int32
minimum: 0
maximum: 1000
default: 0
example: 10
required:
- geopoint
- transport_key
- shift_key
- point_type
web_transport_geopoint_list:
description: Geopoints for map.
type: object
additionalProperties: false
properties:
geopoints:
description: A list of points.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/web_transport_geopoint'
counters:
$ref: '#/components/schemas/table_list_counters'
description: Counters by list of entities.
geopoints_counters:
$ref: '#/components/schemas/table_list_counters_detail'
description: Counters by list of points.
required:
- geopoints
- counters
- geopoints_counters
table_transport_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_transport_filter'
default: []
table_transport_metrics:
description: General metrics for selected transports.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_transport_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_transport_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
table_order_fields:
description: Order and demand fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- ORDER
- DEMAND
default: ORDER
example: ORDER
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
state:
$ref: '#/components/schemas/basic_state'
x-filter-type: ENUM_LIST
x-default-enabled: true
type:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand types is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: true
example: WORK
hard_time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
soft_time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
general_drop_time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
general_pickup_time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
general_work_time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
reward:
description: The total reward for orders fulfillment.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 2343.3
mass:
description: Weight in kilograms.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 10
volume:
description: Volume in cubic meters.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_a:
description: 'Additional capacity parameter (A) for measuring cargoes and
boxes in alternative units. For example, to account for cargo in pieces
(this parameter is equal to one for a cargo and the maximum number of
cargo to hold for a box).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
capacity_b:
description: 'Additional capacity parameter (B) for measuring cargoes and
boxes in alternative units.
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
capacity_c:
description: 'Additional capacity parameter (C) for measuring cargoes and
boxes in alternative units.
'
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3
order_features:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
order_restrictions:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
performer_restrictions:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
performer_blacklist:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
width:
description: Width in meters, used to check the transport box capacity.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
height:
description: Height in meters, used to check the transport box capacity.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.3
length:
description: Length in meters, used to check the transport box capacity.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2.2
rotation:
$ref: '#/components/schemas/table_string_search_field'
description: Possibilities of a cargo rotations type, for an order a list
of types is specified separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: ALL
box_restrictions:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
cargo_features:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
cargo_restrictions:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for an order a list of demand tags is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: A1
demands_count:
description: Demands count.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: false
warnings:
$ref: '#/components/schemas/table_string_search_field'
description: List of warnings by entity.
x-filter-type: STRING_SEARCH
x-default-enabled: false
example: NO_AVAILABLE_TRANSPORT, NO_AVAILABLE_PERFORMER
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
order_status:
$ref: '#/components/schemas/order_status'
x-filter-type: ENUM_LIST
x-default-enabled: false
web_order:
description: Web Order.
type: object
additionalProperties: false
properties:
order:
$ref: '#/components/schemas/order'
fields:
$ref: '#/components/schemas/table_order_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- order
order_cargo_invoice:
description: 'Order cargo invoice. The cargo is addressed by a pair of keys
- the order key and the cargo key inside this order.
'
type: object
additionalProperties: false
properties:
order_key:
$ref: '#/components/schemas/order_key'
description: The key of the order whose cargo is being updated.
cargo_key:
$ref: '#/components/schemas/cargo_key'
description: 'The key of the cargo being updated. A cargo with this key
must already exist in the specified order.
'
invoice:
description: 'New cargo invoice, completely replaces the current one. The
`null` value clears the invoice.
'
oneOf:
- $ref: '#/components/schemas/cargo_invoice'
- $ref: '#/components/schemas/nullable'
required:
- order_key
- cargo_key
- invoice
order_cargo_invoice_list:
description: 'List of cargo invoices for the orders of the dataset. Only already
existing cargoes are updated - new cargoes are not added. If you need to add
or remove cargoes, use the order update function.
'
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/order_cargo_invoice'
default: []
table_order_column_type:
description: "Column name in the table with orders:\n * `ESSENCE_KEY` - entity\
\ key\n * `ENABLED` - participation in calculation\n * `PRISTINE` - data\
\ change flag\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- STATE
- TYPE
- HARD_TIME_WINDOW
- SOFT_TIME_WINDOW
- GENERAL_DROP_TIME_WINDOW
- GENERAL_PICKUP_TIME_WINDOW
- GENERAL_WORK_TIME_WINDOW
- REWARD
- MASS
- VOLUME
- CAPACITY_A
- CAPACITY_B
- CAPACITY_C
- ORDER_FEATURES
- ORDER_RESTRICTIONS
- PERFORMER_RESTRICTIONS
- PERFORMER_BLACKLIST
- WIDTH
- HEIGHT
- LENGTH
- ROTATION
- BOX_RESTRICTIONS
- CARGO_FEATURES
- CARGO_RESTRICTIONS
- DEMANDS_COUNT
- TRIP_KEY
- TRIP_NAME
- NAME
- WARNINGS
- ATTRIBUTES
- CUSTOMFIELDS
- ORDER_STATUS
default: NAME
example: ESSENCE_KEY
table_order_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_order_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_order_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_order_filter'
default: []
table_order:
description: Order (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_order_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_order_fields'
required:
- fields
- elements
table_order_list:
description: Orders table.
type: object
additionalProperties: false
properties:
essences:
description: Orders list.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_order'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
web_order_geopoint:
description: Geopoint for map.
type: object
additionalProperties: false
properties:
geopoint:
$ref: '#/components/schemas/geopoint'
order_key:
$ref: '#/components/schemas/order_key'
demand_key:
$ref: '#/components/schemas/demand_key'
event_key:
$ref: '#/components/schemas/possible_event_key'
demand_type:
$ref: '#/components/schemas/demand_type'
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
trip_name:
$ref: '#/components/schemas/name'
stop_number:
description: Sequence number of the stop in the trip.
type: integer
format: int32
minimum: 0
maximum: 1000
default: 0
example: 10
required:
- geopoint
- order_key
- demand_key
- event_key
- demand_type
web_order_geopoint_list:
description: Geopoints for map.
type: object
additionalProperties: false
properties:
geopoints:
description: A list of points.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/web_order_geopoint'
counters:
$ref: '#/components/schemas/table_list_counters'
description: Counters by list of entities.
geopoints_counters:
$ref: '#/components/schemas/table_list_counters_detail'
description: Counters by list of points.
required:
- geopoints
- counters
- geopoints_counters
table_order_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_order_filter'
default: []
table_order_metrics:
description: General metrics for selected orders.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_order_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_order_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
table_hardlink_fields:
description: Hardlink and element fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- HARDLINK
- ELEMENT
default: HARDLINK
example: HARDLINK
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
element_type:
description: 'Element type. For an hardlink, a list of types is specified
separated by commas.
'
x-filter-type: STRING_SEARCH
x-default-enabled: true
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: ORDER,PERFORMER_SHIFT
elements_count:
description: Elements count.
x-filter-type: INT_RANGE
x-default-enabled: true
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
web_hardlink:
description: Web Hardlink.
type: object
additionalProperties: false
properties:
hardlink:
$ref: '#/components/schemas/hardlink'
fields:
$ref: '#/components/schemas/table_hardlink_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- hardlink
table_hardlink_column_type:
description: 'Hardlink table column name.
'
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- ELEMENT_TYPE
- ELEMENTS_COUNT
- TRIP_KEY
- TRIP_NAME
- CUSTOMFIELDS
default: ESSENCE_KEY
example: ELEMENTS_COUNT
table_hardlink_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_hardlink_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_hardlink_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_hardlink_filter'
default: []
table_hardlink:
description: Hardlink (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_hardlink_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_hardlink_fields'
required:
- fields
- elements
table_hardlink_list:
description: Hardlinks table.
type: object
additionalProperties: false
properties:
essences:
description: Hardlinks list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_hardlink'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
table_hardlink_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_hardlink_filter'
default: []
table_hardlink_metrics:
description: General metrics for selected hardlinks.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_hardlink_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_hardlink_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
basic_verified:
description: A flag indicating whether the entity has been manually verified.
type: boolean
default: false
readOnly: true
example: true
table_trip_fields:
description: Trip\stops fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- TRIP
- ROUNDTRIP
default: TRIP
example: ROUNDTRIP
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
trip_verified:
$ref: '#/components/schemas/basic_verified'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
performer_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
performer_shift_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
transport_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
transport_shift_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
cost:
description: 'Total cost calculated based on the performer''s and transport
tariffs.
'
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 1231.1
reward:
description: The total reward for orders fulfillment.
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 2343.3
profit:
description: 'The total profit is equal to the difference between the total
reward (`reward`) and cost (`cost`).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: -1000000000000
maximum: 1000000000000
default: 0
example: 1231.1
driving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
waiting_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
break_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
rest_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
working_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
arriving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
departure_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
total_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
distance:
description: Distance in meters.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 4000000000
default: 0
example: 5200
time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: true
x-default-sort-direction: ASC
orders_count:
description: The total number of planned and assigned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1700
plan_orders_count:
description: The total number of planned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1003
waitlist_orders_count:
description: The total number of assigned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 697
stops_count:
description: The total number of stops (non-unique locations).
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 87
locations_count:
description: The total number of unique locations within one trip.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 45
cargo_capacity_ratio_mass:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 10
cargo_capacity_ratio_volume:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
cargo_capacity_ratio_capacity_a:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
cargo_capacity_ratio_capacity_b:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
cargo_capacity_ratio_capacity_c:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3
max_transport_load_mass:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_volume:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_a:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_b:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_c:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
average_roundtrip_time:
$ref: '#/components/schemas/time_duration'
description: Average roundtrip time is the ratio of the total time to the
number of roundtrips.
x-filter-type: DURATION_RANGE
x-default-enabled: false
average_roundtrip_distance:
description: Average mileage per roundtrip is the ratio of the total mileage
per trip to the number of roundtrips, in meters.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 23.4
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
trip_status:
$ref: '#/components/schemas/trip_status'
x-filter-type: ENUM_LIST
x-default-enabled: false
crew_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
crew_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
web_trip:
description: Web Trip.
type: object
additionalProperties: false
properties:
trip:
$ref: '#/components/schemas/trip'
trip_statistics:
$ref: '#/components/schemas/trip_statistics'
fields:
$ref: '#/components/schemas/table_trip_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- trip
- trip_statistics
table_trip_column_type:
description: "Column name in the table with trips:\n * `ESSENCE_KEY` - entity\
\ key\n * `ENABLED` - participation in the calculation\n * `PRISTINE` -\
\ data change flag\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- TRIP_VERIFIED
- PRISTINE
- TRIP_NAME
- PERFORMER_KEY
- PERFORMER_SHIFT_KEY
- TRANSPORT_KEY
- TRANSPORT_SHIFT_KEY
- COST
- REWARD
- PROFIT
- DRIVING_TIME
- WAITING_TIME
- BREAK_TIME
- REST_TIME
- WORKING_TIME
- ARRIVING_TIME
- DEPARTURE_TIME
- TOTAL_TIME
- DISTANCE
- TIME_WINDOW
- ORDERS_COUNT
- PLAN_ORDERS_COUNT
- WAITLIST_ORDERS_COUNT
- STOPS_COUNT
- LOCATIONS_COUNT
- CARGO_CAPACITY_RATIO_MASS
- CARGO_CAPACITY_RATIO_VOLUME
- CARGO_CAPACITY_RATIO_CAPACITY_A
- CARGO_CAPACITY_RATIO_CAPACITY_B
- CARGO_CAPACITY_RATIO_CAPACITY_C
- MAX_TRANSPORT_LOAD_MASS
- MAX_TRANSPORT_LOAD_VOLUME
- MAX_TRANSPORT_LOAD_CAPACITY_A
- MAX_TRANSPORT_LOAD_CAPACITY_B
- MAX_TRANSPORT_LOAD_CAPACITY_C
- AVERAGE_ROUNDTRIP_TIME
- AVERAGE_ROUNDTRIP_DISTANCE
- ATTRIBUTES
- CUSTOMFIELDS
- TRIP_STATUS
- CREW_KEY
- CREW_NAME
default: TRIP_NAME
example: DISTANCE
table_trip_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_trip_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_trip_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_trip_filter'
default: []
table_trip:
description: Trip (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_trip_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_trip_fields'
required:
- fields
- elements
table_trip_list:
description: Table list of trips or roundtrips.
type: object
additionalProperties: false
properties:
essences:
description: List of trips or roundtrips.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_trip'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
web_trip_chart_demand:
description: Demand for chart.
type: object
additionalProperties: false
properties:
demand_key:
description: Demand key.
type: string
minLength: 1
maxLength: 1024
example: demand_1
demand_type:
$ref: '#/components/schemas/demand_type'
required:
- demand_key
- demand_type
web_trip_chart:
description: Trip for chart.
type: object
additionalProperties: false
properties:
trip:
$ref: '#/components/schemas/trip'
chart_demands:
description: A list of demands info.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/web_trip_chart_demand'
required:
- trip
- chart_demands
web_trip_chart_list:
description: Trips for chart.
type: object
additionalProperties: false
properties:
charts:
description: Data for chart.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/web_trip_chart'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- charts
- counters
track_type:
description: "Track type:\n * `LINE` - connecting stop points in a straight\
\ line\n * `ROAD` - connecting stop points along roads\n * `CUSTOM` - externally\
\ loaded custom tracks\n"
type: string
enum:
- LINE
- ROAD
- CUSTOM
default: LINE
example: ROAD
track:
description: Track for map.
type: object
additionalProperties: false
properties:
geotrack:
$ref: '#/components/schemas/geotrack'
trip_key:
$ref: '#/components/schemas/trip_key'
trip_name:
$ref: '#/components/schemas/name'
performer_key:
description: Performer's key.
type: string
minLength: 1
maxLength: 1024
example: performer_01
performer_shift_key:
description: Performer shift's key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: performer_shift_01
transport_key:
description: Transport's key.
type: string
minLength: 1
maxLength: 1024
example: transport_01
transport_shift_key:
description: Transport shift's key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: transport_shift_01
required:
- geotrack
- trip_key
- performer_key
- performer_shift_key
- transport_key
- transport_shift_key
track_list:
description: Tracks for map.
type: object
additionalProperties: false
properties:
tracks:
description: A list of tracks.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/track'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- tracks
- counters
track_list_custom:
description: Custom tracks for map.
type: object
additionalProperties: false
properties:
tracks:
description: A list of tracks.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/track'
required:
- tracks
table_trip_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_trip_filter'
default: []
table_trip_metrics:
description: General metrics for selected trips.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_trip_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_trip_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
table_trip_stop_column_type:
description: "Column name in the table with trip stops:\n * `ESSENCE_KEY` -\
\ entity key\n"
type: string
enum:
- ESSENCE_KEY
- DRIVING_TIME
- WAITING_TIME
- BREAK_TIME
- REST_TIME
- WORKING_TIME
- ARRIVING_TIME
- DEPARTURE_TIME
- TOTAL_TIME
- DISTANCE
- TIME_WINDOW
- TRIP_KEY
- ORDER_KEY
- DEMAND_TYPE
- LOCATION_NAME
- LOCATION_KEY
- ATTRIBUTES
- CUSTOMFIELDS
default: ESSENCE_KEY
example: LOCATION_NAME
table_trip_stop_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_trip_stop_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_trip_stop_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_trip_stop_filter'
default: []
table_trip_stop_fields:
description: Tabular fields of stops for a single trip.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- TRIP_STOP
- DEMAND
default: TRIP_STOP
example: TRIP_STOP
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
driving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: true
waiting_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
break_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
rest_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
working_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
arriving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
departure_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
total_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
distance:
description: Distance in meters.
x-filter-type: INT_RANGE
x-default-enabled: true
type: integer
format: int32
minimum: 0
maximum: 4000000000
default: 0
example: 5200
time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: false
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
order_key:
$ref: '#/components/schemas/table_string_search_field'
description: Order key, for trip stop a list of order keys separated by
commas is specified.
x-filter-type: STRING_SEARCH
x-default-enabled: true
example: order01
demand_type:
$ref: '#/components/schemas/table_string_search_field'
description: Demand type, for a trip stop a list of demand types is specified
separated by commas.
x-filter-type: STRING_SEARCH
x-default-enabled: true
example: WORK
location_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
location_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
description: Custom table fields - LOCATION attributes are used.
table_trip_stop:
description: Trip stop (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_trip_stop_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_trip_stop_fields'
required:
- fields
- elements
table_trip_stop_list:
description: Trip stops table.
type: object
additionalProperties: false
properties:
essences:
description: Trip stops list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_trip_stop'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
table_roundtrip_column_type:
description: "Column name in the table with roundtrips:\n * `ESSENCE_KEY` -\
\ entity key\n * `ENABLED` - participation in the calculation\n * `PRISTINE`\
\ - data change flag\n"
type: string
enum:
- ESSENCE_KEY
- ENABLED
- TRIP_KEY
- PRISTINE
- TRIP_NAME
- COST
- REWARD
- PROFIT
- DRIVING_TIME
- WAITING_TIME
- BREAK_TIME
- REST_TIME
- WORKING_TIME
- ARRIVING_TIME
- DEPARTURE_TIME
- TOTAL_TIME
- DISTANCE
- TIME_WINDOW
- ORDERS_COUNT
- PLAN_ORDERS_COUNT
- WAITLIST_ORDERS_COUNT
- STOPS_COUNT
- LOCATIONS_COUNT
- CARGO_CAPACITY_RATIO_MASS
- CARGO_CAPACITY_RATIO_VOLUME
- CARGO_CAPACITY_RATIO_CAPACITY_A
- CARGO_CAPACITY_RATIO_CAPACITY_B
- CARGO_CAPACITY_RATIO_CAPACITY_C
- MAX_TRANSPORT_LOAD_MASS
- MAX_TRANSPORT_LOAD_VOLUME
- MAX_TRANSPORT_LOAD_CAPACITY_A
- MAX_TRANSPORT_LOAD_CAPACITY_B
- MAX_TRANSPORT_LOAD_CAPACITY_C
- ATTRIBUTES
- CUSTOMFIELDS
default: TRIP_NAME
example: DISTANCE
table_roundtrip_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_roundtrip_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_roundtrip_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_roundtrip_filter'
default: []
table_roundtrip_fields:
description: Table fields for roundtrips.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- TRIP
- ROUNDTRIP
default: TRIP
example: ROUNDTRIP
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
cost:
description: 'Total cost calculated based on the performer''s and transport
tariffs.
'
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 1231.1
reward:
description: The total reward for orders fulfillment.
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: 0
maximum: 1000000000000
default: 0
example: 2343.3
profit:
description: 'The total profit is equal to the difference between the total
reward (`reward`) and cost (`cost`).
'
x-filter-type: FLOAT_RANGE
x-default-enabled: true
type: number
format: double
minimum: -1000000000000
maximum: 1000000000000
default: 0
example: 1231.1
driving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
waiting_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
break_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
rest_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
working_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
arriving_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
departure_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
total_time:
$ref: '#/components/schemas/time_duration'
x-filter-type: DURATION_RANGE
x-default-enabled: false
distance:
description: Distance in meters.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 4000000000
default: 0
example: 5200
time_window:
description: Time window.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
x-filter-type: DATETIME_RANGE
x-default-enabled: true
x-default-sort-direction: ASC
orders_count:
description: The total number of planned and assigned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1700
plan_orders_count:
description: The total number of planned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 1003
waitlist_orders_count:
description: The total number of assigned orders.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 697
stops_count:
description: The total number of stops (non-unique locations).
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 87
locations_count:
description: The total number of unique locations within one trip.
x-filter-type: INT_RANGE
x-default-enabled: false
type: integer
format: int32
minimum: 0
maximum: 15001
default: 0
example: 45
cargo_capacity_ratio_mass:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 10
cargo_capacity_ratio_volume:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
cargo_capacity_ratio_capacity_a:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 1
cargo_capacity_ratio_capacity_b:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 2
cargo_capacity_ratio_capacity_c:
description: The ratio of the total additive measures of the transported
cargo to the total capacity of the boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 3
max_transport_load_mass:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_volume:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_a:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_b:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
max_transport_load_capacity_c:
description: The ratio of the maximum load of boxes to the total capacity
of boxes.
x-filter-type: FLOAT_RANGE
x-default-enabled: false
type: number
format: double
minimum: 0
maximum: 1000000
default: 0
example: 0.1
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
table_roundtrip:
description: Roundtrip (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_roundtrip_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_roundtrip_fields'
required:
- fields
- elements
table_roundtrip_list:
description: Table list of roundtrips.
type: object
additionalProperties: false
properties:
essences:
description: List of roundtrips.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_roundtrip'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
table_roundtrip_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_roundtrip_filter'
default: []
table_roundtrip_metrics:
description: General metrics for selected roundtrips.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_roundtrip_fields'
description: 'Total values for fields of types int, double, duration.
'
fields_avg:
$ref: '#/components/schemas/table_roundtrip_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
table_fact_fields:
description: Fact fields for table.
type: object
additionalProperties: false
readOnly: true
properties:
essence_type:
description: Essence type.
type: string
enum:
- FACT
default: FACT
example: FACT
essence_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
x-default-sort-direction: ASC
enabled:
$ref: '#/components/schemas/basic_enabled'
x-filter-type: BOOL_LIST
x-default-enabled: false
pristine:
$ref: '#/components/schemas/basic_pristine'
x-filter-type: BOOL_LIST
x-default-enabled: false
type:
description: Fact type.
x-filter-type: STRING_SEARCH
x-default-enabled: true
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 64
example: GEOTRACK_UPDATED
creation_date:
description: Fact creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type:
- string
- 'null'
default: null
format: date-time
x-filter-type: DATETIME_RANGE
x-default-enabled: true
example: '2026-09-21T09:30:00+03:00'
reception_date:
description: Fact reception date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type:
- string
- 'null'
default: null
format: date-time
x-filter-type: DATETIME_RANGE
x-default-enabled: false
example: '2026-09-21T09:33:00+03:00'
execution_date:
description: Fact execution date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type:
- string
- 'null'
default: null
format: date-time
x-filter-type: DATETIME_RANGE
x-default-enabled: false
example: '2026-09-21T09:35:00+03:00'
status:
$ref: '#/components/schemas/fact_status'
x-filter-type: ENUM_LIST
x-default-enabled: true
trip_key:
$ref: '#/components/schemas/basic_essence_key_null'
x-filter-type: STRING_SEARCH
x-default-enabled: true
trip_name:
$ref: '#/components/schemas/name'
x-filter-type: STRING_SEARCH
x-default-enabled: true
attributes:
$ref: '#/components/schemas/table_attributes'
x-filter-type: STRING_SEARCH
x-default-enabled: false
customfields:
$ref: '#/components/schemas/table_customfields'
web_fact:
description: Web Fact.
type: object
additionalProperties: false
properties:
fact:
$ref: '#/components/schemas/fact'
fields:
$ref: '#/components/schemas/table_fact_fields'
linked_essences:
$ref: '#/components/schemas/linked_essence_list'
required:
- fact
table_fact_column_type:
description: 'Fact table column name.
'
type: string
enum:
- ESSENCE_KEY
- ENABLED
- PRISTINE
- TYPE
- CREATION_DATE
- RECEPTION_DATE
- EXECUTION_DATE
- STATUS
- TRIP_KEY
- TRIP_NAME
- CUSTOMFIELDS
example: ESSENCE_KEY
table_fact_filter:
description: Universal filter for table.
type: object
additionalProperties: false
readOnly: true
properties:
type:
$ref: '#/components/schemas/table_filter_type'
column:
$ref: '#/components/schemas/table_fact_column_type'
custom_column:
description: User column.
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
datetime_range:
description: Time window filter.
oneOf:
- $ref: '#/components/schemas/table_filter_datetime_range'
- $ref: '#/components/schemas/nullable'
default: null
int_range:
description: Integer range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_int_range'
- $ref: '#/components/schemas/nullable'
default: null
float_range:
description: Float range filter.
oneOf:
- $ref: '#/components/schemas/table_filter_float_range'
- $ref: '#/components/schemas/nullable'
default: null
duration_range:
description: Duration range.
oneOf:
- $ref: '#/components/schemas/table_filter_duration_range'
- $ref: '#/components/schemas/nullable'
default: null
bool_list:
description: Boolean list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_bool_list'
- $ref: '#/components/schemas/nullable'
default: null
enum_list:
description: Enum list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_enum_list'
- $ref: '#/components/schemas/nullable'
default: null
string_list:
description: String list filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_list'
- $ref: '#/components/schemas/nullable'
default: null
string_search:
description: String search filter.
oneOf:
- $ref: '#/components/schemas/table_filter_string_search'
- $ref: '#/components/schemas/nullable'
default: null
required:
- type
- column
table_fact_filter_list:
description: A list of filters.
type: object
additionalProperties: false
properties:
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_fact_filter'
default: []
table_fact:
description: Fact (table).
type: object
additionalProperties: false
properties:
fields:
$ref: '#/components/schemas/table_fact_fields'
elements:
description: List of nested elements.
type: array
uniqueItems: false
minItems: 0
maxItems: 15001
items:
$ref: '#/components/schemas/table_fact_fields'
required:
- fields
- elements
table_fact_list:
description: Facts table.
type: object
additionalProperties: false
properties:
essences:
description: Facts list.
type: array
uniqueItems: false
minItems: 0
maxItems: 2001
items:
$ref: '#/components/schemas/table_fact'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- essences
- counters
table_fact_metrics_filter_list:
description: 'Data for calculating metrics. If entity keys are specified, metrics
are calculated by them. If keys are not specified, metrics are calculated
by all entities that fall under the filters.
'
type: object
additionalProperties: false
properties:
keys:
$ref: '#/components/schemas/basic_essence_key_list'
description: A list of keys.
filters:
description: A list of filters.
type: array
uniqueItems: false
minItems: 0
maxItems: 50
items:
$ref: '#/components/schemas/table_fact_filter'
default: []
table_fact_metrics:
description: General metrics for selected facts.
type: object
additionalProperties: false
properties:
fields_sum:
$ref: '#/components/schemas/table_fact_fields'
description: Total values for fields of types int, double, duration.
fields_avg:
$ref: '#/components/schemas/table_fact_fields'
description: 'Average values for fields of types int, double, duration.
Only fields that have a value are taken into account to calculate the
average.
'
counters:
$ref: '#/components/schemas/table_list_counters'
required:
- counters
batch_key:
description: The key of the batch with facts.
type: string
minLength: 1
maxLength: 256
example: batch_1199
batch_status:
description: "Fact batch processing status:\n * `UNKNOWN` - batch not found,\
\ status unknown\n * `QUEUED` - received and queued for writing\n * `PERSISTED`\
\ - received and written\n"
type: string
enum:
- UNKNOWN
- QUEUED
- PERSISTED
default: UNKNOWN
example: PERSISTED
tracker_key:
description: Tracking tag key.
type: string
minLength: 10
maxLength: 1024
example: track-number-for-order-101
tracker_demand:
description: Tracked demand information.
type: object
additionalProperties: false
properties:
demand_type:
$ref: '#/components/schemas/demand_type'
work_time_window:
description: Planned time window for the start and end of work on the demand
on the location.
oneOf:
- $ref: '#/components/schemas/time_window'
- $ref: '#/components/schemas/nullable'
default: null
required:
- demand_type
- work_time_window
tracker_demand_list:
description: List of tracked demands.
type: array
uniqueItems: false
minItems: 0
maxItems: 1000
items:
$ref: '#/components/schemas/tracker_demand'
tracker_block_type:
description: "Block type on the order tracking page:\n * `DEMANDS` - list of\
\ order demands with planned time windows\n * `CARGOS` - list of order cargos\n\
\ * `MAP` - map with the current performer location\n"
type: string
enum:
- DEMANDS
- CARGOS
- MAP
example: CARGOS
tracker_translation:
description: Translations for tracker widget.
type: object
additionalProperties: false
properties:
key:
description: Translation's key.
type: string
minLength: 1
maxLength: 100
example: code
value:
description: Translation's value.
type: string
minLength: 0
maxLength: 200
example: Перевод
required:
- key
- value
tracker_settings:
description: Order tracking page appearance settings.
type: object
additionalProperties: false
properties:
primary_color:
description: Primary theme color, in CSS format.
type:
- string
- 'null'
default: null
minLength: 3
maxLength: 40
example: '#1a73e8'
background_color:
description: Page background color, in CSS format.
type:
- string
- 'null'
minLength: 3
maxLength: 40
default: null
example: '#ffffff'
font_color:
description: Text color, in CSS format.
type:
- string
- 'null'
minLength: 3
maxLength: 40
default: null
example: '#202124'
corner_rounding:
description: Rounding the corners of elements.
type: integer
default: 0
minimum: 0
maximum: 100
example: 8
text_weight:
description: 'Font weight of the body text, in CSS `font-weight` format
- numeric (`400`) or keyword (`normal`).
'
type:
- string
- 'null'
minLength: 3
maxLength: 20
default: null
example: '400'
header_weight:
description: 'Font weight of the headers, in CSS `font-weight` format -
numeric (`700`) or keyword (`bold`).
'
type:
- string
- 'null'
minLength: 3
maxLength: 20
default: null
example: '700'
logo:
description: Logo - image link or data URI.
type:
- string
- 'null'
minLength: 10
maxLength: 10000
default: null
example: https://veeroute.cloud/assets/icons/logo-vrt.svg
blocks:
description: 'List of blocks displayed on the tracking page. If the list
is not specified, only the order name and its status are displayed.
'
type: array
minItems: 0
maxItems: 3
uniqueItems: true
items:
$ref: '#/components/schemas/tracker_block_type'
example:
- DEMANDS
- CARGOS
translations:
description: Translations.
type: array
uniqueItems: true
minItems: 0
maxItems: 250
items:
$ref: '#/components/schemas/tracker_translation'
default: []
tracker_order_info:
description: Tracked order information.
type: object
additionalProperties: false
properties:
order_status:
$ref: '#/components/schemas/order_status'
order_name:
$ref: '#/components/schemas/name'
demands:
$ref: '#/components/schemas/tracker_demand_list'
cargos:
$ref: '#/components/schemas/cargo_list'
settings:
$ref: '#/components/schemas/tracker_settings'
required:
- order_status
- demands
settings_key:
description: Settings key, unique identifier.
type: string
minLength: 1
maxLength: 1024
example: path-key-01
settings_key_null:
description: Settings key (nullable), unique identifier.
type:
- string
- 'null'
default: null
minLength: 1
maxLength: 1024
example: path-key-01
settings_key_list:
description: List of setting keys with indicating the key of the currently active
setting.
type: object
additionalProperties: false
readOnly: true
properties:
settings_keys:
description: List of setting keys.
type: array
uniqueItems: true
minItems: 0
maxItems: 10
items:
$ref: '#/components/schemas/settings_key'
active_key:
$ref: '#/components/schemas/settings_key_null'
description: 'Key of the currently active setting. A key from the `settings_keys`
list, or null (if there is no active setting).
'
required:
- settings_keys
analytics_chart_type:
description: "Chart type:\n * `ORDERS_COUNT_TOTAL` - total number of orders\n\
\ * `ORDERS_COUNT_DELIVERED` - number of delivered orders\n * `ORDERS_COUNT_CANCELED`\
\ - number of canceled orders\n * `ORDERS_COUNT_ON_TIME` - number of orders\
\ delivered on time\n * `ORDERS_COUNT_LATE` - number of orders delivered\
\ late\n * `ORDERS_COUNT_EARLY` - number of orders delivered before the time\
\ window\n * `ORDERS_COUNT_IN_PROGRESS` - number of orders in progress\n\
\ * `ORDERS_COUNT_WILL_BE_ON_TIME` - number of orders that will be delivered\
\ on time\n * `ORDERS_COUNT_WILL_BE_LATE` - number of orders that will be\
\ delivered late\n * `ORDERS_PERCENT_DELIVERED` - percentage of delivered\
\ orders\n * `ORDERS_PERCENT_CANCELED` - percentage of canceled orders\n\
\ * `CREWS_COUNT_TOTAL` - total number of crews\n * `CREWS_COUNT_ONLINE`\
\ - number of online crews\n * `CREWS_PERCENT_ONLINE` - online percentage\
\ (total number of online performers / total)\n * `CREWS_PERCENT_LOCATION_QUALITY`\
\ - location-quality percentage (total number of performers without problems\
\ / total)\n * `TIME_TOTAL_LATE` - total estimated late time across all orders\n\
\ * `TIME_TOTAL_EARLY` - total estimated early time across all orders\n \
\ * `TIME_DELIVERY_WITHIN_WINDOW` - percentage of deliveries within the time\
\ window\n * `TIME_DELIVERY_OUTSIDE_WINDOW` - percentage of deliveries outside\
\ the time window\n * `PRODUCTIVITY_OVERALL` - overall productivity (orders\
\ / crews)\n * `PRODUCTIVITY_ASSIGNED` - assigned productivity (assigned\
\ orders / crews)\n * `PRODUCTIVITY_COMPLETED` - completed productivity (completed\
\ orders / crews)\n"
type: string
enum:
- ORDERS_COUNT_TOTAL
- ORDERS_COUNT_DELIVERED
- ORDERS_COUNT_CANCELED
- ORDERS_COUNT_ON_TIME
- ORDERS_COUNT_LATE
- ORDERS_COUNT_EARLY
- ORDERS_COUNT_IN_PROGRESS
- ORDERS_COUNT_WILL_BE_ON_TIME
- ORDERS_COUNT_WILL_BE_LATE
- ORDERS_PERCENT_DELIVERED
- ORDERS_PERCENT_CANCELED
- CREWS_COUNT_TOTAL
- CREWS_COUNT_ONLINE
- CREWS_PERCENT_ONLINE
- CREWS_PERCENT_LOCATION_QUALITY
- TIME_TOTAL_LATE
- TIME_TOTAL_EARLY
- TIME_DELIVERY_WITHIN_WINDOW
- TIME_DELIVERY_OUTSIDE_WINDOW
- PRODUCTIVITY_OVERALL
- PRODUCTIVITY_ASSIGNED
- PRODUCTIVITY_COMPLETED
default: ORDERS_COUNT_TOTAL
example: ORDERS_COUNT_DELIVERED
analytics_element_value:
description: Value in the specified time.
type: integer
format: int32
minimum: -1000000000
maximum: 1000000000
example: 57
analytics_element_type:
description: "Chart type:\n * `HISTORY` - history\n * `FORECAST` - forecast\n"
type: string
enum:
- HISTORY
- FORECAST
example: FORECAST
analytics_element:
description: Analytics element.
type: object
additionalProperties: false
properties:
time:
description: Date and time of data slice in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format.
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
value:
$ref: '#/components/schemas/analytics_element_value'
type:
$ref: '#/components/schemas/analytics_element_type'
required:
- time
- value
- type
analytics_element_list:
description: Elements list.
type: array
uniqueItems: false
minItems: 0
maxItems: 3000
items:
$ref: '#/components/schemas/analytics_element'
default: []
analytics_metrics:
description: Data slice by one wave.
type: object
additionalProperties: false
properties:
wave_key:
$ref: '#/components/schemas/unique_key'
wave_name:
$ref: '#/components/schemas/file_name'
elements:
$ref: '#/components/schemas/analytics_element_list'
required:
- wave_key
- wave_name
- elements
analytics_metrics_list:
description: A list of metrics.
type: array
uniqueItems: false
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/analytics_metrics'
analytics_threshold_type:
description: "Result type:\n * `ERROR` - error\n * `WARNING` - warning\n \
\ * `SUCCESS` - success\n"
type: string
enum:
- ERROR
- WARNING
- SUCCESS
example: SUCCESS
analytics_threshold:
description: Threshold value.
type: object
additionalProperties: false
properties:
from:
$ref: '#/components/schemas/analytics_element_value'
to:
$ref: '#/components/schemas/analytics_element_value'
type:
$ref: '#/components/schemas/analytics_threshold_type'
required:
- from
- to
- type
analytics_threshold_list:
description: Threshold list.
type: array
uniqueItems: false
minItems: 0
maxItems: 3
items:
$ref: '#/components/schemas/analytics_threshold'
default: []
analytics_chart:
description: Chart.
type: object
additionalProperties: false
properties:
type:
$ref: '#/components/schemas/analytics_chart_type'
metrics:
$ref: '#/components/schemas/analytics_metrics_list'
thresholds:
$ref: '#/components/schemas/analytics_threshold_list'
required:
- type
- metrics
analytics_chart_list:
description: A list of charts.
type: array
uniqueItems: false
minItems: 0
maxItems: 10
items:
$ref: '#/components/schemas/analytics_chart'
analytics_overview:
description: Analytics overview.
type: object
additionalProperties: false
properties:
charts:
$ref: '#/components/schemas/analytics_chart_list'
required:
- charts
report_type:
description: "Report type:\n * `TYPE_1` - report form 1\n * `TYPE_2` - report\
\ form 2\n"
type: string
enum:
- TYPE_1
- TYPE_2
default: TYPE_1
example: TYPE_2
translations:
description: Name in different languages.
type: object
additionalProperties: false
properties:
ru:
$ref: '#/components/schemas/name'
description: Translation into Russian.
example: Название на Русском языке
en:
$ref: '#/components/schemas/name'
description: Translation into English.
example: Name in English
scenario_job:
description: Job.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/basic_essence_key'
description: 'Custom job key. Unique in one scenario.
'
translations:
$ref: '#/components/schemas/translations'
group_key:
$ref: '#/components/schemas/basic_essence_key_null'
description: 'The grouping key to which the job belongs. If the group key
is the same for several jobs and these jobs are at the same location,
then these jobs will be displayed in one group on the interface.
'
depends_on:
description: 'A list of job keys that this job depends on. If specified,
then this job cannot be performed until all jobs in the list are completed.
'
type: array
uniqueItems: true
minItems: 0
maxItems: 10
items:
$ref: '#/components/schemas/basic_essence_key'
required:
- key
- translations
scenario_job_list:
description: A list of jobs that need to be performed as part of the scenario.
type: array
uniqueItems: false
minItems: 1
maxItems: 100
items:
$ref: '#/components/schemas/scenario_job'
scenario:
description: Scenario.
type: object
additionalProperties: false
properties:
key:
$ref: '#/components/schemas/basic_essence_key'
description: 'Custom scenario key. Unique for one company.
'
jobs:
$ref: '#/components/schemas/scenario_job_list'
required:
- key
- jobs
user_settings:
description: User settings.
type: object
additionalProperties: true
example:
key1: value1
customfield_entity_type:
description: 'Entity type. Defines the source object with attributes and the
target table.
'
type: string
enum:
- LOCATION
- ORDER
- DEMAND
- PERFORMER
- PERFORMER_SHIFT
- TRANSPORT
- TRANSPORT_SHIFT
- HARDLINK
- TRIP
- ROUNDTRIP
- FACT
- TRIP_STOP
example: LOCATION
customfield_convert_rule:
description: Rule for converting a custom field from an attribute.
type: object
additionalProperties: false
readOnly: true
properties:
entity_type:
$ref: '#/components/schemas/customfield_entity_type'
source_attribute_key:
description: The attribute key whose value will be written to the specified
custom field.
type: string
minLength: 1
maxLength: 100
example: attribute_name
target_customfield:
description: Customfield
oneOf:
- $ref: '#/components/schemas/table_customfields_column_type'
- $ref: '#/components/schemas/nullable'
default: null
translations:
$ref: '#/components/schemas/translations'
required:
- entity_type
- source_attribute_key
- target_customfield
customfields_settings:
description: Custom fields settings.
type: object
additionalProperties: false
readOnly: true
properties:
rules:
description: List of rules for converting custom fields.
type: array
uniqueItems: true
minItems: 0
maxItems: 100
items:
$ref: '#/components/schemas/customfield_convert_rule'
required:
- rules
check_result:
description: Service availability result.
type: object
additionalProperties: false
properties:
health:
description: "The current health indicator of the service.\n * `0.0` means\
\ the service is not ready to perform tasks.\n * `1.0` means the service\
\ is fully ready to perform tasks.\n"
type: number
format: double
minimum: 0
maximum: 1
example: 0.999
required:
- health
version_result:
description: Service version.
type: object
additionalProperties: false
properties:
major:
description: '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).
'
type: integer
format: int32
minimum: 1
maximum: 100
example: 7
minor:
description: 'Minor version of the service.
A version change indicates new functionality.
The update is backward compatible with the major version of the service.
'
type: integer
format: int32
minimum: 0
maximum: 111
example: 15
build:
description: "Build version. \nContains backwards compatible bug fixes\
\ and docs update.\n"
type: string
minLength: 1
maxLength: 64
example: 3754RC
required:
- major
- minor
- build
file_html:
description: File with data in [HTML](https://html.spec.whatwg.org/) format.
type: string
minLength: 0
maxLength: 2000000000
file_json:
description: File with data in [JSON](https://www.json.org/) format.
type: string
minLength: 0
maxLength: 2000000000
parameters:
folder_key:
name: folder_key
description: Folder key, unique identifier.
in: query
required: false
schema:
$ref: '#/components/schemas/unique_key'
filter:
name: filter
description: Filter for searching by text fields.
in: query
required: false
schema:
description: Filter for searching by text fields.
type: string
minLength: 1
maxLength: 64
example: example text
offset:
name: offset
description: The number of items to skip before starting to collect the result
set.
in: query
required: false
schema:
description: The number of items to skip before starting to collect the result
set.
type: integer
format: int32
minimum: 0
maximum: 10000000
default: 0
example: 10
limit:
name: limit
description: The number of items to return.
in: query
required: false
schema:
description: The number of items to return.
type: integer
format: int32
minimum: 1
maximum: 2001
default: 100
example: 10
filesystem_column:
name: sort_field
description: 'The name of the column in the table with folders.
'
in: query
required: false
schema:
$ref: '#/components/schemas/filesystem_column_type'
sort_direction:
name: sort_direction
description: Sort direction.
in: query
required: false
schema:
description: Sort direction.
type: string
enum:
- ASC
- DESC
default: ASC
example: DESC
target_folder_key:
name: target_folder_key
description: Folder key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/unique_key'
crew_key:
name: crew_key
description: Parameter (path) with crew key.
in: path
required: true
schema:
$ref: '#/components/schemas/crew_key'
table_crew_column:
name: sort_field
description: 'Crew table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_crew_column_type'
deal_key:
name: deal_key
description: Key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/unique_key'
file_key:
name: file_key
description: File key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/unique_key'
essence_key:
name: essence_key
description: Key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/basic_essence_key'
store_key:
name: store_key
description: Key of binary file uploaded to the store.
in: query
required: true
schema:
$ref: '#/components/schemas/store_key'
table_wave_column:
name: sort_field
description: 'Wave table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_wave_column_type'
filter_required:
name: filter
description: String for searching by text fields.
in: query
required: true
schema:
description: String for searching by text fields.
type: string
minLength: 3
maxLength: 128
example: example text
subscription_key:
name: subscription_key
description: Parameter (path) with the wave data changes subscription key.
in: path
required: true
schema:
$ref: '#/components/schemas/subscription_key'
timezone:
name: timezone
description: Target time zone.
in: query
required: false
schema:
$ref: '#/components/schemas/timezone'
table_location_column:
name: sort_field
description: 'Locations table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_location_column_type'
table_custom_column:
name: sort_customfield
description: 'The name of the additional column in the table.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_customfields_column_type'
table_performer_column:
name: sort_field
description: 'Performers table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_performer_column_type'
table_transport_column:
name: sort_field
description: 'Transport table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_transport_column_type'
table_order_column:
name: sort_field
description: 'Order table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_order_column_type'
table_hardlink_column:
name: sort_field
description: 'Hardlink table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_hardlink_column_type'
table_trip_column:
name: sort_field
description: 'Trip table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_trip_column_type'
tracks_type:
name: tracks_type
description: "Tracks type:\n * `LINE` - connecting stop points in a straight\
\ line\n * `ROAD` - connecting stop points along roads\n * `EXTERNAL` -\
\ externally loaded custom tracks\n"
in: path
required: true
schema:
$ref: '#/components/schemas/track_type'
table_trip_stop_column:
name: sort_field
description: 'Trip stops table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_trip_stop_column_type'
table_roundtrip_column:
name: sort_field
description: 'Trip table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_roundtrip_column_type'
table_fact_column:
name: sort_field
description: 'Fact table column name.
'
in: query
required: false
schema:
$ref: '#/components/schemas/table_fact_column_type'
batch_key:
name: batch_key
description: Parameter with fact batch key.
in: query
required: false
schema:
$ref: '#/components/schemas/batch_key'
batch_key_required:
name: batch_key
description: Parameter with fact batch key.
in: query
required: true
schema:
$ref: '#/components/schemas/batch_key'
tracker_key:
name: tracker_key
description: Tracker tag.
in: path
required: true
schema:
$ref: '#/components/schemas/tracker_key'
settings_key:
name: settings_key
description: User settings key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/settings_key'
datetime_from:
name: from
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format. If no datetime is specified, audit data are returned from the beginning
of the day.
'
in: query
required: false
schema:
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format. If no datetime is specified, audit data are returned from the beginning
of the day.
'
type: string
format: date-time
example: '2026-09-21T09:30:00+03:00'
datetime_to:
name: to
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format. If not specified, data up to the current time is returned.
'
in: query
required: false
schema:
description: 'Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6)
format. If not specified, data up to the current time is returned.
'
type: string
format: date-time
example: '2026-09-21T18:00:00+03:00'
report_type:
name: report_type
description: Report type.
in: query
required: true
schema:
$ref: '#/components/schemas/report_type'
scenario_key:
name: scenario_key
description: User scenario key, unique identifier.
in: path
required: true
schema:
$ref: '#/components/schemas/basic_essence_key'
filename:
name: filename
description: File name.
in: path
required: true
schema:
description: File name.
type: string
minLength: 6
maxLength: 128
example: file_en.html
responses:
'400':
description: Bad request - input data contains errors
content:
application/json:
schema:
$ref: '#/components/schemas/general_400'
'401':
description: Unauthorized - incorrect authorization details, token is missing
or invalid
'402':
description: Payment Required
content:
application/json:
schema:
$ref: '#/components/schemas/general_402'
'403':
description: Forbidden - no permission to execute this operation
content:
application/json:
schema:
$ref: '#/components/schemas/general_403'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/general_404'
'405':
description: Method not allowed, check method (POST, GET, ...)
'406':
description: Client is unable to process a format of response, check headers
'415':
description: Unsupported media type, check headers
'429':
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/general_429'
'431':
description: Request header fields too large
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/general_500'
'501':
description: Not implemented
'502':
description: Bad gateway
'503':
description: Service unavailable
'504':
description: Gateway timeout
400_with_errors_and_warnings:
description: Bad request - data contain errors
content:
application/json:
schema:
$ref: '#/components/schemas/universal_400_with_errors_and_warnings'
examples:
Result400:
$ref: '#/components/examples/Result400'
examples:
DataExplorer:
summary: Virtual filesystem example
value:
folders:
- key: 2bff0b86-2ddc-445c-9d98-f75ca2eec091
parent_key: 65fb88e5-128d-4f3f-9a50-4c2754adcbed
name: My Folder
owner_company_key: veeroute
owner_username: username_1
comment: long text
counters:
folders_count: 0
files_count: 3
counters:
overall:
total: 20
filter:
total: 1
FilterList:
summary: Filter list
value:
filters:
- type: STRING_SEARCH
column: ESSENCE_KEY
string_search:
text: key01
strict: false
Result400:
summary: Errors in data
value:
tracedata:
process_code: 11111111-2222-3333-4444-555555555555
request_code: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
username: example_username
company: example_company
env: edge7
pod: aaaaaaaa-2222-cccc-4444-eeeeeeeeeeee
service: UNIVERSAL
operation: run_plan_calculation
time: '2026-09-28T17:13:27.945583194Z'
message: logical error detail
schema_errors: []
logical_errors:
- type: UNIQUE_IDS_VIOLATION
entities:
- entity_key: order_1
entity_type: ORDER
warnings: []
Wave:
summary: Wave example
value:
key: da4e62b0-86cb-4423-b187-5c1a633ca703
specification:
name: new wave 3000
comment: just run it
folder_key: 2bff0b86-2ddc-445c-9d98-f75ca2eec091
settings:
plan_settings:
trips_settings:
configuration: default
assumptions:
disable_compatibility: false
disable_capacity: false
same_order_time_window: false
expand_shift_time_window: false
penalties:
compatibilities: []
geo_settings:
geo_provider: VRT
toll_roads: true
ferry_crossing: true
traffic_jams: true
flight_distance: false
calculation_settings:
max_calculation_time: PT20M
max_waiting_time: PT30M
result_ttl: PT20M
result_timezone: 0
treat_warnings_as_errors: false
precision: 2
actualize_settings:
current_time: '2026-09-07T22:30:00Z'
max_delay_duration: PT1H
replan_settings:
replan_strategy:
reorder: true
plan_new_orders: true
create_new_trips: true
statistics:
indicators:
- data_statistics_hardlinks
- data_statistics_locations
- data_statistics_orders
- data_statistics_performers
- data_statistics_transports
- data_statistics_trips
- data_statistics_facts
- total_statistics_max_transport_load_capacity_a
- total_statistics_max_transport_load_capacity_b
- total_statistics_max_transport_load_capacity_c
- total_statistics_max_transport_load_mass
- total_statistics_max_transport_load_volume
- total_statistics_cargo_capacity_ratio_capacity_a
- total_statistics_cargo_capacity_ratio_capacity_b
- total_statistics_cargo_capacity_ratio_capacity_c
- total_statistics_cargo_capacity_ratio_mass
- total_statistics_cargo_capacity_ratio_volume
- total_statistics_cost
- total_statistics_measurements_arriving_time
- total_statistics_measurements_departure_time
- total_statistics_measurements_distance
- total_statistics_measurements_driving_time
- total_statistics_measurements_time_window_from
- total_statistics_measurements_time_window_to
- total_statistics_measurements_total_time
- total_statistics_measurements_waiting_time
- total_statistics_measurements_working_time
- total_statistics_orders_count
- total_statistics_performers_count
- total_statistics_plan_orders_count
- quality_hard_time_window_violations_after_count
- quality_hard_time_window_violations_before_count
- quality_soft_time_window_violations_after_count
- quality_soft_time_window_violations_before_count
- total_statistics_reward
- total_statistics_waitlist_orders_count
total_statistics:
profit: 1
cost: 0
reward: 0
measurements:
driving_time: P0D
waiting_time: P0D
break_time: P0D
rest_time: PT0S
working_time: P0D
arriving_time: P0D
departure_time: P0D
total_time: P0D
distance: 0
time_window:
from: '2026-09-15T13:56:07.697Z'
to: '2026-09-15T13:56:07.697Z'
performers_count: 0
trips_count: 0
orders_count: 0
plan_orders_count: 0
waitlist_orders_count: 0
stops_count: 1
locations_count: 1
average_speed: 45.2
round_trips_count: 1
cargo_capacity_sum:
mass: 1.9
volume: 2
capacity_a: 3
capacity_b: 1
capacity_c: 1
cargo_capacity_ratio:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_transport_load:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
quality:
locations_limits_penalty: 0
soft_time_window_violations:
before:
demand_keys: []
count: 0
after:
demand_keys: []
count: 0
hard_time_window_violations:
before:
demand_keys: []
count: 0
after:
demand_keys: []
count: 0
task_statistics:
planning_horizon:
from: '2026-09-21T09:30:00+03:00'
to: '2026-09-21T19:45:00Z'
data_statistics:
locations: 958
orders: 1000
performers: 1000
transports: 1000
hardlinks: 0
trips: 0
facts: 1
external_routing: false
status: ACTIVE
edit_date: '2026-09-15T13:56:07.728Z'
creation_date: '2026-09-15T13:56:07.728Z'
TableWaveList:
summary: Waves list (table)
value:
essences:
- fields:
essence_key: wave1
specification_folder_key: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
counters:
overall:
total: 1
filter:
total: 1
ExperimentSettings:
summary: Experiment settings
value:
plan_settings:
trips_settings:
configuration: default
assumptions:
disable_compatibility: false
disable_capacity: false
same_order_time_window: false
expand_shift_time_window: false
penalties:
compatibilities: []
geo_settings:
geo_provider: VRT
toll_roads: true
ferry_crossing: true
traffic_jams: true
flight_distance: false
calculation_settings:
max_calculation_time: PT20M
max_waiting_time: PT30M
result_ttl: PT20M
result_timezone: 0
treat_warnings_as_errors: false
precision: 2
actualize_settings:
current_time: '2026-09-07T22:30:00Z'
max_delay_duration: PT1H
replan_settings:
replan_strategy:
reorder: true
plan_new_orders: true
create_new_trips: true
UniversalData:
summary: Data
value:
locations:
- key: location_client_1
geopoint:
latitude: 55.713699
longitude: 37.621839
- key: location_client_2
geopoint:
latitude: 55.630721
longitude: 37.62493
- key: location_client_3
geopoint:
latitude: 55.722801
longitude: 37.674984
- key: location_storage
geopoint:
latitude: 55.685853
longitude: 37.43181
orders:
- key: order_1
demands:
- key: demand_1_drop
demand_type: DROP
target_cargos:
- order_1_cargos
possible_events:
- key: demand_1_drop_event
location_key: location_client_1
duration: PT10M
hard_time_window:
from: '2026-09-08T05:00:00+00:00'
to: '2026-09-08T07:00:00+00:00'
- key: demand_1_pickup
demand_type: PICKUP
target_cargos:
- order_1_cargos
possible_events:
- key: demand_1_pickup_event
location_key: location_storage
duration: P0D
reward: 0
hard_time_window:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
cargos:
- key: order_1_cargos
capacity:
mass: 1
- key: order_2
demands:
- key: demand_2_drop
demand_type: DROP
target_cargos:
- order_2_cargos
possible_events:
- key: demand_2_drop_event
location_key: location_client_2
duration: PT10M
hard_time_window:
from: '2026-09-08T05:00:00+00:00'
to: '2026-09-08T07:00:00+00:00'
- key: demand_2_pickup
demand_type: PICKUP
target_cargos:
- order_2_cargos
possible_events:
- key: demand_2_pickup_event
location_key: location_storage
duration: P0D
reward: 0
hard_time_window:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
cargos:
- key: order_2_cargos
capacity:
mass: 1
- key: order_3
demands:
- key: demand_3_work
demand_type: WORK
possible_events:
- key: demand_3_work_event
location_key: location_client_3
duration: PT15M
hard_time_window:
from: '2026-09-08T05:00:00+00:00'
to: '2026-09-08T07:00:00+00:00'
performers:
- key: performer_1
shifts:
- key: performer_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
working_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
tariff:
cost_per_shift: 1000
constraints:
- stage_length: PT10H
cost_per_unit: 1
transports:
- key: transport_1
shifts:
- key: transport_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
tariff:
cost_per_shift: 1000
constraints:
- stage_length: 1000000
cost_per_unit: 0.01
transport_type: CAR
boxes:
- key: box_1
capacity:
mass: 300
trips:
- key: performer_1_shift
performer:
performer_key: performer_1
shift_key: performer_1_shift
shift_time:
from: '2026-09-08T04:38:34Z'
to: '2026-09-08T05:53:39Z'
transport:
transport_key: transport_1
shift_key: transport_1_shift
shift_time:
from: '2026-09-08T04:38:34Z'
to: '2026-09-08T05:53:39Z'
states:
- time: '2026-09-08T04:38:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions: []
attributes: []
- time: '2026-09-08T04:38:34Z'
flags:
- ON_DEMAND
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_LOCATION_WINDOW
- INSIDE_LOCATION
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_pickup
event_key: demand_2_pickup_event
location_key: location_storage
cargo_actions: []
attributes: []
- time: '2026-09-08T04:38:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T04:38:34Z'
flags:
- ON_DEMAND
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_LOCATION_WINDOW
- INSIDE_LOCATION
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_pickup
event_key: demand_1_pickup_event
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T04:38:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T04:38:34Z'
flags:
- RELOCATING
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- ON_DEMAND
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_LOCATION_WINDOW
- INSIDE_LOCATION
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_drop
event_key: demand_2_drop_event
location_key: location_client_2
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- RELOCATING
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:20:52Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:20:52Z'
flags:
- ON_DEMAND
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_LOCATION_WINDOW
- INSIDE_LOCATION
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_drop
event_key: demand_1_drop_event
location_key: location_client_1
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
attributes: []
- time: '2026-09-08T05:30:52Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
attributes: []
- time: '2026-09-08T05:30:52Z'
flags:
- RELOCATING
cargo_actions: []
attributes: []
- time: '2026-09-08T05:38:39Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
attributes: []
- time: '2026-09-08T05:38:39Z'
flags:
- ON_DEMAND
- INSIDE_EVENT_HARD_WINDOW
- INSIDE_LOCATION_WINDOW
- INSIDE_LOCATION
- AROUND_LOCATION
order_key: order_3
demand_key: demand_3_work
event_key: demand_3_work_event
location_key: location_client_3
cargo_actions: []
attributes: []
- time: '2026-09-08T05:53:39Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
attributes: []
waitlist: []
attributes: []
RawLocation:
summary: Example location
value:
key: performer_1_location
geopoint:
latitude: 55.720292
longitude: 37.625994
WebLocation:
summary: Web location
value:
location:
key: performer_1_location
geopoint:
latitude: 55.720292
longitude: 37.625994
fields:
essence_key: performer_1_location
enabled: true
EmptyTableList:
summary: Empty table list
value:
essences: []
counters:
overall:
total: 0
filter:
total: 0
EssenceKeyList:
summary: Essence key list
value:
- essence_key_1
- essence_key_99
RawPerformer:
summary: Example performer
value:
key: performer_1
shifts:
- key: performer_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
working_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
WebPerformer:
summary: Web performer
value:
performer:
key: performer_1
shifts:
- key: performer_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
working_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
fields:
essence_key: performer_1
enabled: true
RawTransport:
summary: Example transport
value:
key: transport_1
shifts:
- key: transport_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
transport_type: CAR
boxes:
- key: box_1
capacity:
mass: 300
WebTransport:
summary: Web transport
value:
transport:
key: transport_1
shifts:
- key: transport_1_shift
availability_time:
from: '2026-09-07T21:00:00+00:00'
to: '2026-09-08T20:59:59+00:00'
transport_type: CAR
boxes:
- key: box_1
capacity:
mass: 300
fields:
essence_key: transport_1
enabled: true
RawOrder:
summary: Example order
value:
key: order_1
demands:
- key: demand_work
demand_type: WORK
possible_events:
- key: demand_work_event
location_key: location_client
duration: PT15M
hard_time_window:
from: '2026-09-08T05:00:00+00:00'
to: '2026-09-08T07:00:00+00:00'
WebOrder:
summary: Web order
value:
order:
key: order_1
demands:
- key: demand_work
demand_type: WORK
possible_events:
- key: demand_work_event
location_key: location_client
duration: PT15M
hard_time_window:
from: '2026-09-08T05:00:00+00:00'
to: '2026-09-08T07:00:00+00:00'
fields:
essence_key: order_1
enabled: true
OrderCargoInvoiceList:
summary: Cargo invoice list
value:
- order_key: order_1
cargo_key: order_1_cargo_1
invoice:
invoice_details:
- key: product-a1
full_name: Mango, 1 kg
unit_name: Mango
unit_price: 500
unit_quantity: 2
tax: VAT_20
honest_sign:
label: null
marking_required: false
payable: true
prepayment: 1000
- order_key: order_2
cargo_key: order_2_cargo_1
invoice:
invoice_details: []
payable: false
EmptyList:
summary: Empty list
value: []
RawHardlink:
summary: Example hardlink
value:
key: hardlink_1
links:
- type: PERFORMER_SHIFT
entity_key: perf_1
- type: TRANSPORT_SHIFT
entity_key: transp_1
WebHardlink:
summary: Web hardlink
value:
hardlink:
key: hardlink_1
links:
- type: PERFORMER_SHIFT
entity_key: perf_1
- type: TRANSPORT_SHIFT
entity_key: transp_1
fields:
essence_key: hardlink_1
enabled: true
RawTrip:
summary: Example trip
value:
key: trip_1
performer:
performer_key: performer_1
shift_key: performer_1_shift
shift_time:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:53:49Z'
transport:
transport_key: transport_1
shift_key: transport_1_shift
shift_time:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:53:49Z'
states:
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_pickup
event_key: demand_1_pickup_event
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_pickup
event_key: demand_2_pickup_event
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- RELOCATING
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_drop
event_key: demand_2_drop_event
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: REMOVE
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- RELOCATING
cargo_actions: []
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_drop
event_key: demand_1_drop_event
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: REMOVE
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- RELOCATING
cargo_actions: []
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_3
demand_key: demand_3_work
event_key: demand_3_work_event
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:53:49Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 6795.37
reward: 3000.3
attributes: []
name: 1-HVFB
waitlist: []
attributes: []
WebTrip:
summary: Web trip
value:
trip:
key: trip_1
performer:
performer_key: performer_1
shift_key: performer_1_shift
shift_time:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:53:49Z'
transport:
transport_key: transport_1
shift_key: transport_1_shift
shift_time:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:53:49Z'
states:
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_pickup
event_key: demand_1_pickup_event
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: ADD
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_pickup
event_key: demand_2_pickup_event
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_storage
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: ADD
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_storage
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T04:39:34Z'
flags:
- RELOCATING
cargo_actions: []
distance: 0
cost: 2000
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:00:00Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_2
demand_key: demand_2_drop
event_key: demand_2_drop_event
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3397.1
reward: 0
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_2
cargo_actions:
- box_key: box_1
cargo_key: order_2_cargos
cargo_action_type: REMOVE
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_client_2
cargo_actions: []
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:10:00Z'
flags:
- RELOCATING
cargo_actions: []
distance: 17110
cost: 3997.1
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:20:56Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_1
demand_key: demand_1_drop
event_key: demand_1_drop_event
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 4752.07
reward: 1000.1
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_1
cargo_actions:
- box_key: box_1
cargo_key: order_1_cargos
cargo_action_type: REMOVE
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- DEPARTURE
- AROUND_LOCATION
location_key: location_client_1
cargo_actions: []
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:30:56Z'
flags:
- RELOCATING
cargo_actions: []
distance: 27007
cost: 5352.07
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- ARRIVAL
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:38:49Z'
flags:
- ON_DEMAND
- INSIDE_LOCATION
- INSIDE_LOCATION_WINDOW
- INSIDE_EVENT_HARD_WINDOW
- AROUND_LOCATION
order_key: order_3
demand_key: demand_3_work
event_key: demand_3_work_event
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 5895.37
reward: 2000.2
attributes: []
- time: '2026-09-08T05:53:49Z'
flags:
- INSIDE_LOCATION
- AROUND_LOCATION
location_key: location_client_3
cargo_actions: []
distance: 34037
cost: 6795.37
reward: 3000.3
attributes: []
name: 1-HVFB
waitlist: []
attributes: []
trip_statistics:
trip_key: trip_1
general_statistics:
cost: 6795.37
reward: 3000.3
profit: -3795.07
measurements:
time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:53:49Z'
driving_time: PT39M15S
waiting_time: PT0S
working_time: PT35M
break_time: PT0S
rest_time: PT0S
arriving_time: PT0S
departure_time: PT0S
total_time: PT1H14M15S
distance: 34037
trips_count: 1
performers_count: 1
orders_count: 3
plan_orders_count: 3
waitlist_orders_count: 0
stops_count: 4
locations_count: 4
cargo_capacity_sum:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
cargo_capacity_ratio:
mass: 0.007
volume: 1
capacity_a: 1
capacity_b: 1
capacity_c: 1
max_transport_load:
mass: 0.007
volume: 1
capacity_a: 1
capacity_b: 1
capacity_c: 1
average_speed: 0
round_trips_count: 1
load_statistics:
total_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_transfer_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
stop_statistics:
- location_key: location_storage
stop_demands:
- demand_key: demand_1_pickup
event_key: demand_1_pickup_event
demand_time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T04:39:34Z'
- demand_key: demand_2_pickup
event_key: demand_2_pickup_event
demand_time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T04:39:34Z'
stop_time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T04:39:34Z'
measurements:
time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T04:39:34Z'
driving_time: PT0S
waiting_time: PT0S
working_time: PT0S
break_time: PT0S
rest_time: PT0S
arriving_time: PT0S
departure_time: PT0S
total_time: PT0S
distance: 0
upload:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
download:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
arrival_load:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
departure_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
- location_key: location_client_2
stop_demands:
- demand_key: demand_2_drop
event_key: demand_2_drop_event
demand_time_window:
from: '2026-09-08T05:00:00Z'
to: '2026-09-08T05:10:00Z'
stop_time_window:
from: '2026-09-08T05:00:00Z'
to: '2026-09-08T05:10:00Z'
measurements:
time_window:
from: '2026-09-08T04:39:34Z'
to: '2026-09-08T05:10:00Z'
driving_time: PT20M26S
waiting_time: PT0S
working_time: PT10M
break_time: PT0S
rest_time: PT0S
arriving_time: PT0S
departure_time: PT0S
total_time: PT30M26S
distance: 17110
upload:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
download:
count: 1
capacity:
mass: 1
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
arrival_load:
count: 2
capacity:
mass: 2
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
departure_load:
count: 1
capacity:
mass: 1
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
- location_key: location_client_1
stop_demands:
- demand_key: demand_1_drop
event_key: demand_1_drop_event
demand_time_window:
from: '2026-09-08T05:20:56Z'
to: '2026-09-08T05:30:56Z'
stop_time_window:
from: '2026-09-08T05:20:56Z'
to: '2026-09-08T05:30:56Z'
measurements:
time_window:
from: '2026-09-08T05:10:00Z'
to: '2026-09-08T05:30:56Z'
driving_time: PT10M56S
waiting_time: PT0S
working_time: PT10M
break_time: PT0S
rest_time: PT0S
arriving_time: PT0S
departure_time: PT0S
total_time: PT20M56S
distance: 9897
upload:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
download:
count: 1
capacity:
mass: 1
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_load:
count: 1
capacity:
mass: 1
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
arrival_load:
count: 1
capacity:
mass: 1
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
departure_load:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
- location_key: location_client_3
stop_demands:
- demand_key: demand_3_work
event_key: demand_3_work_event
demand_time_window:
from: '2026-09-08T05:38:49Z'
to: '2026-09-08T05:53:49Z'
stop_time_window:
from: '2026-09-08T05:38:49Z'
to: '2026-09-08T05:53:49Z'
measurements:
time_window:
from: '2026-09-08T05:30:56Z'
to: '2026-09-08T05:53:49Z'
driving_time: PT7M53S
waiting_time: PT0S
working_time: PT15M
break_time: PT0S
rest_time: PT0S
arriving_time: PT0S
departure_time: PT0S
total_time: PT22M53S
distance: 7030
upload:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
download:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
max_load:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
arrival_load:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
departure_load:
count: 0
capacity:
mass: 0
volume: 0
capacity_a: 0
capacity_b: 0
capacity_c: 0
fields:
essence_key: trip_1
enabled: true
EmptyChartList:
summary: Empty chart list
value:
charts: []
counters:
overall:
total: 0
filter:
total: 0
TrackList:
summary: Trip track list
value:
tracks:
- geotrack:
- latitude: 55.692789
longitude: 37.554554
time: '2026-09-21T09:30:00+03:00'
- latitude: 55.692788
longitude: 37.55467
time: '2026-09-21T09:35:00+03:00'
trip_key: trip_01
performer_key: performer_01
performer_shift_key: performer_shift_01
transport_key: transport_01
transport_shift_key: transport_shift_01
trip_name: X1-ABC
counters:
overall:
total: 1
filter:
total: 1
TrackListCustom:
summary: Trip track list custom
value:
tracks:
- geotrack:
- latitude: 55.692789
longitude: 37.554554
time: '2026-09-21T09:30:00+03:00'
- latitude: 55.692788
longitude: 37.55467
time: '2026-09-21T09:35:00+03:00'
trip_key: trip_01
performer_key: performer_01
performer_shift_key: performer_shift_01
transport_key: transport_01
transport_shift_key: transport_shift_01
trip_name: X1-ABC
RawFact:
summary: Fact of location update
value:
key: fact_01
type: GEOTRACK_UPDATED
time: '2026-09-07T22:00:00Z'
trip_key: trip_for_performer_1
performer_key: performer_1
location_key: performer_1_current_location
WebFact:
summary: Web fact
value:
fact:
key: fact_01
type: GEOTRACK_UPDATED
time: '2026-09-07T22:00:00Z'
trip_key: trip_for_performer_1
performer_key: performer_1
location_key: performer_1_current_location
fields:
essence_key: fact_01
enabled: true
AnalyticsOverview:
summary: Analytics for the period
value:
charts:
- type: ORDERS_COUNT_TOTAL
metrics:
- wave_key: 11111111-1111-1111-1111-111111111111
wave_name: Wave 1
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
- wave_key: 22222222-2222-2222-2222-222222222222
wave_name: Wave 2
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
- wave_key: 33333333-3333-3333-3333-333333333333
wave_name: Wave 3
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
- type: ORDERS_COUNT_DELIVERED
metrics:
- wave_key: 11111111-1111-1111-1111-111111111111
wave_name: Wave 1
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
- wave_key: 22222222-2222-2222-2222-222222222222
wave_name: Wave 2
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
- wave_key: 33333333-3333-3333-3333-333333333333
wave_name: Wave 3
elements:
- time: '2026-09-03T08:00:00+03:00'
value: 200
type: HISTORY
- time: '2026-09-03T08:15:00+03:00'
value: 210
type: HISTORY
- time: '2026-09-03T08:30:00+03:00'
value: 220
type: HISTORY
- time: '2026-09-03T08:45:00+03:00'
value: 230
type: HISTORY
- time: '2026-09-03T09:00:00+03:00'
value: 240
type: HISTORY
- time: '2026-09-03T14:00:00+03:00'
value: 300
type: FORECAST
- time: '2026-09-03T14:15:00+03:00'
value: 310
type: FORECAST
- time: '2026-09-03T14:30:00+03:00'
value: 320
type: FORECAST
- time: '2026-09-03T14:45:00+03:00'
value: 330
type: FORECAST
- time: '2026-09-03T15:00:00+03:00'
value: 340
type: FORECAST
ScenarioSimple:
summary: Simple scenario
value:
key: scenario_simple
jobs:
- key: stage-call
translations:
ru: Позвонить клиенту
en: Make call
group_key: group-call
depends_on:
- key01
- key: stage-docs
translations:
ru: Подписать документы
en: Make docs
group_key: group-docs
depends_on:
- stage-call
ScenarioComplex:
summary: Complex scenario
value:
key: scenario_complex
jobs:
- key: stage-call-before
translations:
ru: Предупредить клиента о прибытии
en: Notify the client about arrival
group_key: group-prepare
depends_on:
- key01
- key: stage-arrive
translations:
ru: Прибыть на адрес и отметить начало работы
en: Arrive at the address and mark the start of work
group_key: group-prepare
depends_on:
- stage-call-before
- key: stage-verify-id
translations:
ru: Проверить документ, удостоверяющий личность
en: Verify the identity document
group_key: group-verify
depends_on:
- stage-arrive
- key: stage-scan-qr
translations:
ru: Сканировать QR-код заявки
en: Scan the order QR code
group_key: group-verify
depends_on:
- stage-arrive
- key: stage-show-cargo
translations:
ru: Продемонстрировать груз клиенту
en: Show the cargo to the client
group_key: group-cargo
depends_on:
- stage-verify-id
- stage-scan-qr
- key: stage-unload
translations:
ru: Выгрузить груз
en: Unload the cargo
group_key: group-cargo
depends_on:
- stage-show-cargo
- key: stage-photo-cargo
translations:
ru: Сделать фотографию выгруженного груза
en: Take a photo of the unloaded cargo
group_key: group-cargo
depends_on:
- stage-unload
- key: stage-payment
translations:
ru: Принять оплату
en: Accept payment
group_key: group-payment
depends_on:
- stage-unload
- key: stage-docs
translations:
ru: Подписать сопроводительные документы
en: Sign the accompanying documents
group_key: group-docs
depends_on:
- stage-payment
- stage-photo-cargo
- key: stage-photo-docs
translations:
ru: Сфотографировать подписанные документы
en: Photograph the signed documents
group_key: group-docs
depends_on:
- stage-docs
- key: stage-feedback
translations:
ru: Запросить оценку обслуживания у клиента
en: Ask the client to rate the service
group_key: group-finalize
depends_on:
- stage-photo-docs
- key: stage-call-after
translations:
ru: Сообщить диспетчеру о завершении
en: Notify the dispatcher about completion
group_key: group-finalize
depends_on:
- stage-feedback
Customfields:
summary: Custom fields
value:
rules:
- entity_type: LOCATION
source_attribute_key: max_trailer_weight
target_customfield: INT_1
translations:
ru: Максимальная масса прицепа (кг)
en: Maximum trailer weight (kg)
- entity_type: LOCATION
source_attribute_key: trailer_name
target_customfield: STRING_1
translations:
ru: Название стоянки прицепов
en: Trailer name
- entity_type: LOCATION
source_attribute_key: trailer_duration
target_customfield: DURATION_1
translations:
ru: Время расцепки прицепов
en: Trailer action duration
- entity_type: LOCATION
source_attribute_key: trailer_creation_date
target_customfield: DATETIME_1
translations:
ru: Дата основания
en: Creation Date
- entity_type: LOCATION
source_attribute_key: trailer_cost
target_customfield: FLOAT_1
translations:
ru: Стоимость хранения
en: Storage Cost
- entity_type: LOCATION
source_attribute_key: trailer_state
target_customfield: BOOL_1
translations:
ru: Наличие парковки для прицепа
en: Availability of trailer parking
x-tagGroups:
- name: Filesystem
tags:
- Explorer
- Backups
- name: Resources
tags:
- Crews
- Deals
- Store
- name: Datasets
tags:
- Waves
- Locations
- Orders
- Performers
- Transports
- Hardlinks
- Trips
- Facts
- name: Operational control
tags:
- Autopilot
- Tracker
- Analytics
- Reports
- name: Customization
tags:
- User
- CustomFields
- CustomIcons
- Scenarios
- name: Maintenance
tags:
- System