To access anyLogistix APIs you need to get the Java library.
All URIs are relative to https://server_address:port/api/v1
| Method | HTTP request | Description |
|---|---|---|
| addLastMileOptimizationMilkRunsToScenario | POST /open/lmo/milk-runs-update | Adds the generated milk runs (that are selected) to the Milk Runs table. |
| addLastMileOptimizationShipmentsToScenario | POST /open/lmo/scheduled-orders-update | Adds the generated shipments (that are selected) to the Shipments table. |
| closeProject | GET /open/project/close | Closes the currently open project. |
| convertGFAResultToScenario | POST /open/convert/gfa | Converts the GFA result with identifier runId to a new scenario with type scenarioType. |
| convertLastMileOptimizationResultToScenario | GET /open/convert/last-mile-optimization | Converts the Last mile optimization result with the defined runId to a new scenario. |
| convertNOResultToScenario | POST /open/convert/no | Converts resultOptionId iteration of the NO result with identifier runId to a new scenario with type scenarioType. |
| convertSSEResultToScenario | POST /open/convert/sse | Converts the Safety stock estimation result with identifier runId to a new scenario. |
| convertVariationResultToScenario | GET /open/convert/variation | Converts resultOptionId iteration of the Variation result with identifier runId to a new scenario. |
| copyScenario | POST /open/scenario/copy | Asynchronously copies or clones the scenario with identifier scenarioId. |
| copyScenarioSynchronously | POST /open/scenario/copySynchronously | Synchronously copies or clones the scenario with identifier scenarioId. |
| createNewVariableParameter | POST /open/variations/create-variable-parameter | Creates a new variable parameter. |
| createVariableParameter | POST /open/variations | Creates a new variable parameter. |
| deleteVariableParameter | DELETE /open/variations/delete-variable-parameter | Deletes a variation parameter with identifier variationId. |
| deselectLastMileOptimizationMilkRunInMilkRunsTable | POST /open/lmo/milk-runs-update/uncheck | Deselects the defined milk run record to skip it when adding other (selected) milk runs to the Milk Runs table after calling the addLastMileOptimizationMilkRunsToScenario method. |
| deselectLastMileOptimizationOrderInOrdersTable | POST /open/lmo/orders/uncheck | Deselects the defined order record to exclude it from the problem the optimizer will be solving. |
| deselectLastMileOptimizationShipmentInShipmentsTable | POST /open/lmo/scheduled-orders-update/uncheck | Deselects the defined shipment record to skip it when adding other (selected) shipments to the Shipments table after calling the addLastMileOptimizationShipmentsToScenario method. |
| doesVariableParameterHasSelectedData | POST /open/variations/has-selected-data | Returns whether the variable parameter with identifier variationId has the selected data in the table. |
| dropLicense | POST /open/user/license/drop | Drops user's license. |
| exportDashboardPage | GET /open/experiments/export-page | Returns an Excel representation of the dashboard page with id pageId. |
| exportLastMileOptimizationMilkRunsResultsPage | GET /open/lmo/milk-runs-result | Exports the dashboard Milk Runs page to an Excel file. |
| exportLastMileOptimizationShipmentsResultsPage | GET /open/lmo/scheduled-orders-result | Exports the dashboard Shipments Table page to an Excel file. |
| findAndOpenProjectByName | GET /open/project/open-by-name | Opens project with name projectName. |
| getComparisonResultData | POST /open/experiments/comparison-result | Returns comparison result data. |
| getCurrentUser | GET /open/user | Gets current user data. |
| getExistingVariableParameterTableData | GET /open/variations/existing-table-data | Returns a table data of a variation with the given variationId. |
| getExperiment | GET /open/experiments/experiment | Returns an experiment of a given type available for a given scenario. |
| getExperimentDashboardPage | GET /open/experiments/dashboard-page | Returns statistic page with the given pageName for the result of experiment run. |
| getExperimentDashboardPages | GET /open/experiments/dashboard-pages | Returns statistics pages for the result of experiment run. |
| getExperimentOptions | POST /open/experiments/options | Returns a list of possible values for various experiment options. |
| getExperimentRunConfiguration | GET /open/experiments/get-run-configuration | Returns experiment settings. |
| getExperimentRunResult | GET /open/experiments/result | Returns all the results of the specific experiment run. |
| getExperimentRunResultChartGraphData | GET /open/experiments/chart-graph-data | Returns graph data for the chart with identifier chartId. |
| getExperimentRunResultChartTableData | GET /open/experiments/chart-table-data | Returns table data for the chart with identifier chartId. |
| getExperimentRunResultOptions | GET /open/experiments/result-options | Returns options for the result of experiment run. |
| getExperimentRunResultPageCharts | GET /open/experiments/charts | Returns charts on the statistics page with the identifier pageId. |
| getExperimentRunResultPages | GET /open/experiments/pages | Returns statistics pages for the result of experiment run. |
| getExperimentRunsForScenario | GET /open/experiments/results | Returns the results of experiment runs for scenario. |
| getExperimentStatus | GET /open/experiments/status | Returns the experiment status. |
| getExperiments | GET /open/experiments/list | Returns a list of experiments available for a given scenario. |
| getImportStatus | GET /open/import/import-status | Returns scenario import status. |
| getLastMileOptimizationMilkRunsTableData | POST /open/lmo/milk-runs-update/data | Returns the list with the generated milk runs. |
| getLastMileOptimizationOrdersTableData | POST /open/lmo/orders/data | Returns the data from the Preview Orders table. |
| getLastMileOptimizationShipmentsTableData | POST /open/lmo/scheduled-orders-update/data | Returns the list with the generated shipments. |
| getNewVariableParameterTableData | GET /open/variations/new-table-data | Returns a table data of a variation with the given variationId. |
| getProjects | GET /open/project/list | Returns a list of projects that the user has access to. |
| getScenarioValidationStatus | GET /open/experiments/validation-status | Returns the validation status of the scenario. |
| getScenarios | GET /open/scenario/list | Returns a list of scenarios for the project with identifier projectId. |
| getScenariosFromImportedDatabase | POST /open/import/scenarios-available-for-import | Returns a list of scenarios available for import in the imported database. |
| getStatisticsConfigurations | GET /open/experiments/statistics-list | Returns a list of available statistics. |
| getTablesMeta | GET /open/import/table-metas | Returns a list of meta information for tables. |
| getValidationErrors | GET /open/experiments/validation-errors | Returns validation errors. |
| getValidationWarnings | GET /open/experiments/validation-warnings | Returns validation warnings. |
| getVariableParameterObjectType | GET /open/variations/object-type | Return a list of object types that have variable parameters. |
| getVariableParameterObjectTypes | GET /open/variations/object-types | Returns a list of object types that have variable parameters. |
| getVariableParameterObjects | GET /open/variations/objects | Returns a list of variable parameter objects of the given object type with identifier objectTypeId. |
| getVariableParameterParameters | GET /open/variations/parameters | Returns a list of parameters of an object with id objectId with type with id objectTypeId. |
| getVariableParameterVariationTypes | GET /open/variations/variation-types | Returns a list of parameter variation types for a parameter with id parameterId belonging to an object with id objectId with a type with id objectTypeId. |
| getVariationResultData | POST /open/experiments/variation-result | Returns variation result data. |
| importCancel | POST /open/import/import-cancel | Cancels scenario import job. |
| importDatabase | POST /open/import/import-database | Imports scenarios from the list sourceScenarioNameList from an external database. |
| importDatabaseExisting | POST /open/import/import-database-existing | Imports scenario sourceScenarioName from an external database into existing scenario. |
| importExcel | POST /open/import/import-excel | Asynchronously imports scenario from excel file. |
| importExcelExisting | POST /open/import/import-excel-existing | Asynchronously imports scenario from excel file into existing scenario. |
| importScenario | POST /open/import/import-scenario | Synchronously imports scenario from excel file. |
| importScenarioExisting | POST /open/import/import-scenario-existing | Synchronously imports scenario from excel file into existing scenario. |
| openProject | GET /open/project/open | Opens project with identifier projectId. |
| removeScenarioById | DELETE /open/scenario | Deletes a scenario. |
| requestLicense | POST /open/user/license/pick | Requests a license for the user. |
| runExperiment | GET /open/experiments/run | Starts the experiment asynchronously. |
| runExperimentSynchronously | GET /open/experiments/run-synchronously | Starts the experiment synchronously. |
| selectLastMileOptimizationMilkRunInMilkRunsTable | POST /open/lmo/milk-runs-update/check | Selects the record containing the defined milk run record that must be added to the Milk Runs table. To add the selected milk run(s) to the Milk Runs table call the addLastMileOptimizationMilkRunsToScenario method. |
| selectLastMileOptimizationOrderInOrdersTable | POST /open/lmo/orders/check | Selects the record containing the defined order making it part of the problem the optimizer will be solving. |
| selectLastMileOptimizationShipmentInShipmentsTable | POST /open/lmo/scheduled-orders-update/check | Selects the record containing the defined shipment that must be added to the Shipments table. To add the selected shipments to the Shipments table call the addLastMileOptimizationShipmentsToScenario method. |
| stopExperiment | GET /open/experiments/stop | Stops the experiment. |
| translate | GET /open/translate | Returns translation for string stringToBeTranslated. |
| updateExistingVariableParameterTableDataByIndex | POST /open/variations/update-table-data-by-index | Updates a variation table data by index. |
| updateExperimentRunConfiguration | POST /open/experiments/update-run-configuration | Updates experiment settings. |
| updateVariableParameter | PUT /open/variations/update-variable-parameter | Updates the variation parameter represented by the variation object. |
- Aggregation
- AggregationValue
- ApiARunConfigurationWrapper
- ApiBaseIndexSelectionValueRequest
- ApiBasePropertyData
- ApiBasicRun
- ApiBasicRunConfiguration
- ApiBooleanIndexSelectionValueRequest
- ApiBooleanPropertyData
- ApiChartLayoutData
- ApiChartMetadataShort
- ApiCheckUncheckResponse
- ApiComparisonRC
- ApiComparisonRunConfigurationWrapper
- ApiConvertAndCopyParameters
- ApiDashboardChartData
- ApiDashboardPage
- ApiExperimentResult
- ApiExperimentResultChartWrapper
- ApiExperimentResultData
- ApiExperimentResultGraphChartWrapper
- ApiExperimentResultOption
- ApiExperimentResultPageWrapper
- ApiExperimentResultTableChartWrapper
- ApiGfaRunConfiguration
- ApiGfaRunConfigurationWrapper
- ApiGfaWithRoadsRunConfiguration
- ApiGfaWithRoadsRunConfigurationWrapper
- ApiGraphChartData
- ApiIdNameObject
- ApiImportResponse
- ApiImportScenarioCancelRequest
- ApiImportScenarioStatus
- ApiIndexColumnSelection
- ApiLastMileOptimizationRunConfiguration
- ApiLastMileOptimizationRunConfigurationWrapper
- ApiLicenseData
- ApiLicenseDropData
- ApiListIndexSelectionValueRequest
- ApiMilkRunsGenerateRequest
- ApiNORC
- ApiNORunConfigurationWrapper
- ApiNumberIndexSelectionValueRequest
- ApiNumberPropertyData
- ApiObjectPropertyData
- ApiOptionList
- ApiOptionRequest
- ApiPage
- ApiProjectResponse
- ApiRARC
- ApiRiskAnalysisRunConfigurationWrapper
- ApiRoutesProgressEntry
- ApiRunExperiment
- ApiSSRC
- ApiSafetyStockRunConfigurationWrapper
- ApiScenarioData
- ApiShipmentGenerateRequest
- ApiSimulationRunConfiguration
- ApiSimulationRunConfigurationWrapper
- ApiStatisticsConfiguration
- ApiStrictClassData
- ApiStrictTableChartData
- ApiStrictTableData
- ApiStringIndexSelectionValueRequest
- ApiStringPropertyData
- ApiTableMeta
- ApiTableProperties
- ApiUserData
- ApiValidationError
- ApiValidationWarning
- ApiVariation
- ApiVariationCreateRequest
- ApiVariationData
- ApiVariationDataObject
- ApiVariationRC
- ApiVariationRunConfigurationWrapper
- Cell
- CellDouble
- CellInteger
- CellString
- DBConnectionProperties
- ExecutionState
- Filter
- Graph
- KeyValue
- Point
- PropertyValue
- Row
- Sort
- StatisticsKey
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.
-
How can we improve this article?
-