Getting alert information

You can get a list of alerts and information about each alert.

Tip

To get alert information in CSV format, follow the instructions in Getting alert information in CSV format.

Method and URI

To get information about all alerts in JSON format, use a GET method and a URI:

GET     https://{hostname|IPv4}/api/endeavour/alert/message

Parameters

You can use the operation parameters that are described in Operation parameters for JSON object output.

Data

None.

Example: Get alert information in JSON format

The following Python snippet requests a list of all alerts and information about each alert.

requests.get('https://' + spp_ipv4 + '/api/endeavour/alert/message',
    headers={...}, verify=...)

The request prompts a response that is structured as shown, with the HTTP status of 200 (OK).

{
    "links": {...},
    "total": 2584,
    "unacknowledged": 467,
    "page": 1,
    "alerts": [
        {
            "links": {...},
            "name": "JOB_PARTIAL",
            "alertTime": 1564688662492,
            "category": "JOB",
            "categoryDisplayName": "JOB",
            "type": "WARN",
            "typeDisplayName": "WARN",
            "initialMessage": "Job Application Server Inventory (id=1003, sessio
↪n=1,564,688,656,142) partially succeeded.",
            "message": "Job Application Server Inventory (id=1003, session=1,564
↪,688,656,142) partially succeeded.",
            "messageName": "ALERT_JOB_PARTIALLY_SUCCEEDED",
            "messageParams": [
                "Application Server Inventory",
                "1003",
                1564688656142
            ],
            "initMessageParams": [
                "Application Server Inventory",
                "1003",
                1564688656142
            ],
            "dataSource": "Application Server Inventory:1564688656142",
            "status": "ACTIVE",
            "statusDisplayName": "ACTIVE",
            "storageId": null,
            "serverId": null,
            "jobId": "1003",
            "jobSessionId": 1564688656142,
            "retention": 180,
            "first": 1564688662492,
            "last": 1564688662492,
            "expiresAt": 1580240662519,
            "count": 1,
            "acknowledged": true,
            "expired": false,
            "unique": true,
            "id": "5d4341166dde3d12afd8b11f"
        },
        {...}, {...}, ..., {...}
    ]
}