Getting report information

You can get a list of reports and information for each. In the user interface, you can access reports on the following tabs: Reports and Custom Reports.

_images/reference_report_get1.png

Figure 63 The same action can be taken in the IBM Spectrum Protect Plus web user interface: In the navigation pane, click Reports and Logs > Reports. Click the Reports tab to see a list of predefined reports or click the Custom Reports tab to see a list of custom reports. You can filter the reports by specifying the category.

Method and URI

To get information about all reports, use a GET method and a URI:

GET     https://{hostname|IPv4}/api/endeavour/report

To get information about a specific report with {reportIdStr}, use a GET method and a URI:

GET     https://{hostname|IPv4}/api/endeavour/report/{reportIdStr}

Tip

To get a {reportIdStr} by the report name, follow the instructions in Getting a {reportIdStr}.

Parameters

None.

Data

None.

Example: Get information about all reports

A Python snippet that is similar to the following example can be used to request information about all reports:

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

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

{
    "links": {...},
    "total": 18,
    "page": 1,
    "reports": [
        {...}, {...}, ..., {...},
        {
            "links": {...},
            "name": "vSnap",
            "displayName": "vSnap Storage Utilization",
            "description": "Review the storage utilization for your vSnap Storag
↪e Array.",
            "category": "Backup Storage Utilization",
            "categoryDisplayName": "Backup Storage Utilization",
            "custom": false,
            "creationTime": 1564685718121,
            "parentName": "vSnap",
            "parentDisplayName": "vSnap Storage Utilization",
            "rbacPath": "root:0/report:0/reportcategory:BackupStorageUtilization
↪CategoryName/report:1013",
            "hasChildren": true,
            "id": "1013"
        },
        {...}, {...}, ..., {...},
        {
            "links": {...},
            "name": "vSnapStorageUtilization-Dallas1",
            "displayName": "vSnapStorageUtilization-Dallas1",
            "description": "A report of storage utilization for vSnap Dallas1",
            "category": "Backup Storage Utilization",
            "categoryDisplayName": "Backup Storage Utilization",
            "langType": "EN_US",
            "custom": true,
            "creationTime": 1575637231627,
            "parentId": "1013",
            "parentName": "vSnap",
            "parentDisplayName": "vSnap Storage Utilization",
            "rbacPath": "root:0/report:0/reportcategory:BackupStorageUtilization
↪CategoryName/report:1102",
            "id": "1102"
        }
    ]
}