REST Request Detailed Documentation

The Accelerator REST v3 API interface is described in detail under the Swagger documentation that comes with the Accelerator software. To browse the Swagger REST documentation, browse to the URL displayed as the output of this command:
nc cmd vovbrowser -url /html/vovrest.html

The information at this page will help you construct a valid REST request.

For example, browse on the Swagger documentation page to the “jobs” object. You will see that a POST request is used, and the REST URL segment is “/api/v3/jobs”.



Figure 1. REST Object-Verb Reference

Click on the POST, PUT, PATCH, DELETE, or GET buttons for more details about the required parameters and supported dictionary keys and values for each request type. This gives you what you need to know to construct a complete and working job submit request via Python or curl.

Online REST Reference Pages

The Accelerator Web UI has a REST reference page complex. This page is an interactive VOV REST reference with a complete list of objects that may be targeted with REST accessors operations and a summary of job control functions that may target the “job” object.

To access the reference page, run the following:
% vovbrowser -url /html/vovrest.html