NEnextbillion-ai
Optimization

Flexible GET

Changed on
get/optimization/v2/result

Request

Query parameters

keystring 32 character alphanumeric string required
Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

idstring required

The unique ID that was returned on successful submission of the Optimization POST request.

Response

descriptionstring

Returns the description of the optimization job as given in the input POST optimization request. This field will not be present in the response if no description was provided in the input request.

status'Ok' | 'Error'

It indicates the overall status or result of the API request denoting whether the operation was successful or did it encounter any errors.

messagestring

Returns the message in case of errors or failures, otherwise a blank string is returned.

Example response

{
  "result": {
    "error": "Error Input: not able to allocate vehicle to fulfill all input relations"
  }
}

Changes

  • 7ee76f0ff679Revision changes
    • warning

      added the new Error enum value to the response property for the response status

    • warning

      added the new Ok enum value to the response property for the response status

    • info

      removed the Error enum value from the response property for the response status

    • info

      removed the Ok enum value from the response property for the response status

  • a800b73f11c1Revision changes
    • warning

      added the new Error enum value to the response property for the response status

    • warning

      added the new Ok enum value to the response property for the response status

    • info

      removed the Error enum value from the response property for the response status

    • info

      removed the Ok enum value from the response property for the response status