Query (Reports)

URL:
https://<root>/healthCheck/reports/query
Methods:
GET
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.2

Description

The query operation returns all current health check reports for the organization, returning name of the operation, the start and end time of the health check in UTC format, and whether the organization passed or failed the check, as well as the IDs associated with each report that are needed when using the Reports-level Export and Delete operations. The HTML view of the response provides access to the Report resource.

Request parameters

ParameterDetails

runResult

(Optional)

Filters reports by their health check result.

Values: passed | failed

num

(Required)

The maximum number of results to be included in the response. The default value is 1000.

Example
Use dark colors for code blocksCopy
1
num=1000

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request for the query operation:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/healthCheck/reports/query?runResult=passed&num=1000&f=html

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "total": 1,
  "num": 1000,
  "start": 1,
  "nextStart": -1,
  "runs": [
    {
      "owner": "system",
      "result": "passed",
      "createdBy": "administrator",
      "name": "DemoReport",
      "startTime": 1699148551031,
      "id": "prslejr7yt",
      "endTime": 1699148563298,
      "state": "completed"
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.