Optimization
This topic describes the operations and methods available to create/manipulate the
quests, endpoints, and custom algorithms.
Quests
| Method | Path | Description |
|---|---|---|
| POST | /quests/query |
Gets the list of available optimization quests. |
| GET | /quests/{name} |
Downloads the JSON response for a given optimization quest. |
| PUT | /quests/{name} |
Updates a given optimization quest from a JSON. |
| GET | /quests/{name}/status |
Gets the status for a given Optimization quest. |
| DELETE | /quests/{name} |
Deletes an Optimization quest. |
| POST | /quests/{name} |
Creates a quest by uploading a JSON. |
| POST | /quests/{name}/designrun |
Runs the design quest. |
| GET | quests/{name}/log |
Get the results logs, success/failure log of the quest. |
| GET | /quests/{name}/{optimizemodelname}/caresults |
Gets the design quest results. |
| POST | /quests/{name}/production |
Creates a production quest. |
| POST | /quests/{name}/productionrun |
Runs the production quest. |
| PUT | /quests/{name}/production |
Updates the model from design to production quest. |
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /quests/{name}/endpoint/deploy |
Deploys an optimization endpoint. Handles updates and redeployment. |
| GET | /quests/{name}/endpoint/status |
Gets the status for a given Optimization endpoint. |
| POST | /quests/{name}/endpoint/activate |
Activates a given Optimization endpoint. |
| POST | /quests/{name}/endpoint/deactivate |
Deactivates a given Optimization endpoint. |
| DELETE | /quests/{name}/endpoint/delete |
Deletes the Optimization endpoint. |
Custom algorithms
| Method | Path | Description |
|---|---|---|
| POST | /customalgorithms/query |
Gets the list of available custom algorithms. |
| GET | /customalgorithms/{name} |
Gets the properties for a given custom algorithm. |
| DELETE | /customalgorithms/{name} |
Accepts the name of the custom algorithm and deletes it. |
| POST | /customalgorithms |
Adds a custom algorithm entity. |
| PUT | /customalgorithms/{name} |
Updates the custom algorithm name and description. |
| POST | /customalgorithms/{name}/code |
Adds or updates the custom algorithm code through ZIP files. |
| POST | /customalgorithms/{name}/hyperparameters |
Adds or updates the hyperparameters file. |
| POST | /customalgorithms/{name}/deploy |
Deploys or redeploys the custom algorithm. |
| Get | /customalgorithms/{name}/usage |
Gets the custom algorithm usage details. |