Using the AE REST API
The AE REST API provides many different endpoints. Here you can find numerous real-life examples to guide you through these endpoints:
- AE REST API - Health Check
- AE REST API - Object Search
- AE REST API - Execute Objects with and without Inputs
- AE REST API - Comments on Executions
- AE REST API - Reports of Executions
- AE REST API - Working with Executed Objects
- AE REST API - Execution List
- AE REST API - Forecasting
- AE REST API - Working with Agents
- AE REST API - AE Performance Metrics
Get OpenAPI (Swagger) Documentation
You can get the OpenAPI (Swagger) based REST API documentation by sending a request via web browser to display the readable response.
For more information, see REST API Reference.
Request: The AE REST API Reference documentation can be requested in three different formats:
-
GET http://{host}:{port}/ae/api/v1 or http://{host}:{port}/ae/api/v1/openapi2/index.html
-
GET http://{host}:{port}/ae/api/v1/openapi2/swagger.json
-
GET http://{host}:{port}/ae/api/v1/openapi2/swagger.yaml
Example: http://my-jcp-host:8088/ae/api/v1
HTTP 200 Response: The OpenAPI (Swagger) based API reference in the requested format.
Note: Make sure that the docu= parameter in the [REST] section of the INI file of the Automation Engine (see Automation Engine INI file) is set to 1 (enabled). Otherwise, the endpoint to request the AE REST API Open API (Swagger) documentation is disabled.
See also: