openapi: 3.0.3 info: title: VRt.Studio [ST] version: 6.20.2252 license: name: Proprietary url: https://veeroute.zh/ termsOfService: https://veeroute.zh/resources/terms_of_service contact: name: Veeroute Support Team email: servicedesk@veeroute.com x-logo: url: ../images/studio.svg backgroundColor: '#FAFAFA' altText: VRt.Studio description: 'Veeroute Studio API. # Description Server part of the Veeroute Studio. ## Entity relationship diagram ![erd](../uml/studio.svg)' servers: - url: https://api.edge.veeroute.tech description: 用于集成和早期访问新功能的环境 - url: https://api.prod.veeroute.com description: 生产环境 security: - ApiKeyAuth: [] tags: - name: Explorer description: 'Folders management. ' - name: Experiments description: "Experiments management. \n" - name: Locations description: "Locations management. \n" - 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: System description: '系统功能。 所有服务共有的辅助功能。 ' externalDocs: description: 主站点 url: https://veeroute.zh/ paths: /studio/explorer: post: tags: - Explorer summary: Create folder description: Create new folder. operationId: create_folder requestBody: description: Folder create request. 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_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' get: tags: - Explorer summary: Getting a filesystem description: 'Getting a filesystem. ' operationId: read_filesystem responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/filesystem' examples: DataExplorer: $ref: '#/components/examples/DataExplorer' '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' /studio/explorer/{folder_key}: parameters: - $ref: '#/components/parameters/folder_key' get: tags: - Explorer summary: Experiment list description: 'Getting a experiments list. ' operationId: read_folder parameters: - $ref: '#/components/parameters/filter' description: 'Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter. ' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment_list' examples: ExperimentList: $ref: '#/components/examples/ExperimentList' '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' put: tags: - Explorer summary: Update folder description: Rename \ move folder. operationId: update_folder 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_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' delete: tags: - Explorer summary: Folder removal description: Folder removal by key. operationId: delete_folder responses: '204': description: Successful execution '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' /studio/explorer/search/global: get: tags: - Explorer summary: Experiment search description: Experiment global search. operationId: global_search parameters: - $ref: '#/components/parameters/filter' description: 'Filter for searching by text fields - only those experiments are returned whose name or description contains a substring from the filter. ' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/sort_direction' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment_list' examples: ExperimentList: $ref: '#/components/examples/ExperimentList' '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' /studio/experiments: post: tags: - Experiments summary: Create experiment description: Create new experiment. operationId: create_experiment requestBody: description: Experiment create request. required: true content: application/json: schema: $ref: '#/components/schemas/experiment_specification' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/unique_key' description: New experiment key. '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' /studio/experiments/{experiment_key}: parameters: - $ref: '#/components/parameters/experiment_key' get: tags: - Experiments summary: Reading experiment description: Getting experiment information by key. operationId: read_experiment responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' examples: Experiment: $ref: '#/components/examples/Experiment' '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' put: tags: - Experiments summary: Experiment update description: Rename \ move experiment. operationId: update_experiment requestBody: description: Experiment specification update request. required: true content: application/json: schema: $ref: '#/components/schemas/experiment_specification' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' delete: tags: - Experiments summary: Experiment removal description: Experiment removal by key. operationId: delete_experiment responses: '204': description: Successful execution '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' /studio/experiments/{experiment_key}/duplication: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Experiments summary: Experiment duplicate description: Experiment duplicate. operationId: duplicate_experiment requestBody: description: Experiment duplicate request. required: true content: application/json: schema: $ref: '#/components/schemas/experiment_specification' description: Parameters of the new experiment that will result from duplication. responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/unique_key' description: Duplicated experiment key. '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' /studio/experiments/{experiment_key}/settings: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Experiments summary: Settings update description: Settings update. operationId: update_experiment_settings requestBody: description: Experiment settings update request. required: true content: application/json: schema: $ref: '#/components/schemas/experiment_settings' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/indicators: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Experiments summary: Indicators update description: Updating the experiment indicators. operationId: update_experiment_indicators requestBody: description: Indicators update request. required: true content: application/json: schema: $ref: '#/components/schemas/indicators' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/calculation/{process_name}: post: tags: - Experiments summary: Run calculation description: Experiment calculation run. operationId: run_experiment_calculation parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/process_name' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' examples: Experiment: $ref: '#/components/examples/Experiment' '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' /studio/experiments/{experiment_key}/calculation: delete: tags: - Experiments summary: Calculation stop description: Calculation stop. operationId: stop_experiment_calculation parameters: - $ref: '#/components/parameters/experiment_key' responses: '204': description: Successful execution - calculation has been canceled '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' /studio/experiments/{experiment_key}/validation/{process_name}: post: tags: - Experiments summary: Run validation description: Experiment validation run. operationId: run_experiment_validation parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/process_name' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' examples: Experiment: $ref: '#/components/examples/Experiment' '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' /studio/experiments/{experiment_key}/import/xlsx: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Experiments summary: Import (XLSX) description: 'Import (XLSX). ' operationId: import_xlsx parameters: - $ref: '#/components/parameters/timezone' requestBody: description: Data (XLSX). required: true content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: $ref: '#/components/schemas/file_xlsx' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/import/json: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Experiments summary: Import (JSON) description: 'Importing new data from a VRt.Universal JSON file. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created. ' operationId: import_json requestBody: description: Data (JSON). required: true content: application/json: schema: $ref: '#/components/schemas/universal_data' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/import/json_url: post: tags: - Experiments summary: Import by URL (JSON) description: 'Importing new data from a VRt.Universal JSON file by url. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created. ' operationId: import_json_url parameters: - $ref: '#/components/parameters/experiment_key' - name: url description: Url to json file. in: query required: true schema: description: Url. type: string format: uri example: https://docs.edge.veeroute.tech/assets/files/case_1.json responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/import/json_tracecode/{source}/{tracecode}/{sample}: post: tags: - Experiments summary: Import by tracecode description: 'Importing new data from a VRt.Universal JSON file by tracecode. If the entity is already present in the experiment (determined by its key), it is updated, if not, a new one is created. ' operationId: import_json_tracecode parameters: - $ref: '#/components/parameters/experiment_key' - name: source description: Source. in: path required: true schema: $ref: '#/components/schemas/import_source' - $ref: '#/components/parameters/tracecode' - name: sample description: Sample of loaded data - input task or input task + calculation result. in: path required: true schema: $ref: '#/components/schemas/import_sample' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/experiment' '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' /studio/experiments/{experiment_key}/export/xlsx: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Experiments summary: Export (XLSX) description: Export (XLSX). operationId: export_xlsx parameters: - $ref: '#/components/parameters/timezone' responses: '200': description: Successful execution content: application/octet-stream: schema: $ref: '#/components/schemas/file_xlsx' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/export/json: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Experiments summary: Export (JSON) description: 'Export data from the experiment to a VRt.Universal JSON file. ' operationId: export_json responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/universal_data' '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' /studio/experiments/{experiment_key}/locations/batch/list: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Locations summary: Locations list description: Getting a locations list. operationId: read_locations parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_location_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: locations filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_location_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_location_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/locations: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Locations summary: Create location description: Create location. operationId: create_location requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_location' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_location' '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' put: tags: - Locations summary: Update location description: Updating the location by key. operationId: update_location requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_location' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_location' '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' /studio/experiments/{experiment_key}/locations/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Locations summary: Read location description: Getting location information by key. operationId: read_location responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_location' '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' delete: tags: - Locations summary: Remove location description: Removing a location by key. operationId: delete_location responses: '204': description: Successful execution - location deleted '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' /studio/experiments/{experiment_key}/locations/batch/geopoints: post: tags: - Locations summary: Location geopoints description: Getting a geopoints. operationId: read_locations_geopoints parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' requestBody: description: Locations filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_location_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_location_geopoint_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/performers/batch/list: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Performers summary: Performers list description: Getting a performers list. operationId: read_performers parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_performer_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Performers filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_performer_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_performer_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/performers: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Performers summary: Create performer description: Create performer. operationId: create_performer requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_performer' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_performer' '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' put: tags: - Performers summary: Update performer description: Updating the performer by key. operationId: update_performer requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_performer' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_performer' '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' /studio/experiments/{experiment_key}/performers/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Performers summary: Read performer description: Getting performer information by key. operationId: read_performer responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_performer' '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' delete: tags: - Performers summary: Remove performer description: Removing a performer by key. operationId: delete_performer responses: '204': description: Successful execution - performer deleted '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' /studio/experiments/{experiment_key}/performers/batch/geopoints: post: tags: - Performers summary: Performer geopoints description: Getting a geopoints. operationId: read_performers_geopoints parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' requestBody: description: Performers filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_performer_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_performer_geopoint_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/performers/batch/ability: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Performers summary: Enable performers description: Enable performers in the calculation. operationId: enable_performers requestBody: description: Enable performers request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' delete: tags: - Performers summary: Disable performers description: Disable performers in the calculation. operationId: disable_performers requestBody: description: Disable performers request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' /studio/experiments/{experiment_key}/transports/batch/list: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Transports summary: Transport list description: Getting a transport list. operationId: read_transports parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_transport_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Transport filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_transport_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_transport_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/transports: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Transports summary: Create transport description: New essences creation. operationId: create_transport requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_transport' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_transport' '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' put: tags: - Transports summary: Update transport description: Updating the essence by key. operationId: update_transport requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_transport' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_transport' '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' /studio/experiments/{experiment_key}/transports/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Transports summary: Reading transport description: Getting transport information by key. operationId: read_transport responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_transport' '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' delete: tags: - Transports summary: Remove transport description: Removing a transport by key. operationId: delete_transport responses: '204': description: Successful execution - transport deleted '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' /studio/experiments/{experiment_key}/transports/batch/geopoints: post: tags: - Transports summary: Transport geopoints description: Getting a geopoints. operationId: read_transports_geopoints parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' requestBody: description: Transports filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_transport_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_transport_geopoint_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/transports/batch/ability: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Transports summary: Enable transports description: Enable transports in the calculation. operationId: enable_transports requestBody: description: Enable transports request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' delete: tags: - Transports summary: Disable transports description: Disable transports in the calculation. operationId: disable_transports requestBody: description: Disable transports request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' /studio/experiments/{experiment_key}/orders/batch/list: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Orders summary: List orders description: Getting a orders list. operationId: read_orders parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_order_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Essence filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_order_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_order_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/orders: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Orders summary: Create order description: New essences creation. operationId: create_order requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_order' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_order' '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' put: tags: - Orders summary: Update order description: Updating the essence by key. operationId: update_order requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_order' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_order' '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' /studio/experiments/{experiment_key}/orders/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Orders summary: Reading order description: Getting order information by key. operationId: read_order responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_order' '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' delete: tags: - Orders summary: Order removal description: Removing a essence by key. operationId: delete_order responses: '204': description: Successful execution - essence deleted '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' /studio/experiments/{experiment_key}/orders/batch/geopoints: post: tags: - Orders summary: Order geopoints description: Getting a geopoints. operationId: read_orders_geopoints parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' requestBody: description: Orders filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_order_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_order_geopoint_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/orders/batch/ability: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Orders summary: Enable orders description: Enable orders in the calculation. operationId: enable_orders requestBody: description: Enable orders request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' delete: tags: - Orders summary: Disable orders description: Disable orders in the calculation. operationId: disable_orders requestBody: description: Disable orders request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' /studio/experiments/{experiment_key}/hardlinks/batch/list: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Hardlinks summary: List hardlinks description: Getting a hardlinks list. operationId: read_hardlinks parameters: - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_hardlink_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Hardlinks filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_hardlink_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_hardlink_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/hardlinks: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Hardlinks summary: Create hardlink description: Create new hardlink. operationId: create_hardlink requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_hardlink' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_hardlink' '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' put: tags: - Hardlinks summary: Update hardlink description: Updating the hardlink by key. operationId: update_hardlink requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_hardlink' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_hardlink' '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' /studio/experiments/{experiment_key}/hardlinks/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Hardlinks summary: Read hardlink description: Getting hardlink information by key. operationId: read_hardlink responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_hardlink' '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' delete: tags: - Hardlinks summary: Remove hardlink description: Removing a essence by key. operationId: delete_hardlink responses: '204': description: Successful execution - essence deleted '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' /studio/experiments/{experiment_key}/hardlinks/batch/ability: parameters: - $ref: '#/components/parameters/experiment_key' put: tags: - Hardlinks summary: Enable hardlinks description: Enable hardlinks in the calculation. operationId: enable_hardlinks requestBody: description: Enable hardlinks request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' delete: tags: - Hardlinks summary: Disable hardlinks description: Disable hardlinks in the calculation. operationId: disable_hardlinks requestBody: description: Disable hardlinks request. required: true content: application/json: schema: $ref: '#/components/schemas/basic_essence_key_list' responses: '204': description: Successful execution '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' /studio/experiments/{experiment_key}/trips/batch/list: post: tags: - Trips summary: Trip list description: Getting a trips list. operationId: read_trips parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_trip_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Trip filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_trip_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/table_trip_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/trips: parameters: - $ref: '#/components/parameters/experiment_key' post: tags: - Trips summary: Trip create description: New essences creation. operationId: create_trip requestBody: description: New essence creation request. required: true content: application/json: schema: $ref: '#/components/schemas/web_trip' responses: '201': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip' '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' put: tags: - Trips summary: Trip update description: Updating the essence by key. operationId: update_trip requestBody: description: Essence update request. required: true content: application/json: schema: $ref: '#/components/schemas/web_trip' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip' '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' /studio/experiments/{experiment_key}/trips/{essence_key}: parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/essence_key' get: tags: - Trips summary: Read trip description: Getting trip information by key. operationId: read_trip responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip' '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' delete: tags: - Trips summary: Remove trip description: Removing a trip by key. operationId: delete_trip responses: '204': description: Successful execution - trip deleted '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' /studio/experiments/{experiment_key}/trips/batch/tracks/{tracks_type}: post: tags: - Trips summary: Trip tracks description: Getting a tracks. operationId: read_trips_tracks parameters: - $ref: '#/components/parameters/experiment_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' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip_track_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/experiments/{experiment_key}/trips/batch/charts: post: tags: - Trips summary: Trips chart description: Getting a trips for chart. operationId: read_trips_charts parameters: - $ref: '#/components/parameters/experiment_key' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/table_trip_column' - $ref: '#/components/parameters/sort_direction' requestBody: description: Trips filter. required: false content: application/json: schema: $ref: '#/components/schemas/table_trip_filter_list' responses: '200': description: Successful execution content: application/json: schema: $ref: '#/components/schemas/web_trip_chart_list' '400': $ref: '#/components/responses/400_with_errors_and_warnings' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '406': $ref: '#/components/responses/406' '415': $ref: '#/components/responses/415' '429': $ref: '#/components/responses/429' '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' /studio/system/check: get: tags: - System summary: 检查服务可用性 description: 检查服务可用性。 operationId: check 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' /studio/system/version: get: tags: - System summary: 获取服务版本 description: 获取服务版本。 operationId: version 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' /studio/file/{filename}: parameters: - $ref: '#/components/parameters/filename' get: tags: - System summary: 检查服务可用性 description: 检查服务可用性。 operationId: file security: [] 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: '对于客户端 [认证](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) [JWT 令牌](https://en.wikipedia.org/wiki/JSON_Web_Token) 被使用, 必须在每个请求的标头中以以下格式指定: `授权:承载 `。 Token 可以通过 VRt.Account API 获取。 ' type: http scheme: bearer bearerFormat: JWT responses: '401': description: 'Unauthorized - token missing or invalid ' content: application/json: schema: $ref: '#/components/schemas/general_401' '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' schemas: 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_stats: description: 'Current folder statistics. ' type: object additionalProperties: false properties: folders_count: description: The number of subfolders. type: integer format: int32 minimum: 0 maximum: 10001 example: 12 experiments_count: description: The number of experiments. type: integer format: int32 minimum: 0 maximum: 10001 example: 16 required: - folders_count - experiments_count filesystem: description: 'File system. Only one object can be of type ROOT. ' type: object additionalProperties: false properties: key: $ref: '#/components/schemas/unique_key' type: $ref: '#/components/schemas/folder_type' name: description: Folder name. type: string minLength: 1 maxLength: 100 example: folder_1 statistics: $ref: '#/components/schemas/folder_stats' elements: description: A list of child's elements. type: array readOnly: true uniqueItems: false minItems: 0 maxItems: 101 items: $ref: '#/components/schemas/filesystem' required: - key - type - name - statistics service_name: description: Service name. type: string enum: - UNIVERSAL - ROUTING - ACCOUNT - ADMIN - STUDIO - MONITOR - PACKER - AGRO - STOCK - LONGHAUL - CLUSTER - CARGOTIMETABLE example: UNIVERSAL operation_id: description: Operation identifier. type: string minLength: 3 maxLength: 256 example: run_plan_calculation tracedata: description: Data for request tracing. type: object additionalProperties: false properties: code: description: 'Unique process identifier. If an asynchronous process is running, then the code for it will be the same, although other fields may differ. ' type: string format: uuid example: 11111111-2222-3333-4444-555555555555 client: description: 'The unique identifier of the client (`company_key` + `_|_` + `username`) that made the request. ' type: string pattern: \w+ minLength: 2 maxLength: 256 example: company_|_username server: description: Server identifier. type: string pattern: \w+ minLength: 2 maxLength: 256 example: server_name service: $ref: '#/components/schemas/service_name' operation: $ref: '#/components/schemas/operation_id' 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: '2024-02-21T09:30:00+03:00' required: - code - client - server - service - operation - 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: Errors list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/schema_error' example: [] 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)\n * `TOO_MANY_WARNINGS`\ \ - the number of warnings is greater than 15,000\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 - 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 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 * `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`\ \ - performer's work shifts should not intersect\n * `TRANSPORT_SHIFTS_INTERSECTION_VIOLATION`\ \ - transport's work shifts should not intersect\n * `LOCATION_WINDOWS_INTERSECTION_VIOLATION`\ \ - time ranges of working windows of locations should not intersect\n *\ \ `INVALID_LOCATION_DURATIONS` - location has a working window that is less\ \ than the sum of the times `arrival + departure`\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 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 compartment 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 compartments of different vehicles\n * `CARGO_CAPACITY_VIOLATION`\ \ - the specified cargo on board exceeds the size of the compartment 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" type: string enum: - NO_AVAILABLE_TRANSPORT - NO_AVAILABLE_PERFORMER - NO_COMPATIBLE_TRANSPORT - NO_COMPATIBLE_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 - INVALID_LOCATION_DURATIONS - 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 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' example: [] 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 general_401: description: 401 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error details. type: string nullable: true example: Unauthorized required: - tracedata general_402: description: 402 Error details. type: object additionalProperties: false properties: tracedata: $ref: '#/components/schemas/tracedata' message: description: Error details. 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 details. type: string nullable: true example: Forbidden required: - tracedata general_404: description: 404 Error details. type: object additionalProperties: false properties: resource_id: description: Resource identifier. type: string nullable: true default: null example: resource_id 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 details. 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 details. type: string nullable: true example: Internal Server Error required: - tracedata folder_specification: description: New folder request. type: object additionalProperties: false properties: parent_key: $ref: '#/components/schemas/unique_key' description: Key of the folder in which the new folder will be created. name: description: New folder name. type: string minLength: 1 maxLength: 100 example: folder_1_new required: - parent_key - name experiment_specification: description: Experiment description. type: object additionalProperties: false properties: name: description: Experiment name. type: string minLength: 1 maxLength: 100 example: Exp_1 comment: description: Experiment 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: 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 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_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\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_GARBAGE_1 - TRUCK_GARBAGE_2 - TUK_TUK - BICYCLE - PEDESTRIAN - PUBLIC_TRANSPORT default: CAR example: CAR transport_factor: 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 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 compartments 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 compartment). ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 1 capacity_b: description: 'Additional parameter (B) for measuring cargoes and compartments 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 compartments in alternative units. ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 3 capacity_factor: 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' required: - transport_type - capacity 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: P1Y1M1DT2H12M34.3S 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 nullable: true default: null minLength: 1 maxLength: 1024 example: demand01.1 performer_key: description: Performer's key. type: string minLength: 1 maxLength: 1024 example: performer0001 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 - performer_key - additional_duration compatibility_tag: description: Tag used to determine [compatibility](#section/Description/Compatibilities). type: string minLength: 1 maxLength: 256 example: B1 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: '2024-02-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: '2024-02-21T19:45:00Z' required: - from - to feature_lifetime: description: Tag life time window. type: object additionalProperties: false properties: feature: $ref: '#/components/schemas/compatibility_tag' time_windows: description: 'A list of time windows within which the specified tag exists. If compatibility is affected by several features with different windows - entities will be considered compatible within the intersection of windows. ' type: array minItems: 0 maxItems: 4 default: [] 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: 1000 default: [] uniqueItems: true items: $ref: '#/components/schemas/feature_lifetime' trip_assumptions: description: 'Planning assumptions. Designed to adjust the business logic of planning and mass change of input data. ' type: object additionalProperties: false properties: transport_factor: description: Transport speed change coefficients. type: array minItems: 0 maxItems: 12 default: [] uniqueItems: true items: $ref: '#/components/schemas/transport_factor' capacity_factor: description: 'Transport capacity change coefficients. Change the `capacity` parameters for all boxes and `max_capacity` for the transport. ' type: array minItems: 0 maxItems: 12 default: [] uniqueItems: true items: $ref: '#/components/schemas/capacity_factor' demands_extra_duration: description: 'List of additional execution times for the demands by certain performers. Valid for the specified performer-order pair for all performer''s shifts all order execution options. ' type: array minItems: 0 maxItems: 15001 default: [] uniqueItems: true items: $ref: '#/components/schemas/demand_extra_duration' feature_lifetimes: deprecated: true description: 'List of feature lifetime. Affects only on compatibility Performer-Order and Transport-Location. ' $ref: '#/components/schemas/feature_lifetime_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 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. When taking into account the violation of compatibility with the location, the penalty is applied for each stop at the location. ' 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 trip_penalties: description: 'Planning penalties - ability to disrupt a part of the planning business rules. ' type: object additionalProperties: false properties: compatibilities: description: Penalties for compatibility violation. type: array uniqueItems: true minItems: 0 maxItems: 1000000 default: [] items: $ref: '#/components/schemas/compatibility_penalty' trips_settings: description: Trip creation settings. type: object additionalProperties: false properties: configuration: $ref: '#/components/schemas/plan_configuration' trip_start_time_strategy: $ref: '#/components/schemas/trip_start_time_strategy' assumptions: $ref: '#/components/schemas/trip_assumptions' penalties: $ref: '#/components/schemas/trip_penalties' geo_settings: description: 'Geodata usage settings. ' type: object additionalProperties: false properties: geo_provider: description: Geodata provider. type: string default: OSRM minLength: 1 maxLength: 256 example: OSRM 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 restricted_zones: description: 'List of restricted zones. ' type: array deprecated: true minItems: 0 maxItems: 5 uniqueItems: true default: [] items: description: Zone id. type: string minLength: 1 maxLength: 256 example: - ART_MOSCOW_MKAD_CARGO_FRAME 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: PT4M30S 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: description: 'The time zone where the calculation result is returned. ' type: integer format: int32 minimum: -12 maximum: 12 default: 0 example: 3 treat_warnings_as_errors: description: 'Treat warnings as errors. ' type: boolean default: false example: true precision: description: 'Specifies the calculation accuracy in the decimal point sequence number. It equals 2 by default, so the accuracy is 0.01. ' type: integer format: int32 minimum: 0 maximum: 6 default: 2 example: 3 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' 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' trips_settings: $ref: '#/components/schemas/trips_settings' geo_settings: $ref: '#/components/schemas/geo_settings' calculation_settings: $ref: '#/components/schemas/calculation_settings' 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 example: '2024-02-21T09:30:00+03:00' geo_settings: $ref: '#/components/schemas/geo_settings' calculation_settings: $ref: '#/components/schemas/calculation_settings' 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 measurements: description: 'Measurements of times and distances for work on location, individual trips and planning in general. ' type: object additionalProperties: false properties: driving_time: $ref: '#/components/schemas/time_duration' waiting_time: $ref: '#/components/schemas/time_duration' break_time: $ref: '#/components/schemas/time_duration' working_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 time_window: $ref: '#/components/schemas/time_window' required: - driving_time - waiting_time - break_time - working_time - arriving_time - departure_time - total_time - distance - time_window object_metrics: description: Objects metrics. type: object additionalProperties: false properties: keys: description: List of object's keys. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Object's key. type: string minLength: 1 maxLength: 1024 example: - obj1 count: description: The total number of objects. type: integer format: int32 minimum: 0 default: 0 maximum: 15001 example: 1700 time_window_violations: description: 'Statistics of time window violation. ' type: object additionalProperties: false properties: before: $ref: '#/components/schemas/object_metrics' description: Count and order's keys, what planned before permitted time window. after: $ref: '#/components/schemas/object_metrics' description: Count and order's keys, what planned after permitted time window. quality_statistics: description: 'Quality metrics. ' type: object additionalProperties: false properties: 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. statistics: description: 'General statistics for one or more trips. ' type: object additionalProperties: false properties: cost: description: 'Total costs calculated based on the performer''s and transport tariffs. The total cost is equal to the difference between the total reward (`reward`) and expenses (`cost`). ' type: number format: double minimum: 0 example: 1231.1 reward: description: The total reward for orders fulfillment. type: number format: double minimum: 0 example: 2343.3 measurements: $ref: '#/components/schemas/measurements' description: "Measurements of times and distances for for aggregate and\ \ individual trips:\n\n * `driving_time` - duration of driving time\n\ \ * `waiting_time` - total waiting time for all locations\n * `break_time`\ \ - total break time for all locations\n * `working_time` - total time\ \ of work execution at all locations included in the trip\n * `arriving_time`\ \ - total time to drive / park at locations\n * `departure_time` - total\ \ time for departure from locations\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 * `total_time` - total\ \ time, composed of `driving_time` + `waiting_time` + `break_time` + `working_time`\ \ + `arriving_time` + `departure_time`\n * `distance` - the total length\ \ of the 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 cargo_capacity_ratio: $ref: '#/components/schemas/capacity' 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' description: 'The ratio of the maximum load of boxes to the total capacity of boxes. In fractions of a unit. It cannot be more than one. ' quality: $ref: '#/components/schemas/quality_statistics' required: - cost - reward - measurements - trips_count - performers_count - orders_count - plan_orders_count - waitlist_orders_count - cargo_capacity_ratio - max_transport_load 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 external_routing: description: Using external routing. type: boolean example: false required: - locations - orders - performers - transports - hardlinks - trips - external_routing unplanned_items: description: Unplanned items list. type: object additionalProperties: false properties: order_keys: description: Unplanned order keys list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Key, unique identifier. type: string minLength: 1 maxLength: 1024 example: key_01 order_keys_count: description: Unplanned orders count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 99 performer_keys: description: Unplanned performer keys list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Key, unique identifier. type: string minLength: 1 maxLength: 1024 example: key_01 performer_keys_count: description: Unplanned performers count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 99 transport_keys: description: Unplanned transport keys list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Key, unique identifier. type: string minLength: 1 maxLength: 1024 example: key_01 transport_keys_count: description: Unplanned transports count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 99 hardlink_keys: description: Unplanned hardlink keys list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: description: Key, unique identifier. type: string minLength: 1 maxLength: 1024 example: key_01 hardlink_keys_count: description: Unplanned hardlinks count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 99 experiment_statistics: description: Experiment statistics. type: object additionalProperties: false properties: indicators: $ref: '#/components/schemas/indicators' total_statistics: $ref: '#/components/schemas/statistics' data_statistics: $ref: '#/components/schemas/table_data_stats' unplanned_items: $ref: '#/components/schemas/unplanned_items' required: - indicators - total_statistics - 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 start.\n * `IN_PROGRESS` - the calculation is in progress.\n * `FINISHED_IN_TIME`\ \ - the calculation was completed before the specified planning time.\n *\ \ `FINISHED_OUT_OF_TIME` - the calculation was completed because the specified\ \ planning time has expired.\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 * `FAILED` - the calculation failed with an error.\n" type: string enum: - WAITING - IN_PROGRESS - FINISHED_IN_TIME - FINISHED_OUT_OF_TIME - CANCELED - CANCELED_BY_TIMEOUT - FAILED example: FINISHED_IN_TIME calculation_info: description: Calculation information. type: object additionalProperties: false properties: status: $ref: '#/components/schemas/calculation_status' result_version: description: Planning result version. type: integer format: int32 minimum: 0 maximum: 1000000 example: 133 preparing_time: description: Time to prepare for calculation, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' business_validation_time: description: Business validation duration, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' math_validation_time: description: Math validation duration, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' waiting_time: description: Time to waiting for calculation, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' calculation_time: description: Actual calculation time, format [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' required: - status - result_version - preparing_time - business_validation_time - math_validation_time - waiting_time - calculation_time experiment_calculation: description: Experiment calculation details. type: object additionalProperties: false nullable: true properties: progress: $ref: '#/components/schemas/calculation_progress' info: $ref: '#/components/schemas/calculation_info' tracedata: $ref: '#/components/schemas/tracedata' required: - progress - info - tracedata experiment_check: description: The result of checking the data on the experiment. type: object additionalProperties: false nullable: true properties: logical_errors: $ref: '#/components/schemas/entity_error_list' warnings: $ref: '#/components/schemas/entity_warning_list' 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 basic_sharing: description: 'Experiment sharing flag. ' type: boolean default: false example: true readOnly: true experiment: description: Experiment. type: object additionalProperties: false properties: key: $ref: '#/components/schemas/unique_key' specification: $ref: '#/components/schemas/experiment_specification' settings: $ref: '#/components/schemas/experiment_settings' statistics: $ref: '#/components/schemas/experiment_statistics' progress: $ref: '#/components/schemas/calculation_progress' description: 'Calculation progress as a percentage, displays the current number of completed steps. The progress of the calculation of the experiment differs from the progress of the planning, as it has a larger number of steps. ' calculation: $ref: '#/components/schemas/experiment_calculation' check: $ref: '#/components/schemas/experiment_check' pristine: $ref: '#/components/schemas/basic_pristine' sharing: $ref: '#/components/schemas/basic_sharing' 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: '2024-02-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: '2024-02-21T19:45:00Z' required: - key - specification - settings - pristine - statistics - edit_date - creation_date table_list_stats_detail: description: Detail statistics by list. type: object additionalProperties: false properties: total: description: Count. type: integer format: int32 minimum: 0 maximum: 100000 example: 1 required: - total table_list_stats: description: Statistics by list. type: object additionalProperties: false properties: overall: $ref: '#/components/schemas/table_list_stats_detail' description: General statistics, does not depend on the filter. filter: $ref: '#/components/schemas/table_list_stats_detail' description: Filtered statistics. required: - overall - filter experiment_list: description: A list of experiments. type: object additionalProperties: false properties: experiments: description: A list of experiments. type: array uniqueItems: false minItems: 0 maxItems: 101 items: $ref: '#/components/schemas/experiment' statistics: $ref: '#/components/schemas/table_list_stats' required: - experiments - statistics basic_process: description: "Process name:\n * `PLAN` - планирование\n * `REPLAN` - перепланирование\n\ \ * `ACTUALIZE` - актуализация\n" type: string enum: - PLAN - REPLAN - ACTUALIZE default: PLAN example: ACTUALIZE file_xlsx: description: File with data in [XLSX](https://en.wikipedia.org/wiki/Microsoft_Excel) format. type: string format: byte 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 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' 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' attribute: description: Attribute. type: object additionalProperties: false properties: key: description: Attribute's key. type: string minLength: 1 maxLength: 100 example: attribute_name value: description: Attribute's value. type: string minLength: 0 maxLength: 2000 example: X51 required: - key - value attributes: description: Attributes. Used to add service information. type: array minItems: 0 maxItems: 1000 uniqueItems: true default: [] items: $ref: '#/components/schemas/attribute' 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: location01 geopoint: $ref: '#/components/schemas/geopoint' arrival_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). $ref: '#/components/schemas/time_duration' departure_duration: description: Time to leave the location according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' work_windows: description: 'List of time windows for the location. If the list is empty or not specified, the location works without time limits. ' type: array uniqueItems: true minItems: 0 maxItems: 100 default: [] items: $ref: '#/components/schemas/time_window' compatibilities: $ref: '#/components/schemas/location_compatibilities' attributes: $ref: '#/components/schemas/attributes' required: - key - geopoint 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: location01 duration: description: Event execution time according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' reward: description: Reward for the event. type: number format: double minimum: 0 maximum: 1000000000 default: 1000.1 example: 199.9 hard_time_window: $ref: '#/components/schemas/time_window' soft_time_window: $ref: '#/components/schemas/time_window' 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' 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 compartment 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' attributes: $ref: '#/components/schemas/attributes' required: - key - demands 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: PT24H example: P1T8H30M20S 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: PT24H 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 break: description: The condition for the onset and characteristics of a break. type: object additionalProperties: false nullable: true properties: max_work_duration_sum: description: Total work time after which you need to take a break according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' duration: description: Length of break period according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). $ref: '#/components/schemas/time_duration' required: - max_work_duration_sum - duration work_and_rest_rules: description: 'Work and rest rules. ' type: object additionalProperties: false properties: first_break: $ref: '#/components/schemas/break' description: 'First break - no later than N minutes after the scheduled start time, there must be one break with a duration of M minutes. Waiting time is not counted as working time. Work cannot be interrupted by a break. If there are many orders in one location, then a break can be scheduled between the execution of orders. ' 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: description: Time shift window when the performer can perform work at locations and drive between locations. $ref: '#/components/schemas/time_window' working_time: description: Working time window, when the performer can perform work at locations, must be inside the time window. $ref: '#/components/schemas/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_location01 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_location01 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' attributes: $ref: '#/components/schemas/attributes' required: - key - availability_time - working_time performer_compatibilities: description: 'Performer [compatibilities](#section/Description/Compatibilities). ' type: object additionalProperties: false nullable: true properties: performer_features: description: 'Performer''s features list. Used to check whether the performer is compatible with orders. ' $ref: '#/components/schemas/compatibility_tag_list' performer_features_lifetimes: description: 'List of feature lifetime. Affects on compatibility Performer-Order. ' $ref: '#/components/schemas/feature_lifetime_list' transport_restrictions: description: 'List of transport requirements. Used to check whether the transport is compatible with the performer. ' $ref: '#/components/schemas/compatibility_tag_list' 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 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' compatibilities: $ref: '#/components/schemas/performer_compatibilities' limits: $ref: '#/components/schemas/performer_limits' 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 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: description: The cost of moving 1 unit of measure of cargo per 1 meter (for each capacity field, respectively), monetary unit. $ref: '#/components/schemas/capacity' max_penalty_cost: description: 'Max sum of penalties for transport using this shift, monetary unit. ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 2000 deprecated: true 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: description: The shift time window in which the transport can move between locations and be used by the performer in work on locations. $ref: '#/components/schemas/time_window' working_time: deprecated: true description: The working time window, during which the transport can be used by the performer in work on locations, must be within the availability time window. $ref: '#/components/schemas/time_window' 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_location01 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_location01 tariff: $ref: '#/components/schemas/transport_tariff' attributes: $ref: '#/components/schemas/attributes' required: - key - availability_time - working_time 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: '`max_one_cargo_capacity` - `capacity` fields limitation for *one* cargo. ' type: object additionalProperties: false nullable: true properties: max_one_cargo_capacity: $ref: '#/components/schemas/capacity' box: description: 'A transport box capable to hold a cargo. ' type: object additionalProperties: false properties: key: description: Unique compartment key used to identify the cargo placement in compartments. type: string minLength: 1 maxLength: 1024 example: box01 capacity: description: The compartment capacity, which limits the maximum amount for all `capacity` fields of *all* the cargoes. $ref: '#/components/schemas/capacity' 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. ' $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 compartment. ' 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 compartments that can accommodate the cargo. type: array minItems: 0 maxItems: 100 uniqueItems: true default: [] items: $ref: '#/components/schemas/box' compatibilities: $ref: '#/components/schemas/transport_compatibilities' limits: $ref: '#/components/schemas/transport_limits' attributes: $ref: '#/components/schemas/attributes' required: - key - shifts 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' required: - key - links trip_name: description: Trip name. type: string minLength: 0 maxLength: 64 default: '' example: 1-ABC 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 example: RELOCATING cargo_placement: description: One cargo placement in the compartment. type: object additionalProperties: false properties: box_key: description: Compartment key. type: string minLength: 1 maxLength: 1024 example: box01 cargo_key: description: Cargo key. type: string minLength: 1 maxLength: 1024 example: cargo01 required: - box_key - cargo_key cargo_placement_list: description: List of cargo placements in transport at the beginning of the state. type: array uniqueItems: true minItems: 0 maxItems: 1000 default: [] items: $ref: '#/components/schemas/cargo_placement' 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: '2024-02-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: location01 flags: description: "List of flags, describing current state. \n \nPossible flag\ \ values (locations):\n * `AROUND_LOCATION` - a performer is around a\ \ location: finished relocation to the location by routing means.\n *\ \ `INSIDE_LOCATION` - a performer is inside a location considering arrival\ \ and departure time.\n\nPossible flag values (time windows):\n * `INSIDE_WORKING_WINDOW`\ \ - a performer is inside a formal working shift window from the input\ \ task.\n * `INSIDE_LOCATION_WINDOW` - a performer is inside an availability\ \ window of a location.\n * `INSIDE_EVENT_HARD_WINDOW` - a performer\ \ is inside the hard window of an event.\n * `INSIDE_EVENT_SOFT_WINDOW`\ \ - a performer is inside the soft window of an event.\n\nPossible flag\ \ values (work states):\n * `ON_DEMAND` - a performer is working on a\ \ demand.\n * `WAITING` - a performer is waiting. \n * `RELOCATING`\ \ - a performer is relocating.\n * `BREAK` - the performer is on a break.\n" type: array uniqueItems: true minItems: 0 maxItems: 9 default: [] items: $ref: '#/components/schemas/trip_state_flag' cargo_placements: $ref: '#/components/schemas/cargo_placement_list' attributes: $ref: '#/components/schemas/attributes' required: - time - flags trip_waitlist: description: A list of keys assigned to orders, but not scheduled for a specific time. 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 sequence of states assigned to the specified performer driving the specified transport. ' type: object additionalProperties: false properties: key: description: Unique trip identifier. type: string minLength: 1 maxLength: 1024 example: 631988f0-9e27-11ed-a8fc-0242ac120002 name: $ref: '#/components/schemas/trip_name' performer: $ref: '#/components/schemas/assigned_performer' transport: $ref: '#/components/schemas/assigned_transport' states: description: List of performer's states. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/trip_state' waitlist: $ref: '#/components/schemas/trip_waitlist' attributes: $ref: '#/components/schemas/attributes' required: - key - performer - transport - states fact_time: description: Fact time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. type: string format: date-time example: '2024-02-21T09:30:00+03:00' order_fact_type: description: "Possible order (demand) fact types:\n * `ORDER_DONE` - the order\ \ is completed, the cargo associated with the order is not in the box of the\ \ transport\n * `ORDER_CANCEL` - the order has been canceled, the behavior\ \ is similar to `ORDER_DONE`\n * `DEMAND_START` - performer started to fulfill\ \ the demand\n * `DEMAND_DONE` - performer finished to fulfill the demand\n" type: string enum: - ORDER_DONE - ORDER_CANCEL - DEMAND_START - DEMAND_DONE example: ORDER_DONE order_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/order_fact_type' order_key: description: Order key. type: string minLength: 1 maxLength: 1024 example: order_01 demand_key: description: Demand key, required for facts with type `DEMAND_DONE` and `DEMAND_START`. type: string nullable: true minLength: 1 maxLength: 1024 example: order_01_demand_01 default: null required: - key - time - type - order_key performer_fact: description: Fact. type: object additionalProperties: false properties: key: description: Fact key. type: string minLength: 1 maxLength: 1024 example: fact_01 time: $ref: '#/components/schemas/fact_time' performer_key: description: Performer's key. type: string minLength: 1 maxLength: 1024 example: performer_01 location_key: description: Location key, unique identifier. type: string minLength: 1 maxLength: 1024 example: location01 required: - key - time - performer_key - location_key facts: description: 'Events that have taken place. ' type: object additionalProperties: false properties: order_facts: description: 'List of order''s facts. ' type: array uniqueItems: false minItems: 0 maxItems: 50001 items: $ref: '#/components/schemas/order_fact' performer_facts: description: 'List of performers''s facts. ' type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/performer_fact' transport_load: description: Transport utilization by load. type: object additionalProperties: false properties: count: description: Number of orders. type: integer format: int32 minimum: 0 maximum: 15001 example: 1460 capacity: $ref: '#/components/schemas/capacity' required: - count - capacity 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: location01 demand_ids: description: Keys list of demands fulfilled at this stop. type: array minItems: 0 maxItems: 15001 uniqueItems: true items: description: 'The request identifier is obtained using the following formula: order identifier + ''#'' + the demand identifier. ' type: string minLength: 1 maxLength: 1024 example: demand01 stop_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` + `arriving_time` + `departure_time`. ' $ref: '#/components/schemas/time_window' measurements: $ref: '#/components/schemas/measurements' description: "Measurements of times and distances for work on location:\n\ \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 * `break_time` - the duration of performers\ \ break at the location\n * `working_time` - the time spent on the direct\ \ execution of work at the location\n * `arriving_time` - the time spent\ \ on the entrance/parking at the location\n * `departure_time` - the\ \ time taken to leave the location\n * `time_window` - the time window\ \ from the start of movement to the stop until the end of the departure\ \ from the stop\n * `total_time` - total time for a stop, composed of\ \ `driving_time` + `waiting_time` + `break_time` + `working_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. required: - location_key - demand_ids - stop_time_window - measurements - upload - download - max_load - arrival_load - departure_load 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 statistics: $ref: '#/components/schemas/statistics' stop_statistics: description: Statistics per stop during the trip type: array minItems: 0 maxItems: 15001 uniqueItems: false items: $ref: '#/components/schemas/stop_statistics' 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: - trip_key - statistics - stop_statistics - total_load - max_load - max_transfer_load plan_statistics: description: 'General statistics on planned trips. ' type: object additionalProperties: false nullable: true properties: total_statistics: $ref: '#/components/schemas/statistics' description: Total statistics for all trips. trips_statistics: description: 'List of statistics for each scheduled trip separately. ' type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/trip_statistics' required: - total_statistics - trips_statistics waypoint: description: 'Waypoint. ' type: object additionalProperties: false properties: name: description: Name of the point. type: string nullable: true default: null minLength: 0 maxLength: 1024 example: central geopoint: $ref: '#/components/schemas/geopoint' duration: $ref: '#/components/schemas/time_duration' description: Stop duration according to [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). 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: Time and distance matrix. 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/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. ' type: array minItems: 2 maxItems: 15001 uniqueItems: false items: $ref: '#/components/schemas/routing_matrix_line' durations: description: 'Array of route durations between two neighbors locations, in seconds. 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. ' type: array minItems: 2 maxItems: 15001 uniqueItems: false items: $ref: '#/components/schemas/routing_matrix_line' 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: 'Time and distance matrices list for each transport type from dataset. By specifying an external routing matrix `external_routing`, parameters `geo_settings` are not used. ' type: array uniqueItems: true minItems: 0 maxItems: 12 default: [] items: $ref: '#/components/schemas/routing_transport_matrix' dataset_name: description: 'The name of the dataset. A technical field that does not affect planning. ' type: string minLength: 0 maxLength: 1000 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: description: List of locations used for orders and shifts. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/location' orders: description: Orders list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/order' performers: description: Available performers list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/performer' transports: description: Available transports list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/transport' hardlinks: description: Assignments list. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/hardlink' trips: description: Existing routes. type: array uniqueItems: true minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/trip' facts: $ref: '#/components/schemas/facts' 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' import_source: description: Data import source. type: string enum: - ACCOUNT - ADMIN example: ACCOUNT import_sample: description: Sample of loaded data - input task or input task + calculation result. type: string enum: - TASK - FULL example: TASK table_location_column_type: description: 'Locations table column name. ' type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - WORKING_TIME - ATTRIBUTES example: ESSENCE_KEY table_filter_type: description: "Filter type:\n * `DATETIME_RANGE` - intersection of the time\ \ interval\n * `INT_RANGE` - getting a number inside an integer segment\n\ \ * `FLOAT_RANGE` - hitting the number inside the float segment\n * `DURATION_RANGE`\ \ - hitting inside the duration segment\n * `BOOL_LIST` - exact match of\ \ boolean values\n * `ENUM_LIST` - exact match of string values from enum\n\ \ * `STRING_LIST` - partial match of a subset of string values\n * `STRING_SEARCH`\ \ - partial match of a string\n" type: string enum: - DATETIME_RANGE - INT_RANGE - FLOAT_RANGE - DURATION_RANGE - BOOL_LIST - ENUM_LIST - STRING_LIST - STRING_SEARCH example: STRING_SEARCH table_filter_datetime_range: description: Time window. 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: '2024-02-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: '2024-02-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: -10000000 maximum: 10000000 default: -9999999 example: 1 to: description: Right side. type: integer format: int32 minimum: -10000000 maximum: 10000000 default: 9999999 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: -10000000 maximum: 10000000 default: -9999999.9 example: 1 to: description: Right side. type: number format: double minimum: -10000000 maximum: 10000000 default: 9999999.9 example: 100 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_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: 101 items: description: String for search. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 strict: description: Exact match (`false`) or search by occurrence of a sublist (`true`). 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: 101 items: description: Value. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 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 (`false`) or search by occurrence of a substring (`true`). type: boolean default: false example: false table_location_filter: description: Universal filter for table. type: object additionalProperties: false readOnly: true properties: type: $ref: '#/components/schemas/table_filter_type' column: $ref: '#/components/schemas/table_location_column_type' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_location_filter_list: description: A list of filters. type: object additionalProperties: false properties: filters: description: A list of filters. type: array uniqueItems: false minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/table_location_filter' basic_essence_key: description: Key, unique identifier. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: key01 basic_enabled: description: Using essence for calculations. type: boolean default: true example: false readOnly: false basic_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. \n" type: string format: date-time nullable: true example: '2024-02-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: '2024-02-21T19:45:00+03:00' basic_attributes: description: Attributes. type: string minLength: 0 maxLength: 1000000 default: '' example: key1:value1, key2:value2 table_location_fields: description: Location fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - LOCATION - WORK_WINDOW default: LOCATION example: LOCATION enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' working_time: $ref: '#/components/schemas/basic_time_window' attributes: $ref: '#/components/schemas/basic_attributes' table_location: description: Location. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_location_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_location_fields' required: - fields - elements table_location_list: description: Location list. type: object additionalProperties: false properties: essences: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_location' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics 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 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_location: description: Web location. type: object additionalProperties: false properties: location: $ref: '#/components/schemas/location' fields: $ref: '#/components/schemas/table_location_fields' linked_essences: $ref: '#/components/schemas/linked_essence_list' required: - location web_location_geopoint: description: Geopoint for map. type: object additionalProperties: false properties: geopoint: $ref: '#/components/schemas/geopoint' location_key: description: Location key, unique identifier. type: string minLength: 1 maxLength: 1024 example: location01 linked: description: Flag indicating the presence of links to the location. type: boolean default: false example: true required: - geopoint - location_key - linked web_location_geopoint_list: description: Geopoints for map. type: object additionalProperties: false properties: geopoints: description: A list of points. type: array uniqueItems: false minItems: 0 maxItems: 60002 items: $ref: '#/components/schemas/web_location_geopoint' statistics: $ref: '#/components/schemas/table_list_stats' required: - geopoints - statistics table_performer_column_type: description: 'Performers table column name. ' type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - WORKING_TIME - AVAILABILITY_TIME - TRIP_KEY - TRIP_NAME - LOCATION_KEYS - TRIPS_COUNT - ATTRIBUTES example: ESSENCE_KEY table_performer_filter: description: Universal filter for table. type: object additionalProperties: false readOnly: true properties: type: $ref: '#/components/schemas/table_filter_type' column: $ref: '#/components/schemas/table_performer_column_type' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_performer_filter_list: description: A list of filters. type: object additionalProperties: false properties: filters: description: A list of filters. type: array uniqueItems: false minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/table_performer_filter' basic_essence_key_list: description: A list of keys. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/basic_essence_key' table_performer_fields: description: Performer and shift fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - PERFORMER - SHIFT default: PERFORMER example: PERFORMER enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' working_time: $ref: '#/components/schemas/basic_time_window' availability_time: $ref: '#/components/schemas/basic_time_window' trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' location_keys: $ref: '#/components/schemas/basic_essence_key_list' description: A list of location keys. trips_count: description: The number of trips in which the performer participates (for a shift - 0 or 1). type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 1 attributes: $ref: '#/components/schemas/basic_attributes' table_performer: description: Performer. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_performer_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_performer_fields' required: - fields - elements table_performer_list: description: A list. type: object additionalProperties: false properties: essences: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_performer' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics web_performer: description: Web Performer. type: object additionalProperties: false properties: performer: $ref: '#/components/schemas/performer' fields: $ref: '#/components/schemas/table_performer_fields' linked_essences: $ref: '#/components/schemas/linked_essence_list' required: - performer web_performer_geopoint: description: Geopoint for map. type: object additionalProperties: false properties: geopoint: $ref: '#/components/schemas/geopoint' performer_key: description: Performer's key. type: string minLength: 1 maxLength: 1024 example: performer_01 shift_key: description: Shift key, unique identifier. type: string minLength: 1 maxLength: 1024 example: shift01 point_type: description: The point type. nullable: false type: string enum: - START - FINISH example: START trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' stop_number: description: Sequence number of the stop in the trip. type: integer format: int32 minimum: 0 maximum: 1000 default: 0 example: 10 required: - geopoint - performer_key - shift_key - point_type web_performer_geopoint_list: description: Geopoints for map. type: object additionalProperties: false properties: geopoints: description: A list of points. type: array uniqueItems: false minItems: 0 maxItems: 60002 items: $ref: '#/components/schemas/web_performer_geopoint' statistics: $ref: '#/components/schemas/table_list_stats' required: - geopoints - statistics table_transport_column_type: description: 'Transport table column name. ' type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - WORKING_TIME - AVAILABILITY_TIME - TRANSPORT_TYPE - TRIP_KEY - TRIP_NAME - LOCATION_KEYS - TRIPS_COUNT - ATTRIBUTES example: ESSENCE_KEY table_transport_filter: description: Universal filter for table. type: object additionalProperties: false readOnly: true properties: type: $ref: '#/components/schemas/table_filter_type' column: $ref: '#/components/schemas/table_transport_column_type' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_transport_filter_list: description: A list of filters. type: object additionalProperties: false properties: filters: description: A list of filters. type: array uniqueItems: false minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/table_transport_filter' table_transport_fields: description: Transport\shift fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - TRANSPORT - SHIFT default: TRANSPORT example: TRANSPORT enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' working_time: deprecated: true $ref: '#/components/schemas/basic_time_window' availability_time: $ref: '#/components/schemas/basic_time_window' transport_type: $ref: '#/components/schemas/transport_type' trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' location_keys: $ref: '#/components/schemas/basic_essence_key_list' description: A list of location keys. trips_count: description: The number of trips in which the transport participates (for a shift - 0 or 1). type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 1 attributes: $ref: '#/components/schemas/basic_attributes' table_transport: description: Transport. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_transport_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_transport_fields' required: - fields - elements table_transport_list: description: A list. type: object additionalProperties: false properties: essences: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_transport' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics web_transport: description: Web Transport. type: object additionalProperties: false properties: transport: $ref: '#/components/schemas/transport' fields: $ref: '#/components/schemas/table_transport_fields' linked_essences: $ref: '#/components/schemas/linked_essence_list' required: - transport web_transport_geopoint: description: Geopoint for map. type: object additionalProperties: false properties: geopoint: $ref: '#/components/schemas/geopoint' transport_key: description: Transport's key. type: string minLength: 1 maxLength: 1024 example: transport_01 shift_key: description: Shift key, unique identifier. type: string minLength: 1 maxLength: 1024 example: shift01 point_type: description: The point type. nullable: false type: string enum: - START - FINISH example: START trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' stop_number: description: Sequence number of the stop in the trip. type: integer format: int32 minimum: 0 maximum: 1000 default: 0 example: 10 required: - geopoint - transport_key - shift_key - point_type web_transport_geopoint_list: description: Geopoints for map. type: object additionalProperties: false properties: geopoints: description: A list of points. type: array uniqueItems: false minItems: 0 maxItems: 60002 items: $ref: '#/components/schemas/web_transport_geopoint' statistics: $ref: '#/components/schemas/table_list_stats' required: - geopoints - statistics table_order_column_type: description: 'Order table column name. ' type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - STATE - TYPE - HARD_TIME_WINDOW - SOFT_TIME_WINDOW - GENERAL_DROP_TIME_WINDOW - GENERAL_PICKUP_TIME_WINDOW - GENERAL_WORK_TIME_WINDOW - REWARD - MASS - VOLUME - CAPACITY_A - CAPACITY_B - CAPACITY_C - ORDER_FEATURES - ORDER_RESTRICTIONS - PERFORMER_RESTRICTIONS - PERFORMER_BLACKLIST - WIDTH - HEIGHT - LENGTH - ROTATION - BOX_RESTRICTIONS - CARGO_FEATURES - CARGO_RESTRICTIONS - DEMANDS_COUNT - TRIP_KEY - TRIP_NAME - ATTRIBUTES example: ESSENCE_KEY table_order_filter: description: Universal filter for table. type: object additionalProperties: false readOnly: true properties: type: $ref: '#/components/schemas/table_filter_type' column: $ref: '#/components/schemas/table_order_column_type' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_order_filter_list: description: A list of filters. type: object additionalProperties: false properties: filters: description: A list of filters. type: array uniqueItems: false minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/table_order_filter' basic_state: description: 'Essence state. ' type: string enum: - PLANNED - ASSIGNED - UNPLANNED - ERROR default: UNPLANNED example: PLANNED table_order_fields: description: Order\demand fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - ORDER - DEMAND default: ORDER example: ORDER enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' state: $ref: '#/components/schemas/basic_state' type: description: Order\demand type. type: string nullable: true default: null minLength: 1 maxLength: 1024 example: PD hard_time_window: $ref: '#/components/schemas/basic_time_window' soft_time_window: $ref: '#/components/schemas/basic_time_window' general_drop_time_window: $ref: '#/components/schemas/basic_time_window' general_pickup_time_window: $ref: '#/components/schemas/basic_time_window' general_work_time_window: $ref: '#/components/schemas/basic_time_window' reward: description: The total reward for orders fulfillment. type: number format: double minimum: 0 default: 0 example: 2343.3 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 capacity parameter (A) for measuring cargoes and compartments 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 compartment). ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 1 capacity_b: description: 'Additional capacity parameter (B) for measuring cargoes and compartments in alternative units. ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 2 capacity_c: description: 'Additional capacity parameter (C) for measuring cargoes and compartments in alternative units. ' type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 3 order_features: $ref: '#/components/schemas/compatibility_tag_list' order_restrictions: $ref: '#/components/schemas/compatibility_tag_list' performer_restrictions: $ref: '#/components/schemas/compatibility_tag_list' performer_blacklist: $ref: '#/components/schemas/compatibility_tag_list' width: description: Width in meters, used to check the transport box capacity. type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 1 height: description: Height in meters, used to check the transport box capacity. type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 0.3 length: description: Length in meters, used to check the transport box capacity. type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 2.2 rotation: $ref: '#/components/schemas/cargo_rotation' box_restrictions: $ref: '#/components/schemas/compatibility_tag_list' cargo_features: $ref: '#/components/schemas/compatibility_tag_list' cargo_restrictions: $ref: '#/components/schemas/compatibility_tag_list' demands_count: description: Demands count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 1 trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' attributes: $ref: '#/components/schemas/basic_attributes' table_order: description: Order. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_order_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_order_fields' required: - fields - elements table_order_list: description: A list. type: object additionalProperties: false properties: essences: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_order' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics web_order: description: Web Order. type: object additionalProperties: false properties: order: $ref: '#/components/schemas/order' fields: $ref: '#/components/schemas/table_order_fields' linked_essences: $ref: '#/components/schemas/linked_essence_list' required: - order web_order_geopoint: description: Geopoint for map. type: object additionalProperties: false properties: geopoint: $ref: '#/components/schemas/geopoint' order_key: description: Key of the order with which an action is taken. type: string minLength: 1 maxLength: 1024 example: order01 demand_key: description: Key of the demand with which an action is taken. type: string minLength: 1 maxLength: 1024 example: demand01.1 event_key: description: Key of the event at which an action is taken. type: string minLength: 1 maxLength: 1024 example: event01 demand_type: $ref: '#/components/schemas/demand_type' trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' stop_number: description: Sequence number of the stop in the trip. type: integer format: int32 minimum: 0 maximum: 1000 default: 0 example: 10 required: - geopoint - order_key - demand_key - event_key - demand_type web_order_geopoint_list: description: Geopoints for map. type: object additionalProperties: false properties: geopoints: description: A list of points. type: array uniqueItems: false minItems: 0 maxItems: 60002 items: $ref: '#/components/schemas/web_order_geopoint' statistics: $ref: '#/components/schemas/table_list_stats' required: - geopoints - statistics table_hardlink_column_type: description: 'Hardlink table column name. ' type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - ELEMENT_TYPE - ELEMENTS_COUNT - TRIP_KEY - TRIP_NAME example: ESSENCE_KEY table_hardlink_filter: description: Universal filter for table. type: object additionalProperties: false readOnly: true properties: type: $ref: '#/components/schemas/table_filter_type' column: $ref: '#/components/schemas/table_hardlink_column_type' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' required: - type - column table_hardlink_filter_list: description: A list of filters. type: object additionalProperties: false properties: filters: description: A list of filters. type: array uniqueItems: false minItems: 0 maxItems: 100 items: $ref: '#/components/schemas/table_hardlink_filter' table_hardlink_fields: description: Hardlink and element fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - HARDLINK - ELEMENT default: HARDLINK example: HARDLINK enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' element_type: description: Element type. type: string nullable: false enum: - HARDLINK - ORDER - PERFORMER_SHIFT - TRANSPORT_SHIFT default: HARDLINK example: ORDER elements_count: description: Elements count. type: integer format: int32 minimum: 0 maximum: 15001 default: 0 example: 1 trip_key: $ref: '#/components/schemas/basic_essence_key' trip_name: $ref: '#/components/schemas/trip_name' table_hardlink: description: Hardlink. type: object additionalProperties: false properties: fields: $ref: '#/components/schemas/table_hardlink_fields' elements: description: A list. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_hardlink_fields' required: - fields - elements table_hardlink_list: description: A list of hardlinks. type: object additionalProperties: false properties: essences: description: A list of hardlinks. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/table_hardlink' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics web_hardlink: description: Web Hardlink. type: object additionalProperties: false properties: hardlink: $ref: '#/components/schemas/hardlink' fields: $ref: '#/components/schemas/table_hardlink_fields' linked_essences: $ref: '#/components/schemas/linked_essence_list' required: - hardlink table_trip_column_type: description: "Column name in the table with trips:\n * `ESSENCE_KEY` - entity\ \ key\n * `ENABLED` - participation in the calculation\n * `PRISTINE` -\ \ data change flag\n" type: string enum: - ESSENCE_KEY - ENABLED - PRISTINE - TRIP_NAME - ATTRIBUTES - COST - REWARD - DRIVING_TIME - WAITING_TIME - BREAK_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 example: ESSENCE_KEY 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_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' 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' bool_list: $ref: '#/components/schemas/table_filter_bool_list' string_list: $ref: '#/components/schemas/table_filter_string_list' enum_list: $ref: '#/components/schemas/table_filter_enum_list' string_search: $ref: '#/components/schemas/table_filter_string_search' duration_range: $ref: '#/components/schemas/table_filter_duration_range' 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: 100 items: $ref: '#/components/schemas/table_trip_filter' table_trip_fields: description: Trip\stops fields for table. type: object additionalProperties: false readOnly: true properties: essence_key: $ref: '#/components/schemas/basic_essence_key' essence_type: description: Essence type. type: string nullable: false enum: - TRIP - STOP default: TRIP example: TRIP enabled: $ref: '#/components/schemas/basic_enabled' pristine: $ref: '#/components/schemas/basic_pristine' trip_name: $ref: '#/components/schemas/trip_name' attributes: $ref: '#/components/schemas/basic_attributes' cost: description: 'Total costs calculated based on the performer''s and transport tariffs. The total cost is equal to the difference between the total reward (`reward`) and expenses (`cost`). ' type: number format: double minimum: 0 example: 1231.1 default: 0 reward: description: The total reward for orders fulfillment. type: number format: double minimum: 0 example: 2343.3 default: 0 driving_time: $ref: '#/components/schemas/time_duration' waiting_time: $ref: '#/components/schemas/time_duration' break_time: $ref: '#/components/schemas/time_duration' working_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 default: 0 time_window: $ref: '#/components/schemas/basic_time_window' orders_count: description: The total number of planned and assigned orders. type: integer format: int32 minimum: 0 maximum: 15001 example: 1700 default: 0 plan_orders_count: description: The total number of planned orders. type: integer format: int32 minimum: 0 maximum: 15001 example: 1003 default: 0 waitlist_orders_count: description: The total number of assigned orders. type: integer format: int32 minimum: 0 maximum: 15001 example: 697 default: 0 stops_count: description: The total number of stops (non-unique locations). type: integer format: int32 minimum: 0 maximum: 15001 example: 87 default: 0 locations_count: description: The total number of unique locations within one trip. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. type: number format: double minimum: 0 maximum: 1000000 default: 0 example: 0.1 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: 15001 items: $ref: '#/components/schemas/table_trip' statistics: $ref: '#/components/schemas/table_list_stats' required: - essences - statistics 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 basic_tracks_type: description: "Track type:\n * `LINE` - connecting stop points in a straight\ \ line\n * `ROAD` - connecting stop points along roads\n" type: string enum: - LINE - ROAD default: LINE example: ROAD web_trip_track: description: Track for map. type: object additionalProperties: false properties: geopoints: description: Array of geographical points describing the route. type: array minItems: 0 maxItems: 1000000 items: $ref: '#/components/schemas/geopoint' trip_key: description: Trip key, unique identifier. type: string minLength: 1 maxLength: 1024 example: location01 trip_name: $ref: '#/components/schemas/trip_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: - geopoints - trip_key - performer_key - performer_shift_key - transport_key - transport_shift_key web_trip_track_list: description: Tracks for map. type: object additionalProperties: false properties: tracks: description: A list of tracks. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/web_trip_track' statistics: $ref: '#/components/schemas/table_list_stats' required: - tracks - statistics web_trip_chart_demand: description: Demand for chart. type: object additionalProperties: false properties: demand_key: description: Demand key. type: string minLength: 1 maxLength: 1024 example: demand_1 demand_type: $ref: '#/components/schemas/demand_type' required: - demand_key - demand_type web_trip_chart: description: Trip for chart. type: object additionalProperties: false properties: trip: $ref: '#/components/schemas/trip' chart_demands: description: A list of demands info. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/web_trip_chart_demand' required: - trip - chart_demands web_trip_chart_list: description: Trips for chart. type: object additionalProperties: false properties: charts: description: Data for chart. type: array uniqueItems: false minItems: 0 maxItems: 15001 items: $ref: '#/components/schemas/web_trip_chart' statistics: $ref: '#/components/schemas/table_list_stats' required: - charts - statistics check_result: description: Service availability result. type: object additionalProperties: false properties: health: description: 'Current health. ' type: number format: double minimum: 0 maximum: 1 example: 0.999 required: - health version_result: description: 服务版本。 type: object additionalProperties: false properties: major: description: '产品版本。 在单个版本中,保证了服务之间通用数据结构的兼容性。 版本更改表示与以前版本的产品(和所有服务)不兼容的更改。 ' type: integer format: int32 minimum: 1 maximum: 100 example: 4 minor: description: '服务的小版本。 版本更改表示新功能。 该更新向后兼容服务的主要版本。 ' type: integer format: int32 minimum: 0 maximum: 111 example: 4 build: description: '构建版本。 包含向后兼容的错误修复和文档更新。 ' type: string minLength: 1 maxLength: 64 example: 1754RC 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 examples: DataExplorer: summary: Explorer example value: key: 5fffc47c-8239-42c4-8a3f-95d0ed235173 type: ROOT name: ROOT statistics: folders_count: 1 experiments_count: 3 elements: - key: 2bff0b86-2ddc-445c-9d98-f75ca2eec091 type: FOLDER name: MyFolder statistics: folders_count: 0 experiments_count: 3 elements: [] Result400: summary: Errors in data value: tracedata: code: 215b87e0-4407-4e0f-b2cc-8540f8f0cad7 client: veeroute_|_example server: edge service: UNIVERSAL operation: run_plan_calculation time: '2024-02-28T17:13:27.945583194Z' message: logical schema_errors: [] logical_errors: - type: UNIQUE_IDS_VIOLATION entities: - entity_key: order_1 entity_type: ORDER warnings: [] ExperimentList: summary: Experiments list value: experiments: - key: 65fb88e5-128d-4f3f-9a50-4c2754adcbed specification: name: Exp_1 comment: long long long long text folder_key: 65fb88e5-128d-4f3f-9a50-4c2754adcbed settings: plan_settings: trips_settings: configuration: optimize_distance trip_start_time_strategy: LOWEST_COST assumptions: transport_factor: [] capacity_factor: [] disable_compatibility: true disable_capacity: true same_order_time_window: true expand_shift_time_window: true penalties: compatibilities: [] geo_settings: geo_provider: OSRM toll_roads: false ferry_crossing: false traffic_jams: false flight_distance: true restricted_zones: - ART_MOSCOW_MKAD_CARGO_FRAME calculation_settings: max_calculation_time: PT4M30S max_waiting_time: PT2H result_ttl: PT4M30S result_timezone: 3 treat_warnings_as_errors: true precision: 3 replan_settings: replan_strategy: reorder: true plan_new_orders: true create_new_trips: true trips_settings: configuration: optimize_distance trip_start_time_strategy: LOWEST_COST assumptions: transport_factor: [] capacity_factor: [] disable_compatibility: true disable_capacity: true same_order_time_window: true expand_shift_time_window: true penalties: compatibilities: [] geo_settings: geo_provider: OSRM toll_roads: false ferry_crossing: false traffic_jams: false flight_distance: true restricted_zones: - ART_MOSCOW_MKAD_CARGO_FRAME calculation_settings: max_calculation_time: PT4M30S max_waiting_time: PT2H result_ttl: PT4M30S result_timezone: 3 treat_warnings_as_errors: true precision: 3 actualize_settings: current_time: '2024-02-21T09:30:00+03:00' geo_settings: geo_provider: OSRM toll_roads: false ferry_crossing: false traffic_jams: false flight_distance: true restricted_zones: - ART_MOSCOW_MKAD_CARGO_FRAME calculation_settings: max_calculation_time: PT4M30S max_waiting_time: PT2H result_ttl: PT4M30S result_timezone: 3 treat_warnings_as_errors: true precision: 3 statistics: indicators: - total_statistics_cost - total_statistics_measurements_waiting_time total_statistics: cost: 1231.1 reward: 2343.3 measurements: driving_time: PT2H waiting_time: PT2H break_time: PT2H working_time: PT2H arriving_time: PT2H departure_time: PT2H total_time: PT2H distance: 5200 time_window: from: '2024-02-21T09:30:00+03:00' to: '2024-02-21T19:45:00Z' trips_count: 250 performers_count: 157 orders_count: 1700 plan_orders_count: 1003 waitlist_orders_count: 697 cargo_capacity_ratio: mass: 10 volume: 2 capacity_a: 1 capacity_b: 2 capacity_c: 3 max_transport_load: mass: 10 volume: 2 capacity_a: 1 capacity_b: 2 capacity_c: 3 quality: soft_time_window_violations: before: keys: - obj1 count: 1700 after: keys: - obj1 count: 1700 hard_time_window_violations: before: keys: - obj1 count: 1700 after: keys: - obj1 count: 1700 data_statistics: locations: 1 orders: 1 performers: 1 transports: 1 hardlinks: 1 trips: 1 external_routing: false unplanned_items: order_keys: - key_01 order_keys_count: 99 performer_keys: - key_01 performer_keys_count: 99 transport_keys: - key_01 transport_keys_count: 99 hardlink_keys: - key_01 hardlink_keys_count: 99 progress: 52 calculation: progress: 52 info: status: FINISHED_IN_TIME result_version: 133 preparing_time: PT2H business_validation_time: PT2H math_validation_time: PT2H waiting_time: PT2H calculation_time: PT2H tracedata: code: 11111111-2222-3333-4444-555555555555 client: company_|_username server: server_name service: STUDIO operation: run_plan_calculation time: '2024-02-21T09:30:00+03:00' check: logical_errors: [] warnings: [] pristine: false sharing: true edit_date: '2024-02-21T19:45:00Z' creation_date: '2024-02-21T19:45:00Z' statistics: overall: total: 1 filter: total: 1 Experiment: summary: Experiment example value: key: da4e62b0-86cb-4423-b187-5c1a633ca703 specification: name: new experiment 1000 comment: '' folder_key: 2bff0b86-2ddc-445c-9d98-f75ca2eec091 settings: plan_settings: trips_settings: configuration: default trip_start_time_strategy: EARLIEST_FINISH assumptions: transport_factor: [] capacity_factor: [] disable_compatibility: false disable_capacity: false same_order_time_window: false expand_shift_time_window: false penalties: compatibilities: [] geo_settings: geo_provider: OSRM 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 replan_settings: replan_strategy: reorder: false plan_new_orders: false create_new_trips: false trips_settings: configuration: default trip_start_time_strategy: EARLIEST_FINISH assumptions: transport_factor: [] capacity_factor: [] disable_compatibility: false disable_capacity: false same_order_time_window: false expand_shift_time_window: false penalties: compatibilities: [] geo_settings: geo_provider: OSRM 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: geo_settings: geo_provider: OSRM 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 statistics: indicators: - data_statistics_hardlinks - data_statistics_locations - data_statistics_orders - data_statistics_performers - data_statistics_transports - data_statistics_trips - 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 - total_statistics_quality_hard_time_window_violations_after_count - total_statistics_quality_hard_time_window_violations_before_count - total_statistics_quality_soft_time_window_violations_after_count - total_statistics_quality_soft_time_window_violations_before_count - total_statistics_reward - total_statistics_waitlist_orders_count total_statistics: cost: 0 reward: 0 measurements: driving_time: P0D waiting_time: P0D break_time: P0D working_time: P0D arriving_time: P0D departure_time: P0D total_time: P0D distance: 0 time_window: from: '2024-02-15T13:56:07.697Z' to: '2024-02-15T13:56:07.697Z' performers_count: 0 trips_count: 0 orders_count: 0 plan_orders_count: 0 waitlist_orders_count: 0 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: soft_time_window_violations: before: keys: [] count: 0 after: keys: [] count: 0 hard_time_window_violations: before: keys: [] count: 0 after: keys: [] count: 0 data_statistics: locations: 958 orders: 1000 performers: 1000 transports: 1000 hardlinks: 0 trips: 0 external_routing: false pristine: true edit_date: '2024-02-15T13:56:07.728Z' creation_date: '2024-02-15T13:56:07.728Z' progress: 0 sharing: false parameters: folder_key: name: folder_key description: Folder key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/unique_key' filter: name: filter description: Filter for searching by text fields. in: query required: false schema: description: Filter for searching by text fields. type: string minLength: 1 maxLength: 64 example: example text offset: name: offset description: The number of items to skip before starting to collect the result set. in: query 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 required: false limit: name: limit description: The number of items to return. in: query schema: description: The number of items to return. type: integer format: int32 minimum: 1 maximum: 10000000 default: 100 example: 10 required: false 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 experiment_key: name: experiment_key description: Key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/unique_key' process_name: name: process_name description: "Process name:\n * `PLAN` - планирование\n * `REPLAN` - перепланирование\n\ \ * `ACTUALIZE` - актуализация\n" in: path required: true schema: $ref: '#/components/schemas/basic_process' timezone: name: timezone description: Timezone. in: query required: false schema: description: Target time zone. type: integer format: int32 minimum: -12 maximum: 12 default: 0 example: 3 tracecode: name: tracecode description: Unique process identifier. in: path required: true schema: description: Unique process identifier. type: string format: uuid example: 11111111-2222-3333-4444-555555555555 table_location_column: name: sort_field description: 'Locations table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_location_column_type' essence_key: name: essence_key description: Key, unique identifier. in: path required: true schema: $ref: '#/components/schemas/basic_essence_key' table_performer_column: name: sort_field description: 'Performers table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_performer_column_type' table_transport_column: name: sort_field description: 'Transport table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_transport_column_type' table_order_column: name: sort_field description: 'Order table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_order_column_type' table_hardlink_column: name: sort_field description: 'Hardlink table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_hardlink_column_type' table_trip_column: name: sort_field description: 'Trip table column name. ' in: query required: false schema: $ref: '#/components/schemas/table_trip_column_type' tracks_type: name: tracks_type description: "Track type:\n * `LINE` - connecting stop points in a straight\ \ line\n * `ROAD` - connecting stop points along roads\n" in: path required: true schema: $ref: '#/components/schemas/basic_tracks_type' filename: name: filename description: File name. in: path required: true schema: description: File name. type: string minLength: 6 maxLength: 128 example: file_en.html x-tagGroups: - name: General tags: - Explorer - Experiments - System - name: Essences tags: - Locations - Orders - Performers - Transports - Hardlinks - Trips - Facts