This is an archive version of the document. To get the most up-to-date information, see the current version.

Evaluation with Swagger UI

To start working with the VAO REST API, you can use any client application that supports the HTTPS protocol.

The VAO REST API is additionally available through the Swagger UI, a tool that you can use to evaluate and explore capabilities of the VAO REST API. The Swagger UI visually presents API specification files and allows you to work with resources.

All resources and methods are expandable. When you expand a method, you get a full description of available parameters and an automatically generated example. You can also send requests and see response messages.

To access the Swagger UI for the VAO REST API, in a web browser, navigate to the following URL:

https://<hostname>:<port>/swagger/ui/index

where:

<hostname> is a DNS name or IP address of the machine where the VAO server runs.
<port> is the Web UI port number specified during VAO installation.

The default port number is 9898.

Tip

If you try to open Swagger UI for the VAO REST API in Internet Explorer, you get the following error in the console log:

SCRIPT1003: Expected ':'
SCRIPT438: Object doesn't support property or method 'forEach'
SCRIPT5007: Unable to get property 'prototype' of undefined or null reference
SCRIPT5009: 'JSON' is undefined

To resolve the issue, turn off Compatibility View in Internet Explorer. To do that, click Tools, select Compatibility View settings and clear the Display intranet sites in Compatibility View check box.

In This Section