- URL:
- https://<root>/healthCheck/reports/<reportID>
- Methods:
GET- Required Capability:
- Access allowed with the "Security and infrastructure" privilege
- Version Introduced:
- 11.2
Description
The resource for an individual health check report returns information, including whether the organization passed the health check, the suites that were used to perform the health check, as well as the start time, end time, name, description, and status of each test that was performed. This resource also allows administrators to export or delete the report. Both exporting and deleting a report happen automatically when those options are chosen, requiring no additional user input.
Exporting the report will immediately redirect to a job page where administrators can poll the status of the request. A completed job will provide an upload URL that can be used to access the exported report. An exported report is packaged as a .zip file that contains CSV and JSON versions of the report.
Deleting a report will immediately result in the report being removed. No response is returned.
This resource also provides access to the Rename operation, which allows for the report's name to be modified.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access a specific health check report:
https://organization.domain.com/context/admin/healthCheck/reports/vegcl1xm6u?f=pjsonJSON Response example
{
"owner": "user",
"result": "passed",
"suiteStatus": [
{
"result": "passed",
"criticalTestStatus": [
{
"severity": "critical",
"result": "pass",
"name": "healthcheck_relationalDatastore",
"description": "Relational store health check",
"startTime": 1699328080631,
"id": "HC_112_002",
"endTime": 1699328080824,
"state": "completed"
},
{
"severity": "critical",
"result": "pass",
"name": "sharing_availability",
"description": "Portal API endpoint is available",
"startTime": 1699328080477,
"id": "HC_112_001",
"endTime": 1699328080601,
"state": "completed"
}
],
"name": "Basic health checks",
"description": "Conducts a suite of functional and availability health checks to validate overall organization health.",
"startTime": 1699328080439,
"generalTestStatus": [
{
"severity": "general",
"result": "pass",
"name": "healthcheck_publishingService",
"description": "System publishing tools health check",
"startTime": 1699328083354,
"id": "HC_112_009",
"endTime": 1699328083803,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_spatialanalysis",
"description": "Spatial analysis service health check",
"startTime": 1699328083387,
"id": "HC_112_011",
"endTime": 1699328095302,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_sharedMapService",
"description": "Shared map services health check",
"startTime": 1699328083355,
"id": "HC_112_010",
"endTime": 1699328083801,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_spatioTemporalIndexStore",
"description": "Spatio temporal and index store health check",
"startTime": 1699328083231,
"id": "HC_112_004",
"endTime": 1699328083377,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_objectStore",
"description": "Object store health check",
"startTime": 1699328083231,
"id": "HC_112_003",
"endTime": 1699328083342,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_index_synced",
"description": "Users, groups, and items indices are in sync",
"startTime": 1699328083819,
"id": "HC_112_014",
"endTime": 1699328083934,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "query_logs_availability",
"description": "Can query logs",
"startTime": 1699328083573,
"id": "HC_112_013",
"endTime": 1699328084782,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_geometryService",
"description": "Geometry service health check",
"startTime": 1699328083416,
"id": "HC_112_012",
"endTime": 1699328083561,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "healthcheck_ingress",
"description": "Ingress health check",
"startTime": 1699328083345,
"id": "HC_112_008",
"endTime": 1699328083402,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "manager_availability",
"description": "ArcGIS Enterprise Manager endpoint is available",
"startTime": 1699328083231,
"id": "HC_112_007",
"endTime": 1699328083334,
"state": "completed"
},
{
"severity": "general",
"result": "pass",
"name": "home_app_availability",
"description": "ArcGIS Enterprise portal endpoint is available",
"startTime": 1699328083231,
"id": "HC_112_005",
"endTime": 1699328083337,
"state": "completed"
}
],
"id": "BSHC-001",
"state": "completed",
"endTime": 1699328095313
}
],
"createdBy": "administrator",
"name": "report-test",
"startTime": 1699328080431,
"id": "vegcl1xm6u",
"endTime": 1699328095317,
"state": "completed"
}