Control-D/WebAccess Server REST API

The Web Server can use REST API calls to communicate with Control-D/WebAccess Server, with the following types of HTTP requests:

  • GET requests to retrieve resources (such as a report, index, note, or logical view) from Control-D/WebAccess Server.

  • POST requests to create a resource in Control-D (for example, add a note).

  • PUT requests to update a resource in Control-D (for example, update a remark).

  • DELETE requests to delete a resource in Control-D (for example, delete a report).

Enabling Rest API Communication

This procedure describes how to enable REST API communication between the Web Server and Control-D/WebAccess Server.

Begin

  1. Navigate to the following file:

    <INSTALLATION PATH>/config/wa_rest_openapi.yaml

  2. Upload the YAML file to a Swagger Editor, such as https://editor.swagger.io/.

  3. Adjust the following variables with the correct values:

    • Server URL: Change http://localhost/wa/restapi to the correct URL, where restapi is in the following pattern:

      /<alias-name>/restapi or /<Virtual DirectoryName>/restapi

    • Protocol

    • Server

  4. Save the YAML file.

The YAML file contains the necessary information about supported requests and their responses, and you can now use it to send REST API requests.