Export (Reports)

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

Description

The export operation packages multiple health check reports and uploads them to the organization, which can then be downloaded. The exported reports are packaged as a .zip file that contains CSV and JSON versions of each report.

Request parameters

Parameter Details

Parameter	Details
`runIds` (Required)	A comma-separated list of report IDs specifying the reports that will be exported. These IDs can be retrieved from the Query operation. Example Use dark colors for code blocksCopy `1 runIds=vegcl1xm6u,ir2qersuao,zfelr5o957`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

runIds

(Required)

A comma-separated list of report IDs specifying the reports that will be exported. These IDs can be retrieved from the Query operation.

Example
Use dark colors for code blocksCopy
runIds=vegcl1xm6u,ir2qersuao,zfelr5o957

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the export operation:

Use dark colors for code blocksCopy
POST /context/admin/healthCheck/reports/export HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

runIds=vegcl1xm6u&f=pjson&token=D4c7DxeV8RyxOpunM-ANDQTOmoIQWqd0q5_mzpzEi2FjQoH6Kn8wCkyE-uMJJLhAQsc5TLIzylyQMvyuK7BTIKGHjTmp55_tYIiSD1xx18S4kXh3CdGF3V8QYGZqktoP6zmfhbuJugopIHdE_RiynFSpdNcZrjMganzWsz_KWio4RMyZaGjHSrWkZZn6bcCKgS9mwae8GyYTn50oDOugIUJsgFkwOZz4Fd6tBv_FzcVNNlpsiLek44C3JjTkhAen

JSON Response example

Use dark colors for code blocksCopy
{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/j0861f797-e646-4a9b-af92-f5e86b2cd824",
  "jobid": "j0861f797-e646-4a9b-af92-f5e86b2cd824",
  "status": "SUBMITTED"
}

Accessing the export data

Once the export request is submitted, the page will redirect to an asynchronous job resource. To download the export information, navigate to the uploaded item in the Enterprise Admin directory or use the URL returned in the job's details to directly access the uploaded item.

Use dark colors for code blocksCopy
{
  "result": {
    "URL": "https://organization.domain.com/context/admin/uploads/f57951c9-37aa-4d4a-b444-9ad0316737d3"
  },
  "updatedtime": 1699191221825,
  "jobid": "j14ef2bef-0c7c-454c-8f0f-40a17bc12150",
  "resource": {"name": "healthCheck"},
  "requestID": "234ecc71-d680-4930-ba7a-a67a9213518c",
  "name": "exportDiagnosticReports",
  "endtime": 1699191221830,
  "starttime": 1699191221323,
  "operationURI": "/context/admin/healthCheck/reports/export",
  "status": "COMPLETED",
  "username": "administrator"
}

Choosing to download the report data will download a .zip folder containing the report results in CSV and JSON format.