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 - 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 - Manipulating Executions
• AE REST API - Execution List
• AE REST API - Forecasting

Get Swagger Documentation

You can get the swagger based REST API documentation by sending a request via web browser to display the readable response, see REST API Reference.

Request: The AE REST API Reference documentation can be requested in three different formats:

1. GET http://{host}:{port}/ae/api/v1 or http://{host}:{port}/ae/api/v1/openapi2/index.html

2. GET http://{host}:{port}/ae/api/v1/openapi2/swagger.json

3. GET http://{host}:{port}/ae/api/v1/openapi2/swagger.yaml

Example: http://my-jcp-host:8088/ae/api/v1

HTTP 200 Response: The swagger-based API reference in the requested format.

Health Checks

Ping Health Check

Check if the JCP/AE REST API is available to send subsequent request.

Request: GET http:{host}:{port}/ae/api/v1/ping

Notes:

• No client information needed in the URI

• No AE credentials/basic authentication needed

Example: http://my-jcp-host:8088/ae/api/v1/ping

HTTP 200 Response: No payload.

System Health Check

Get system information from AE or check if the JCP/REST API is available.

Request: GET http:{host}:{port}/ae/api/v1/{client}/system/health

Example: http://my-jcp-host:8088/ae/api/v1/8001/system/health

HTTP 200 Response:

{
    "status": "UP",
    "pwp": {
        "status": "UP",
        "instancesRunning": 1
    },
    "jwp": {
        "status": "UP",
        "instancesRunning": 1
    },
    "cp": {
        "status": "UP",
        "instancesRunning": 4
    }
}

See also:

AE REST API - General Info