- URL:
- https://<DataReviewerServer-url>/Dashboard
- Methods:
GET
- Operations:
- Filter
- Version Introduced:
- 10.1
Description
The dashboard displays statistics about errors within a Reviewer workspace. The dashboard resource returns statistics for the following:
-
reviewer
—Total counts (summaries or group by) of a value in specific or custom (user-defined) fields in the Reviewer workspace'sResults By REVTABLEMAIN
orREVBATCHRUNTABLE
tables. These statistics show the number of occurrences of a unique value in a field in a table. Any custom (user-defined) fields set within a Reviewer workspace will display in thereviewer
collection.Results By Default fields include the following:
BATCHJOBCHECKGROUP
—A group name within a batch job. Batch jobs can contain one or more groups.CHECKTITLE
—The title of a check in a batch job.FEATUREOBJECTCLASS
—The name of the feature or object class in which an error was found.LIFECYCLEPHASE
—Represents the phase of an error.LIFECYCLESTATUS
—Represents the state of an error.SESSIONID
—Reviewer session ID.SEVERITY
—Severity values range from 1-5 and indicate the relative importance of a check. A lower value signifies a check of greater importance.SUBTYPE
—Indicates the subtype of the object and feature classes in which an error was found.
Custom fields are included in this collection. You can define these fields (called User-Defined Fields), in the Reviewer Session Manager in the ArcGIS Data Reviewer extension for both ArcMap and ArcGIS Pro. All custom fields will have the
is
attribute set toCustom Field true
.Use the
filter
operation to refine information retrieved by this resource.
Request parameters
Parameter | Details |
---|---|
| The response format. The default response format is Values: |
Example usage
Example one
The following request demonstrates how to access the dashboard resource:
https://machine.domain.com/webadaptor/rest/services/reviewer/MapServer/exts/DataReviewerServer/dashboard?f=json
JSON Response example
The response to the above example returns a collection of names, IDs, and is
values.
{
"reviewerResultsBy": [
{
"name": "BATCHJOBCHECKGROUP",
"id": "BATCHJOBCHECKGROUP",
"isCustomField": false
},
{
"name": "CHECKTITLE",
"id": "CHECKTITLE",
"isCustomField": false
},
{
"name": "FEATUREOBJECTCLASS",
"id": "FEATUREOBJECTCLASS",
"isCustomField": false
},
{
"name": "LIFECYCLEPHASE",
"id": "LIFECYCLEPHASE",
"isCustomField": false
},
{
"name": "LIFECYCLESTATUS",
"id": "LIFECYCLESTATUS",
"isCustomField": false
},
{
"name": "SESSIONID",
"id": "SESSIONID",
"isCustomField": false
},
{
"name": "SEVERITY",
"id": "SEVERITY",
"isCustomField": false
},
{
"name": "SUBTYPE",
"id": "SUBTYPE",
"isCustomField": false
}
]
}
Example two
The following request demonstrates how to request total county by severity
in a reviewer workspace:
https://localhost:6443/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/Dashboard/reviewerResultsBy/SEVERITY?f=pjson
JSON Response example
The response to the above request returns a list, sorted by severity
.
{
"fieldName": "SEVERITY",
"dashboardResults": [
{
"fieldValue": 1,
"count": 30224
},
{
"fieldValue": 2,
"count": 509
},
{
"fieldValue": 3,
"count": 19969
},
{
"fieldValue": 4,
"count": 3
},
{
"fieldValue": 5,
"count": 70
}
]
}