openapi: 3.0.3 info: title: VRt.Monitor [MT] version: 7.19.2779 license: name: Proprietary url: https://veeroute.com/ termsOfService: https://veeroute.com/resources/terms_of_service contact: name: Veeroute Support Team email: servicedesk@veeroute.com x-logo: url: ../images/monitor.svg backgroundColor: '#FAFAFA' altText: VRt.Monitor description: 'Veeroute Monitor API. # Description Server part of the Veeroute Monitor. ## Entity relationship diagram ![erd](../uml/monitor.svg) ' 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: Crews description: 'Crews management. ' - name: Waves description: 'Waves management. ' - name: Deals description: 'Deals management. Deal - the assignment of a team to a specific trip from a specific wave. ' - 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. ' - name: Analytics description: 'Analytics and forecast. ' - name: Reports description: 'Reports. ' - name: User description: 'User settings. ' - name: CustomFields description: 'Custom field conversion settings. The table provides additional columns for displaying values ​​from attributes. This setting defines the rules for converting attribute values ​​into the corresponding typed fields. Conversion occurs when reading data - therefore, the conversion rules do not affect the data and can be changed at any time. ' - 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' '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' '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/{folder_key}: put: tags: - Explorer summary: Update folder description: Rename and move folder. operationId: update_folder x-process-type: TRACE parameters: - $ref: '#/components/parameters/folder_key-2' 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' '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/folder_key-2' 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' '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/{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/folder_key-2' 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' '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/{folder_key}/path: get: tags: - Explorer summary: Folder path description: Folder path. operationId: read_folder_path x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/folder_key-2' 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' '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: 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' '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: 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 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' '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' '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/{folder_key}: post: tags: - Backups summary: Folder export description: 'Export folder with experiments. ' operationId: create_backup x-process-type: TRACE parameters: - $ref: '#/components/parameters/folder_key-2' 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' '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 experiments. The folder should not be of type ROOT and should be empty. ' operationId: restore_backup x-process-type: TRACE parameters: - $ref: '#/components/parameters/folder_key-2' 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' '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: New crew creation. operationId: create_crew x-process-type: TRACE requestBody: description: Crew creation request. required: true content: application/json: schema: $ref: '#/components/schemas/crew' 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' '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' 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' '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' '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: Crew removal description: Removing a crew by key. 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' '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' '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' '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/geopoints: post: tags: - Crews summary: Crew geopoints description: Getting a crew geopoints. operationId: read_crews_geopoints 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_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' '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. operationId: read_self_crew_info x-process-type: NOTRACE 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' '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/trips: get: tags: - Crews summary: Self crew trips description: Getting a crew trips by login. operationId: read_self_crew_trips x-process-type: TRACE responses: '200': description: Data received successfully content: application/json: schema: $ref: '#/components/schemas/web_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' '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: post: tags: - Deals summary: Deal creation description: New deal creation. operationId: create_deal x-process-type: TRACE requestBody: description: Deal creation request. required: true content: application/json: schema: $ref: '#/components/schemas/deal_specification' responses: '201': 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' '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: - Deals summary: Deal update description: Updating the deal information. operationId: update_deal x-process-type: TRACE requestBody: description: Deal update request. required: true content: application/json: schema: $ref: '#/components/schemas/deal' 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' '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' '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: Deal removal description: Removing a deal by key. operationId: delete_deal x-process-type: TRACE parameters: - $ref: '#/components/parameters/deal_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' '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/wave_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' '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/{wave_key}: get: tags: - Waves summary: Reading wave description: Getting wave information by key. operationId: read_wave x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/wave_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' '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/wave_key' requestBody: description: wave specification update request. required: true content: application/json: schema: $ref: '#/components/schemas/wave_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' '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/wave_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' '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/table/batch: post: tags: - Waves summary: Reading waves (table) description: Getting a table with wave. operationId: read_waves_table x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/folder_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_wave_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Waves filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_wave_filter_list' examples: FilterList: $ref: '#/components/examples/FilterList' 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' '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: Waves removal (batch) description: Batch waves delete. operationId: delete_waves_batch x-process-type: TRACE requestBody: description: Request to delete waves. required: true content: application/json: schema: $ref: '#/components/schemas/unique_key_list' responses: '204': description: waves 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' '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/{wave_key}/duplication: post: tags: - Waves summary: Wave duplicate description: Wave duplicate. operationId: duplicate_wave x-process-type: TRACE parameters: - $ref: '#/components/parameters/wave_key' requestBody: description: wave duplicate request. required: true content: application/json: schema: $ref: '#/components/schemas/wave_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' '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/{wave_key}/path: get: tags: - Waves summary: Wave path description: Wave path. operationId: read_wave_path x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/wave_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' '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/{wave_key}/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/wave_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' '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/{wave_key}/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/wave_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' '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/{wave_key}/export/xlsx: post: tags: - Waves summary: Export (XLSX) description: Export (XLSX). operationId: export_xlsx x-process-type: TRACE parameters: - $ref: '#/components/parameters/wave_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' '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/{wave_key}/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/wave_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' '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/{wave_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/wave_key' - $ref: '#/components/parameters/essence_key' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip' '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' '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/wave_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' '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/{wave_key}/trips/table/batch: post: tags: - Trips summary: Reading trips (table) description: Getting a trips list. operationId: read_trips_table x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/wave_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' '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/wave_key' requestBody: description: Request to delete trips. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' 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' '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/{wave_key}/trips/table/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/wave_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' '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/{wave_key}/trips/{essence_key}/crews/available: post: tags: - Trips 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/wave_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' '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/{wave_key}/trips/actions/run: post: tags: - Trips 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/wave_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' '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: 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/wave_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' '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/{wave_key}/facts: post: tags: - Facts summary: Create fact description: Create new fact. operationId: create_fact x-process-type: TRACE parameters: - $ref: '#/components/parameters/wave_key' requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/fact' examples: FactNewLocation: $ref: '#/components/examples/FactNewLocation' 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' '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: - Facts summary: Update fact description: Updating the fact by key. operationId: update_fact x-process-type: TRACE parameters: - $ref: '#/components/parameters/wave_key' requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/fact' examples: FactNewLocation: $ref: '#/components/examples/FactNewLocation' responses: '200': description: Data updated successfully 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' '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/{wave_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/wave_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' '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/wave_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' '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/{wave_key}/facts/table/batch: post: tags: - Facts summary: List of facts description: Getting a facts list. operationId: read_facts x-process-type: NOTRACE parameters: - $ref: '#/components/parameters/wave_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' '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 experiment. operationId: delete_facts x-process-type: TRACE parameters: - $ref: '#/components/parameters/wave_key' requestBody: description: Request to delete facts. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' 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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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' '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_null: description: Key, unique identifier. type: string nullable: true default: null 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 - FOLDERS_COUNT - FILES_COUNT default: NAME example: CREATION_DATE unique_key: description: Key, unique identifier. type: string format: uuid example: 11111111-2222-3333-4444-555555555555 folder_type: description: "Element type:\n * `ROOT` - root object\n * `FOLDER` - folder\n" type: string enum: - ROOT - FOLDER example: FOLDER folder_name: description: Folder name. type: string minLength: 1 maxLength: 100 example: folder_1 folder_comment: description: Folder comment. type: string nullable: true default: null minLength: 0 maxLength: 10000 example: long long long long text folder_color: description: Folder color. type: string nullable: true 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 required: - key - value attributes: description: Attributes. Used to add service information. type: array minItems: 0 maxItems: 250 uniqueItems: true default: [] items: $ref: '#/components/schemas/attribute' company_key: description: Unique company key. type: string pattern: \w+ minLength: 3 maxLength: 256 example: smart_company user_username: description: Unique username for login. type: string pattern: \w+ minLength: 2 maxLength: 256 example: username_for_login 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/unique_key_null' description: Parent folder key, null if the folder is root. 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' 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' 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 nullable: true default: null format: date-time example: '2025-09-21T19:45:00Z' counters: $ref: '#/components/schemas/folder_counters' required: - key - type - name - owner_company_key - owner_username - 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 service: description: Service name. type: string enum: - UNIVERSAL - ROUTING - ACCOUNT - ADMIN - STUDIO - MONITOR - PACKER - AGRO 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: \w+ minLength: 2 maxLength: 256 example: edge7 pod: description: Pod identifier. type: string pattern: \w+ 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: '2025-09-21T09:30:00+03:00' required: - process_code - request_code - username - company - service - operation - env - pod - time schema_error: description: Data error by schema. type: object additionalProperties: false properties: entity: description: Target entity identifier. type: string nullable: true maxLength: 1024 example: order_0001 message: description: Error message. type: string 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' general_400: description: 400 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error message. type: string nullable: true example: Bad Request schema_errors: $ref: '#/components/schemas/schema_error_list' required: - tracedata general_402: description: 402 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error message. type: string nullable: true example: Payment Required required: - tracedata general_403: description: 403 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error message. type: string nullable: true example: Forbidden required: - tracedata general_404: description: 404 Error details. type: object additionalProperties: false properties: resource_key: description: Resource identifier. type: string nullable: true default: null example: resource_key detail: description: Resource details. type: object additionalProperties: false nullable: true properties: tracedata: $ref: '#/components/schemas/tracedata' required: - tracedata general_429: description: 429 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error Message. type: string nullable: true example: Too many requests required: - tracedata general_500: description: 500 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error message. type: string nullable: true example: Internal Server Error required: - tracedata folder_specification: description: Folder specification. type: object additionalProperties: false properties: parent_key: $ref: '#/components/schemas/unique_key_null' description: Parent folder key, null if the folder is root. name: $ref: '#/components/schemas/folder_name' comment: $ref: '#/components/schemas/folder_comment' color: $ref: '#/components/schemas/folder_color' 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 unique_key_list: description: A list of unique keys. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/unique_key' 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 nullable: true default: null format: password minLength: 10 maxLength: 256 example: long_strong_password writeOnly: true time_window: description: Time window. type: object additionalProperties: false nullable: true 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: '2025-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: '2025-09-21T19:45:00Z' required: - from - to 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). type: string format: duration x-custom-format: duration pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?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: List of components of the tariff. type: array minItems: 1 maxItems: 100 uniqueItems: false items: $ref: '#/components/schemas/performer_tariff_constraint' default: - stage_length: P30D cost_per_unit: 0.001 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 format: double nullable: true default: null minimum: 0 maximum: 1000000 example: 2000 time_duration: description: Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). type: string format: duration x-custom-format: duration pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$ minLength: 3 maxLength: 16 default: PT0S example: PT1H45M time_duration_null: description: Time duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). type: string format: duration x-custom-format: duration pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$ minLength: 3 maxLength: 16 nullable: true default: null example: PT2H12M34.3S rest: description: The condition for the onset and characteristics of a rest. type: object additionalProperties: false nullable: true 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). operating_duration_sum: $ref: '#/components/schemas/time_duration_null' description: Total trip time (excluding waiting), no later than which you need to take a rest according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). duration: $ref: '#/components/schemas/time_duration' description: Length of break period according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). required: - relocating_duration_sum - duration rest_rules: description: Rules for accounting for rest. type: object additionalProperties: false nullable: true properties: consecutive: $ref: '#/components/schemas/rest' description: The condition for the onset and characteristics of a consecutive break. required: - consecutive break: description: The condition for the onset and characteristics of a break. type: object additionalProperties: false nullable: true 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). duration: $ref: '#/components/schemas/time_duration' description: Length of break period according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). required: - relocating_duration_sum - duration break_rules: description: Rules for accounting for breaks. type: object additionalProperties: false nullable: true properties: first: description: The condition for the onset and characteristics of a first break. $ref: '#/components/schemas/break' consecutive: description: The condition for the onset and characteristics of a consecutive break. $ref: '#/components/schemas/break' relocating_duration_type: description: Type of accounting for time spent moving between locations (total or continuous). type: string nullable: false enum: - TOTAL - CONTINUOUS default: TOTAL example: CONTINUOUS required: - first work_and_rest_rules: description: 'Work and rest rules. ' type: object additionalProperties: false nullable: true properties: rest_rules: $ref: '#/components/schemas/rest_rules' break_rules: $ref: '#/components/schemas/break_rules' 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 ignore_location_keys: description: A list of location keys whose stay is not taken into account in the total 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 name: description: Name, information field. type: string minLength: 0 maxLength: 128 default: '' example: X1-ABC 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 minLength: 1 maxLength: 1024 nullable: true 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 minLength: 1 maxLength: 1024 nullable: true 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 format: int32 minimum: 1 maximum: 1000 nullable: true 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 format: int32 minimum: 1 maximum: 1000 nullable: true default: null example: 15 tariff: $ref: '#/components/schemas/performer_tariff' work_and_rest_rules: $ref: '#/components/schemas/work_and_rest_rules' name: $ref: '#/components/schemas/name' attributes: $ref: '#/components/schemas/attributes' required: - key - availability_time - working_time 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 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 minItems: 0 maxItems: 1000 uniqueItems: true default: [] items: $ref: '#/components/schemas/compatibility_tag' 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 minItems: 0 maxItems: 100 default: [] uniqueItems: true items: $ref: '#/components/schemas/feature_lifetime' performer_compatibilities: description: 'Performer [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true 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. ' 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: description: 'Additional execution time for all events of the specified order for all shifts of the specified performer. According to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). ' $ref: '#/components/schemas/time_duration' required: - demand_key - additional_duration performer_limits: description: 'The performer limitations. ' type: object additionalProperties: false nullable: true 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 minItems: 0 maxItems: 15001 uniqueItems: true items: $ref: '#/components/schemas/demand_extra_duration' 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: $ref: '#/components/schemas/performer_compatibilities' limits: $ref: '#/components/schemas/performer_limits' name: $ref: '#/components/schemas/name' attributes: $ref: '#/components/schemas/attributes' required: - key - shifts 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 capacity_cost: description: Cost per capacity element. type: object additionalProperties: false nullable: true 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 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 minItems: 1 maxItems: 100 uniqueItems: false items: $ref: '#/components/schemas/transport_tariff_constraint' default: - stage_length: 100000000 cost_per_unit: 0.001 transportation_cost: $ref: '#/components/schemas/capacity_cost' description: The cost of moving 1 unit of measure of cargo per 1 meter (for each capacity field, respectively), monetary unit. 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 minLength: 1 maxLength: 1024 nullable: true 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 minLength: 1 maxLength: 1024 nullable: true 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 capacity: description: Capacity characteristics. type: object additionalProperties: false nullable: true 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: 'A transport box [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true 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: description: 'Box features list. Used to check whether the cargo is compatible with the box. ' $ref: '#/components/schemas/compatibility_tag_list' box_limits: description: 'Box limits. ' type: object additionalProperties: false nullable: true properties: max_one_cargo_capacity: $ref: '#/components/schemas/capacity' description: Limitation on the maximum size of one cargo. box: description: 'A transport box capable to hold a cargo. ' type: object additionalProperties: false properties: key: description: Unique box key used to identify the cargo placement in boxes. type: string minLength: 1 maxLength: 1024 example: box01 capacity: $ref: '#/components/schemas/capacity' description: The box capacity, which limits the maximum amount for all `capacity` fields of *all* the cargoes. compatibilities: $ref: '#/components/schemas/box_compatibilities' limits: $ref: '#/components/schemas/box_limits' required: - key transport_compatibilities: description: 'Transport [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true properties: transport_features: description: 'Transport features list. Used to check whether the transport is compatible with locations and performers. ' $ref: '#/components/schemas/compatibility_tag_list' transport_features_lifetimes: 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. ' $ref: '#/components/schemas/feature_lifetime_list' performer_restrictions: description: 'List of necessary requirements for the performer to use this transport. ' $ref: '#/components/schemas/compatibility_tag_list' transport_limits: description: 'Transport load limits. ' type: object additionalProperties: false nullable: true 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 format: int32 nullable: true default: null minimum: 0 maximum: 100 example: 2 max_capacity: $ref: '#/components/schemas/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. ' 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' boxes: description: A list of transport boxes that can accommodate the cargo. type: array minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/box' compatibilities: $ref: '#/components/schemas/transport_compatibilities' limits: $ref: '#/components/schemas/transport_limits' name: $ref: '#/components/schemas/name' attributes: $ref: '#/components/schemas/attributes' required: - key - shifts user_phone: description: User phone. type: string nullable: true default: null minLength: 5 maxLength: 32 example: '+71112223333' device: description: Mobile device. type: object additionalProperties: false properties: phone: $ref: '#/components/schemas/user_phone' online: description: Indicates the presence of a active connection. type: boolean default: false example: true app_version: description: Application version. type: string nullable: true default: null minLength: 2 maxLength: 64 example: '7.21' os_version: description: Operation system version. type: string nullable: true default: null minLength: 2 maxLength: 64 example: '15.0' manufacturer: description: Mobile device manufacturer. type: string nullable: true default: null minLength: 2 maxLength: 64 example: samsung model: description: Mobile device model. type: string nullable: true default: null minLength: 2 maxLength: 64 example: S25 Ultra user_specification: description: User specification. type: string nullable: true default: null minLength: 2 maxLength: 256 example: User full name deal_specification: description: Deal description. type: object additionalProperties: false properties: crew_key: $ref: '#/components/schemas/crew_key' wave_key: $ref: '#/components/schemas/unique_key' trip_key: description: Unique trip identifier. type: string minLength: 1 maxLength: 1024 example: trip-0000-9999 required: - crew_key - wave_key - trip_key deal: description: 'Deal - the assignment of a team to a specific trip from a specific wave. ' type: object additionalProperties: false properties: key: $ref: '#/components/schemas/unique_key' description: Unique deal identifier. specification: $ref: '#/components/schemas/deal_specification' required: - key - specification deal_list: description: A deal list. type: array uniqueItems: false minItems: 0 maxItems: 30 items: $ref: '#/components/schemas/deal' crew: description: Crew. type: object additionalProperties: false properties: key: $ref: '#/components/schemas/crew_key' username: $ref: '#/components/schemas/user_username' password: $ref: '#/components/schemas/user_password' company_key: $ref: '#/components/schemas/company_key' performer: $ref: '#/components/schemas/performer' transport: $ref: '#/components/schemas/transport' device: $ref: '#/components/schemas/device' specification: $ref: '#/components/schemas/user_specification' description: Crew specification. deals: $ref: '#/components/schemas/deal_list' description: Linked current deals. required: - key - username - company_key - performer - transport basic_essence_key_null: description: Essence key, unique identifier, may be `null`. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 table_string_search_field: description: 'String table field. For the parent entity, a comma-separated list of values is specified. ' type: string nullable: true default: null minLength: 1 maxLength: 1024 example: AAA table_crew_fields: description: Crew fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: true username: $ref: '#/components/schemas/table_string_search_field' x-filter-type: STRING_SEARCH x-default-enabled: true x-default-sort-direction: ASC company_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: true device_phone: $ref: '#/components/schemas/table_string_search_field' x-filter-type: STRING_SEARCH x-default-enabled: true device_online: description: Indicates the presence of a active connection. type: boolean default: false example: true x-filter-type: BOOL_LIST x-default-enabled: true basic_essence_key: description: Essence key, unique identifier. type: string minLength: 1 maxLength: 1024 example: key01 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 nullable: false enum: - LOCATION - ORDER - ASSIGNED_ORDER - PERFORMER - TRANSPORT - HARDLINK - TRIP - FACT - CREW example: LOCATION 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' 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 - USERNAME - COMPANY_KEY - DEVICE_PHONE - DEVICE_ONLINE default: USERNAME example: DEVICE_ONLINE 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. type: object additionalProperties: false nullable: true 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 nullable: true example: '2025-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 format: date-time nullable: true example: '2025-09-21T19:45:00+03:00' table_filter_int_range: description: Integer range. type: object additionalProperties: false nullable: true 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. type: object additionalProperties: false nullable: true 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 nullable: true properties: from: description: Left side. example: PT10M $ref: '#/components/schemas/time_duration' to: description: Right side. example: PT30M $ref: '#/components/schemas/time_duration' table_filter_bool_list: description: Boolean list filter. type: object additionalProperties: false nullable: true properties: elements: description: A list of booleans. type: array uniqueItems: false minItems: 0 maxItems: 2 items: description: Boolean. type: boolean default: false example: false table_filter_enum_list: description: Enum list filter. type: object additionalProperties: false nullable: true properties: elements: description: A list of strings. type: array uniqueItems: false minItems: 0 maxItems: 2001 items: description: Value. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 table_filter_string_list: description: String list filter. type: object additionalProperties: false nullable: true properties: elements: description: A list of strings. type: array uniqueItems: false minItems: 0 maxItems: 2001 items: description: String for search. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 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 nullable: true properties: text: description: String for search. type: string nullable: true 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: $ref: '#/components/schemas/table_filter_datetime_range' int_range: $ref: '#/components/schemas/table_filter_int_range' float_range: $ref: '#/components/schemas/table_filter_float_range' duration_range: $ref: '#/components/schemas/table_filter_duration_range' bool_list: $ref: '#/components/schemas/table_filter_bool_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_list: $ref: '#/components/schemas/table_filter_string_list' string_search: $ref: '#/components/schemas/table_filter_string_search' 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' table_crew: description: Crew (table). type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_crew_fields' required: - fields 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' 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 crew_geopoint: description: Geopoint for map. type: object additionalProperties: false properties: geopoint: $ref: '#/components/schemas/geopoint' crew_key: $ref: '#/components/schemas/crew_key' required: - geopoint - crew_key crew_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/crew_geopoint' counters: description: Counters by list of entities. $ref: '#/components/schemas/table_list_counters' geopoints_counters: description: Counters by list of points. $ref: '#/components/schemas/table_list_counters_detail' required: - geopoints - counters - geopoints_counters 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_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: description: Box key. type: string minLength: 1 maxLength: 1024 example: box01 cargo_key: description: Cargo key. type: string minLength: 1 maxLength: 1024 example: cargo01 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' 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: '2025-09-21T09:30:00+03:00' order_key: description: Key of the order with which an action is taken. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: order01 demand_key: description: Key of the demand with which an action is taken. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: demand01.1 event_key: description: Key of the event at which an action is taken. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: event01 location_key: description: Key of the location at which an action is taken. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: location_01 flags: description: "List of flags, describing current state. \n \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 default: 0 minimum: 0 maximum: 4000000000 example: 5200 cost: description: Cumulative cost calculated based on the performer's and transport tariffs. type: number format: double minimum: 0 maximum: 10000000000 default: 0 example: 1231.1 reward: description: Cumulative reward 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 minItems: 0 maxItems: 15001 uniqueItems: true items: description: Order key. type: string minLength: 1 maxLength: 1024 example: - order02 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: description: Unique trip identifier. type: string minLength: 1 maxLength: 1024 example: trip-0000-9999 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' 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: 0.5 volume: description: Loading by volume, in fractions of a unit. type: number format: double minimum: 0 maximum: 1000 example: 0.1 capacity_a: description: Loading by additional parameter (A), in fractions of a unit. type: number format: double minimum: 0 maximum: 1000 example: 0.7 capacity_b: description: Loading by additional parameter (B), in fractions of a unit. type: number format: double minimum: 0 maximum: 1000 example: 0.8 capacity_c: description: Loading by additional parameter (C), in fractions of a unit. type: number format: double minimum: 0 maximum: 1000 example: 0.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 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 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 during the driving (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 minItems: 0 maxItems: 15001 uniqueItems: false items: $ref: '#/components/schemas/stop_statistics' roundtrip_statistics: description: 'Statistics for roundtrip. ' type: object additionalProperties: false properties: roundtrip_key: description: Roundtrip key. type: string minLength: 1 maxLength: 1024 example: trip_01_round_02 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 minItems: 0 maxItems: 15001 uniqueItems: false items: $ref: '#/components/schemas/roundtrip_statistics' trip_statistics: description: 'Statistics for a specific trip. ' type: object additionalProperties: false properties: trip_key: description: Trip key, unique identifier type: string minLength: 1 maxLength: 1024 example: trip01 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 crew_key_null: description: 'Unique crew key (nullable). ' type: string nullable: true default: null pattern: \w+ minLength: 3 maxLength: 256 example: mega_crew time_window_null: description: Time window. type: object additionalProperties: false nullable: true 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 nullable: true default: null example: '2025-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 nullable: true default: null example: '2025-09-21T19:45:00Z' 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 format: date-time nullable: true default: null example: '2025-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 nullable: true default: null format: int32 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 format: double nullable: true default: null minimum: -1000000000000 maximum: 1000000000000 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 format: duration x-custom-format: duration pattern: ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$ minLength: 3 maxLength: 16 nullable: true default: null example: PT2H12M34.3S customfield_bool: description: 'A custom field containing a boolean value. Supported filter type is `BOOL_LIST`. ' x-filter-type: BOOL_LIST type: boolean nullable: true 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 nullable: true default: null minLength: 1 maxLength: 2000 example: value01 table_customfields: description: Custom fields for table. type: object additionalProperties: false properties: 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' 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' 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' 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' 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' 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' table_trip_fields: description: Trip\stops fields for table. type: object additionalProperties: false readOnly: true properties: essence_type: description: Essence type. type: string nullable: false enum: - TRIP - ROUNDTRIP default: TRIP example: TRIP essence_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 crew_key: $ref: '#/components/schemas/crew_key_null' 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 example: 5200 default: 0 time_window: $ref: '#/components/schemas/time_window_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 example: 1700 default: 0 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 example: 1003 default: 0 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 example: 697 default: 0 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 example: 87 default: 0 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 example: 45 default: 0 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' 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 web_trip_list: description: Trip list. type: array uniqueItems: false minItems: 0 maxItems: 10 items: $ref: '#/components/schemas/web_trip' wave_specification: description: Wave description. type: object additionalProperties: false properties: name: description: Wave name. type: string minLength: 1 maxLength: 100 example: wave_1 comment: description: Wave comment. type: string nullable: true default: null minLength: 0 maxLength: 10000 example: long long long long text folder_key: $ref: '#/components/schemas/unique_key' description: Parent folder key. required: - name - comment - folder_key plan_configuration: description: "Name of the planning configuration.\nThe configuration determines\ \ the result goal and quality. \n[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 minLength: 1 maxLength: 256 nullable: true default: null example: LONG_HAUL trip_expectations: description: 'Expectations from the calculation result. Affect the calculation 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 example: 25000 default: 0 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+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?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+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?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+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?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 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 nullable: true default: null example: https://universal-extension.veeroute.cloud 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: Replan strategy. type: object additionalProperties: false properties: reorder: description: Activate trip actions reorder. type: boolean default: false example: true plan_new_orders: description: Activate new orders planning. type: boolean default: false example: true create_new_trips: description: Activate new trips creation. 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 format: date-time nullable: true default: null example: '2025-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+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d+M$))?((\d+W)|(\d+\.\d+W$))?((\d+D)|(\d+\.\d+D$))?(T(?=\d)((\d+H)|(\d+\.\d+H$))?((\d+M)|(\d+\.\d+M$))?(\d+(\.\d+)?S)?)??$ minLength: 3 maxLength: 16 default: PT3H example: PT1H30M 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: A list of indicators. type: array uniqueItems: false minItems: 0 maxItems: 100 items: description: Indicator key. type: string minLength: 2 maxLength: 256 example: - total_statistics_cost - total_statistics_measurements_waiting_time task_statistics: description: 'General statistics on input data. ' type: object additionalProperties: false nullable: true 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 nullable: true 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 item_keys: description: Essences keys list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Key, unique identifier. type: string minLength: 1 maxLength: 1024 example: essence_key_01 item_keys_count: description: Essences count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 99 unplanned_items: description: Information about unplanned essences. type: object additionalProperties: false properties: order_keys: $ref: '#/components/schemas/item_keys' description: Unplanned order keys list. order_keys_count: $ref: '#/components/schemas/item_keys_count' description: Unplanned orders count. performer_keys: $ref: '#/components/schemas/item_keys' description: Unplanned performer keys list. performer_keys_count: $ref: '#/components/schemas/item_keys_count' description: Unplanned performers count. transport_keys: $ref: '#/components/schemas/item_keys' description: Unplanned transport keys list. transport_keys_count: $ref: '#/components/schemas/item_keys_count' description: Unplanned transports count. hardlink_keys: $ref: '#/components/schemas/item_keys' description: Unplanned hardlink keys list. hardlink_keys_count: $ref: '#/components/schemas/item_keys_count' description: Unplanned hardlinks count. removed_items: description: Information about removed essences. type: object additionalProperties: false properties: location_keys: $ref: '#/components/schemas/item_keys' description: Removed location keys list. location_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed location count. order_keys: $ref: '#/components/schemas/item_keys' description: Removed order keys list. order_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed orders count. performer_keys: $ref: '#/components/schemas/item_keys' description: Removed performer keys list. performer_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed performers count. transport_keys: $ref: '#/components/schemas/item_keys' description: Removed transport keys list. transport_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed transports count. hardlink_keys: $ref: '#/components/schemas/item_keys' description: Removed hardlink keys list. hardlink_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed hardlinks count. fact_keys: $ref: '#/components/schemas/item_keys' description: Removed fact keys list. fact_keys_count: $ref: '#/components/schemas/item_keys_count' description: Removed facts count. experiment_statistics: description: Experiment 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' unplanned_items: $ref: '#/components/schemas/unplanned_items' removed_items: $ref: '#/components/schemas/removed_items' required: - indicators - total_statistics - task_statistics - quality - data_statistics 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 nullable: true 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). business_validation_time: $ref: '#/components/schemas/time_duration' description: Business validation duration, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). math_validation_time: $ref: '#/components/schemas/time_duration' description: Math validation duration, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). waiting_time: $ref: '#/components/schemas/time_duration' description: Time to waiting for calculation, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). calculation_time: $ref: '#/components/schemas/time_duration' description: Actual calculation time, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). 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 nullable: true 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 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\ \ * `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 limitation must not overlap and their union must\ \ match the location availability window `work_window`; if the `min_cargos`/`min_transports`\ \ limitation is set, then the `max_cargos`/`max_transports` limitation must\ \ be set; the `min_cargos`/`min_transports` limits must be less than all the\ \ `max_cargos`/`max_transports` limits\n * `TOO_MANY_WARNINGS` - the number\ \ of warnings is greater than 15001\n" type: string enum: - INCONSISTENT_REFERENCE - UNIQUE_IDS_VIOLATION - INVALID_ROUTING_MATRIX - INVALID_GEO_PROVIDER - COMPATIBILITY_CARGO_BOX - COMPATIBILITY_TRANSPORT_PERFORMER - COMPATIBILITY_TRANSPORT_LOCATION - COMPATIBILITY_ORDER_PERFORMER - INCONSISTENT_HARDLINK - PLANNING_HORIZON_EXCEEDED - MEANINGLESS_RESTRICTIONS - LOCATION_LIMITS_VIOLATION - TOO_MANY_WARNINGS 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 nullable: true properties: entity_key: description: Target entity key. type: string nullable: true maxLength: 1024 example: order_0001 entity_type: $ref: '#/components/schemas/entity_type' child_entity: $ref: '#/components/schemas/entity_path' 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 nullable: true minLength: 0 maxLength: 2048 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' 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 `working_window` of the change of the artist does not\ \ lie entirely inside the window of availability `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 an order of type `DROP_FROM_BOX` the\ \ indicated cargoes are in boxes of different vehicles\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 `working_window`\ \ for changing the performer or transport 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" 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 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 nullable: true 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' experiment_check: description: The result of checking the data on the file. type: object additionalProperties: false nullable: true properties: logical_errors: $ref: '#/components/schemas/entity_error_list' warnings: $ref: '#/components/schemas/entity_warning_list' wave: description: Wave. type: object additionalProperties: false properties: key: $ref: '#/components/schemas/unique_key' specification: $ref: '#/components/schemas/wave_specification' settings: $ref: '#/components/schemas/experiment_settings' statistics: $ref: '#/components/schemas/experiment_statistics' calculation: $ref: '#/components/schemas/calculation_state' check: $ref: '#/components/schemas/experiment_check' 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: '2025-09-21T19:45:00Z' creation_date: description: 'Creation date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. ' type: string format: date-time example: '2025-09-21T19:45:00Z' required: - key - specification - settings - statistics - edit_date - creation_date table_wave_column_type: description: "Column name in the table with waves:\n * `ESSENCE_KEY` - entity\ \ key\n" type: string enum: - ESSENCE_KEY - SPECIFICATION_NAME - SPECIFICATION_COMMENT - SPECIFICATION_FOLDER_KEY default: SPECIFICATION_NAME example: SPECIFICATION_FOLDER_KEY table_wave_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_wave_column_type' datetime_range: $ref: '#/components/schemas/table_filter_datetime_range' int_range: $ref: '#/components/schemas/table_filter_int_range' float_range: $ref: '#/components/schemas/table_filter_float_range' duration_range: $ref: '#/components/schemas/table_filter_duration_range' bool_list: $ref: '#/components/schemas/table_filter_bool_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_list: $ref: '#/components/schemas/table_filter_string_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_wave_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_wave_filter' table_wave_fields: description: Wave fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: true specification_name: $ref: '#/components/schemas/table_string_search_field' x-filter-type: STRING_SEARCH x-default-enabled: true x-default-sort-direction: ASC specification_comment: $ref: '#/components/schemas/table_string_search_field' x-filter-type: STRING_SEARCH x-default-enabled: true specification_folder_key: $ref: '#/components/schemas/table_string_search_field' x-filter-type: STRING_SEARCH x-default-enabled: true table_wave: description: Wave (table). type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_wave_fields' required: - fields table_wave_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_wave' counters: $ref: '#/components/schemas/table_list_counters' required: - essences - counters file_xlsx: description: File with data in [XLSX](https://en.wikipedia.org/wiki/Microsoft_Excel) format. type: string format: byte custom_400_with_errors_and_warnings: description: 400 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error message. type: string nullable: true example: bad task data 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 capacity_limit: description: Capacity limits. type: object additionalProperties: false nullable: true 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 location_cargos_limit: description: 'Limiting the location''s ability to handle cargo. ' type: object additionalProperties: false nullable: 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 nullable: false minItems: 0 maxItems: 5 items: $ref: '#/components/schemas/location_cargos_limit' location_transports_limit: description: 'Limiting the location''s ability to serve transport. ' type: object additionalProperties: false nullable: 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 nullable: false minItems: 0 maxItems: 5 items: $ref: '#/components/schemas/location_transports_limit' 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' 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' location_compatibilities: description: 'Location [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true properties: transport_restrictions: description: 'List of transport requirements. Used to check whether the transport is compatible with the location. ' $ref: '#/components/schemas/compatibility_tag_list' 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). departure_duration: $ref: '#/components/schemas/time_duration' description: Time to leave the location according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). timetable: $ref: '#/components/schemas/location_timetable' compatibilities: $ref: '#/components/schemas/location_compatibilities' name: $ref: '#/components/schemas/name' attributes: $ref: '#/components/schemas/attributes' required: - key - geopoint location_list: description: List of locations used for orders and shifts. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/location' 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" nullable: false type: string enum: - PICKUP - DROP - WORK - PICKUP_TO_BOX - DROP_FROM_BOX example: WORK cargo_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 minItems: 0 maxItems: 1000 uniqueItems: true items: description: Cargo key. type: string minLength: 1 maxLength: 1024 example: - cargo01 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: description: Event key, unique identifier. type: string minLength: 1 maxLength: 1024 example: event_1 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 [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). 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: $ref: '#/components/schemas/time_window' default: null 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. ' 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: description: Demand key, unique identifier. type: string minLength: 1 maxLength: 1024 example: demand_1 demand_type: $ref: '#/components/schemas/demand_type' target_cargos: $ref: '#/components/schemas/cargo_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 example: 1 default: 0 precedence_in_order: description: Precedence within an order, 0 - the precedence is not taken into account. type: integer format: int32 minimum: 0 maximum: 15001 example: 1 default: 0 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 example: 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.\n\ \nMore about [cargo placement](#section/Description/Cargo-placement)." type: array minItems: 0 maxItems: 4 uniqueItems: true default: [] items: $ref: '#/components/schemas/cargo_rotation_type' example: - ALL cargo_compatibilities: description: 'Cargo [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true 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: description: 'A list of necessary restrictions for the transport box in which this cargo can be transported. ' $ref: '#/components/schemas/compatibility_tag_list' cargo_features: 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. ' $ref: '#/components/schemas/compatibility_tag_list' cargo_restrictions: 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. ' $ref: '#/components/schemas/compatibility_tag_list' 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: $ref: '#/components/schemas/capacity' description: Cargo additive measures. compatibilities: $ref: '#/components/schemas/cargo_compatibilities' 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 minLength: 1 maxLength: 1024 nullable: true default: null example: box01 required: - key order_compatibilities: description: 'Order [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true properties: order_features: description: 'Order features list. Used to check the compatibility of an order with other orders. Incompatible orders cannot be planned on the same trip. ' $ref: '#/components/schemas/compatibility_tag_list' order_restrictions: 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. ' $ref: '#/components/schemas/compatibility_tag_list' performer_restrictions: description: 'A list of necessary requirements for the performer who can fulfill this order. ' $ref: '#/components/schemas/compatibility_tag_list' performer_blacklist: description: 'A list of requirements that the performer is not allowed to have. This list should not intersect with `performer_restrictions`. ' $ref: '#/components/schemas/compatibility_tag_list' order: description: The order for delivery/transportation, contains a list of demands. type: object additionalProperties: false properties: key: description: Order key, unique identifier. type: string minLength: 1 maxLength: 1024 example: order01 demands: description: Demands list. type: array uniqueItems: true minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/demand' cargos: 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 default: [] items: $ref: '#/components/schemas/cargo' compatibilities: $ref: '#/components/schemas/order_compatibilities' name: $ref: '#/components/schemas/name' attributes: $ref: '#/components/schemas/attributes' required: - key - demands 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_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_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 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_time: description: Fact creation time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. type: string format: date-time example: '2025-09-21T09:30:00+03:00' fact_type: description: "Possible order (demand) fact types:\n * `NEW_LOCATION` - the\ \ performer changed his location during the trip\n * `ORDER_DONE` - the performer\ \ has finished fulfilling the order (or the order has been cancelled), the\ \ cargo associated with the order is no longer in the transport box\n * `DEMAND_START`\ \ - performer started to fulfill the demand\n * `DEMAND_DONE` - performer\ \ finished to fulfill the demand\n" type: string enum: - NEW_LOCATION - ORDER_DONE - DEMAND_START - DEMAND_DONE example: NEW_LOCATION fact: description: 'The fact about the order is the action taken with the order or its part (demand). ' type: object additionalProperties: false properties: key: description: Fact key. type: string minLength: 1 maxLength: 1024 example: fact_01 time: $ref: '#/components/schemas/fact_time' type: $ref: '#/components/schemas/fact_type' trip_key: description: Trip key, to which the fact relates. type: string minLength: 1 maxLength: 1024 example: trip_01 order_key: description: Order key, required for facts with type `ORDER_DONE`. type: string minLength: 1 maxLength: 1024 nullable: true default: null example: order_01 demand_key: description: Demand key, required for facts with types `DEMAND_DONE` and `DEMAND_START`. type: string minLength: 1 maxLength: 1024 nullable: true default: null example: order_01_demand_01 performer_key: description: Performer key, required for facts with type `NEW_LOCATION`. type: string minLength: 1 maxLength: 1024 nullable: true default: null example: performer_01 location_key: description: Location key, required for facts with type `NEW_LOCATION`. type: string minLength: 1 maxLength: 1024 nullable: true default: null example: location_01 attributes: $ref: '#/components/schemas/attributes' required: - key - time - type - trip_key fact_list: description: 'Trip list. A fact is an event that has occurred that affects further trip operations. ' type: array uniqueItems: true minItems: 0 maxItems: 15001 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 nullable: true 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' plan_statistics: description: 'General statistics on the calculation result. ' type: object additionalProperties: false nullable: true 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 nullable: true 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 minItems: 2 maxItems: 15001 uniqueItems: false 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 minItems: 2 maxItems: 15001 uniqueItems: false 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 minItems: 2 maxItems: 15001 uniqueItems: false 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: $ref: '#/components/schemas/plan_statistics' 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' table_trip_column_type: description: "Column name in the table with trips:\n * `ESSENCE_KEY` - entity\ \ key\n" type: string enum: - ESSENCE_KEY - TRIP_NAME - CREW_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 - ATTRIBUTES - CUSTOMFIELDS default: TRIP_NAME example: DISTANCE table_customfields_column_type: description: 'The name of the additional column in the table. Used for filters of the `CUSTOMFIELDS` type. ' type: string nullable: true default: null enum: - DATETIME_1 - DATETIME_2 - DATETIME_3 - DATETIME_4 - DATETIME_5 - INT_1 - INT_2 - INT_3 - INT_4 - INT_5 - FLOAT_1 - FLOAT_2 - FLOAT_3 - FLOAT_4 - FLOAT_5 - DURATION_1 - DURATION_2 - DURATION_3 - DURATION_4 - DURATION_5 - BOOL_1 - BOOL_2 - BOOL_3 - BOOL_4 - BOOL_5 - STRING_1 - STRING_2 - STRING_3 - STRING_4 - STRING_5 example: NONE 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: $ref: '#/components/schemas/table_customfields_column_type' datetime_range: $ref: '#/components/schemas/table_filter_datetime_range' int_range: $ref: '#/components/schemas/table_filter_int_range' float_range: $ref: '#/components/schemas/table_filter_float_range' duration_range: $ref: '#/components/schemas/table_filter_duration_range' bool_list: $ref: '#/components/schemas/table_filter_bool_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_list: $ref: '#/components/schemas/table_filter_string_list' string_search: $ref: '#/components/schemas/table_filter_string_search' 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' table_trip: description: Trip. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_trip_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_trip_fields' required: - fields - elements table_trip_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_trip' counters: $ref: '#/components/schemas/table_list_counters' required: - essences - counters basic_essence_key_list: description: List of essence keys. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/basic_essence_key' 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 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 format: date-time nullable: true default: null example: '2025-09-21T09:30:00+03:00' required: - latitude - longitude geotrack: description: An array of geographic points with time reference between which a path is built. type: array minItems: 0 maxItems: 1000000 uniqueItems: false items: $ref: '#/components/schemas/trackpoint' track: description: Track for map. type: object additionalProperties: false properties: geotrack: $ref: '#/components/schemas/geotrack' trip_key: description: Trip key, unique identifier. type: string minLength: 1 maxLength: 1024 example: trip_01 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 basic_enabled: description: Using essence for calculations. type: boolean default: true example: false readOnly: 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 example: false readOnly: true table_fact_fields: description: Fact fields for table. type: object additionalProperties: false readOnly: true properties: essence_type: description: Essence type. type: string nullable: false 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: false type: string nullable: true default: null minLength: 1 maxLength: 64 example: NEW_LOCATION order_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: false demand_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: false performer_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH x-default-enabled: true location_key: $ref: '#/components/schemas/basic_essence_key_null' x-filter-type: STRING_SEARCH 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 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 - ORDER_KEY - DEMAND_KEY - PERFORMER_KEY - LOCATION_KEY - 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: $ref: '#/components/schemas/table_customfields_column_type' datetime_range: $ref: '#/components/schemas/table_filter_datetime_range' int_range: $ref: '#/components/schemas/table_filter_int_range' float_range: $ref: '#/components/schemas/table_filter_float_range' duration_range: $ref: '#/components/schemas/table_filter_duration_range' bool_list: $ref: '#/components/schemas/table_filter_bool_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_list: $ref: '#/components/schemas/table_filter_string_list' string_search: $ref: '#/components/schemas/table_filter_string_search' 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' table_fact: description: Fact. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_fact_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_fact_fields' required: - fields - elements table_fact_list: description: A list of facts. type: object additionalProperties: false properties: essences: description: A list of facts. type: array uniqueItems: false minItems: 0 maxItems: 2001 items: $ref: '#/components/schemas/table_fact' counters: $ref: '#/components/schemas/table_list_counters' required: - essences - counters 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 nullable: true 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 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 - FACT - TRIP_STOP example: LOCATION translations: description: Object field translations. 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: Number 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: $ref: '#/components/schemas/table_customfields_column_type' 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 file_json: description: File with data in [JSON](https://www.json.org/) format. type: string parameters: folder_key: name: folder_key description: Folder key, unique identifier. in: query required: false schema: $ref: '#/components/schemas/unique_key_null' 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 nullable: false enum: - ASC - DESC default: ASC example: DESC folder_key-2: name: 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' wave_key: name: wave_key description: Key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/unique_key' table_wave_column: name: sort_field description: 'Wave table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_wave_column_type' timezone: name: timezone description: Target time zone. in: query required: false schema: $ref: '#/components/schemas/timezone' essence_key: name: essence_key description: Key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/basic_essence_key' table_trip_column: name: sort_field description: 'Trip table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_trip_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' 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_fact_column: name: sort_field description: 'Fact table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_fact_column_type' settings_key: name: settings_key description: User settings key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/settings_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' '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/custom_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 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: '2025-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: '2025-09-15T13:56:07.697Z' to: '2025-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: '2025-09-21T09:30:00+03:00' to: '2025-09-21T19:45:00Z' data_statistics: locations: 958 orders: 1000 performers: 1000 transports: 1000 hardlinks: 0 trips: 0 facts: 1 external_routing: false edit_date: '2025-09-15T13:56:07.728Z' creation_date: '2025-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 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: '2025-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: [] UniversalData: summary: Experiment 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: '2025-09-08T05:00:00+00:00' to: '2025-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: '2025-09-07T21:00:00+00:00' to: '2025-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: '2025-09-08T05:00:00+00:00' to: '2025-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: '2025-09-07T21:00:00+00:00' to: '2025-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: '2025-09-08T05:00:00+00:00' to: '2025-09-08T07:00:00+00:00' performers: - key: performer_1 shifts: - key: performer_1_shift availability_time: from: '2025-09-07T21:00:00+00:00' to: '2025-09-08T20:59:59+00:00' working_time: from: '2025-09-07T21:00:00+00:00' to: '2025-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: '2025-09-07T21:00:00+00:00' to: '2025-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: '2025-09-08T04:38:34Z' to: '2025-09-08T05:53:39Z' transport: transport_key: transport_1 shift_key: transport_1_shift shift_time: from: '2025-09-08T04:38:34Z' to: '2025-09-08T05:53:39Z' states: - time: '2025-09-08T04:38:34Z' flags: - INSIDE_LOCATION - AROUND_LOCATION location_key: location_storage cargo_actions: [] attributes: [] - time: '2025-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: '2025-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: '2025-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: '2025-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: '2025-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: '2025-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: '2025-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: '2025-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: '2025-09-08T05:10:00Z' flags: - RELOCATING cargo_actions: - box_key: box_1 cargo_key: order_1_cargos cargo_action_type: ADD attributes: [] - time: '2025-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: '2025-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: '2025-09-08T05:30:52Z' flags: - INSIDE_LOCATION - AROUND_LOCATION location_key: location_client_1 cargo_actions: [] attributes: [] - time: '2025-09-08T05:30:52Z' flags: - RELOCATING cargo_actions: [] attributes: [] - time: '2025-09-08T05:38:39Z' flags: - INSIDE_LOCATION - AROUND_LOCATION location_key: location_client_3 cargo_actions: [] attributes: [] - time: '2025-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: '2025-09-08T05:53:39Z' flags: - INSIDE_LOCATION - AROUND_LOCATION location_key: location_client_3 cargo_actions: [] attributes: [] waitlist: [] attributes: [] EmptyTableList: summary: Empty table list value: essences: [] counters: overall: total: 0 filter: total: 0 TrackList: summary: Trip track list value: tracks: - geotrack: - latitude: 55.692789 longitude: 37.554554 time: '2025-09-21T09:30:00+03: 00' - latitude: 55.692788 longitude: 37.55467 time: '2025-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 FactNewLocation: summary: Fact of location update value: key: fact_01 type: NEW_LOCATION time: '2025-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: NEW_LOCATION time: '2025-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 Customfields: summary: Customfields 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 - name: Datasets tags: - Waves - Locations - Orders - Performers - Transports - Hardlinks - Trips - Facts - name: Operational control tags: - Analytics - Reports - name: Customization tags: - User - CustomFields - CustomIcons - name: Maintenance tags: - System