Using the optimization endpoint as an adopted application

The deployed endpoints are accessible in API Gateway to:
  • Get a list of registered endpoints.
  • Get the schema of an endpoint.
  • Retrieve an optimized value for a given endpoint.

This table shows the process of calling the endpoints:

Endpoint /optimization/v1/endpoints /optimization/v1/endpoints/{endpoint name}/schema /optimization/v1/endpoints/

{endpointName}/execution
Method GET GET POST
Type List Schema Optimized details
Description Retrieve a list of registered endpoints which are in ACTIVE state. Retrieve the schema of endpoint based on the endpointName. Use this schema to frame the input for the endpoint-execution method. Get the optimized details of the endpoint based on the input provided.
Input Status: Active endpoint name endpointName and input values to get optimized details.

This example is the ION API request for old endpoints with implementation of custom endpoint schema 

 {
 "runtimeData": [
 ["1020002", "25", "80"],
 ["1020002", "25", "80"]
 ],
 "executionType": "MULTIPLE",
"customSchema": { }(Not a mandatory input so this label can be ignored)
}

This example is the ION API request for new endpoints with implementation of custom endpoint feature:

{
  "runtimeData": [[]],
  "executionType": "CUSTOM",
  "customSchema": {
    "constants": {
      "i": "10",
      "j": "10",
      "k": "10"
    },
    "parameters": {
      "dataset1": [
        {
          "columnName1": "10",
          "columnName2": "abc",
          "columnName3": "100"
        }
      ],
      "dataset2": [
        {
          "columnName1": "10",
          "columnName2": "abc",
          "columnName3": "100"
        }
      ]
    }
  }
}
Output Endpoint & quest details JSON schema foe the selected endpointName Results of endpoint execution