7.4 check-json Endpoint

The check-json endpoint is used to submit scenarios containing an existing load plan to the OLM in OLM-JSON format for load plan checking.

7.4.1 check-json Requests

A check-json request is an HTTP POST request to a URL of the following form:

https://server-name/olm/v1/check-json

where server-name will be provided by Opturion.

The body of the POST request is a JSON document containing a OLM-JSON check request object.

7.4.2 check-json Parameters

The check-json endpoint does not accept any optional parameters.

7.4.3 check-json Request Example

Here is an example check-json request URL:

    https://demo.opturion.com/olm/v1/check-json
7.4.4 check-json Responses

The following table lists all of the HTTP status codes that check-json specifically returns and their meaning. Any other HTTP status code returned by check-json that is not covered by this table has its usual meaning.

HTTP Status Code

Description

HTTP Response Body

200 (OK)

A checked load plan has been returned.

A OLM-JSON response object.

400 (Bad Request)

There are errors in the input or web service invocation.

The body of the HTTP response may contain an OLM-JSON response object describing any errors.

401 (Unauthorized)

Authentication (if required) failed; the client is not authorized to access the optimiser.

Empty.

429 (Too Many Requests)

May be returned if rate limiting has been applied by the server.

Empty.

500 (Internal Server Error)

Indicates that an error occurred on the server.

The body may contain a OLM-JSON response object further describing the error.