ArcGIS REST API

Dashboard

Description

License:

The ArcGIS Data Reviewer for Server extension is required in order to use this resource.

The dashboard displays statistics about errors within a Reviewer workspace. The dashboard resource returns statistics for the following:

  • reviewerResultsBy – Total counts (summaries or group by) of a value in specific or custom (user-defined) fields in the Reviewer workspace's REVTABLEMAIN or REVBATCHRUNTABLE 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 the reviewerResultsBy collection.

    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. Lower value signify checks of greater importance.
    • SUBTYPE: Indicates the subtype of the object and feature classes in which an error was found.

    Custom fields are included this collection. You can define these fields (called User-Defined Fields), in the Reviewer Session Manager in ArcGIS Data Reviewer for Desktop. All custom fields will have the isCustomField attribute set to true.

    Use the filter operation to refine information retrieved by this resource.

Request parameters

ParameterDetails
f

Description: The response format. The default response format is html. Html returns a list of results while JSON returns a collection of name-value pairs of results, IDs, and isCustomField boolean values. isCustomField indicates if a field is user-defined in the Reviewer workspace.

Example usage

Example 1: Request the Dashboard resources collection. The following request displays a collection of name-value pairs for results, IDs, and isCustomField booleans:

https://localhost:6443/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/dashboard?f=json

JSON response example

{
 "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 2: Request total counts by Severity in a Reviewer workspace.

https://localhost:6443/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/Dashboard/reviewerResultsBy/SEVERITY?f=pjson

JSON response example

{
 "fieldName": "SEVERITY",
 "dashboardResults": [
  {
   "fieldValue": 1,
   "count": 30224
  },
  {
   "fieldValue": 2,
   "count": 509
  },
  {
   "fieldValue": 3,
   "count": 19969
  },
  {
   "fieldValue": 4,
   "count": 3
  },
  {
   "fieldValue": 5,
   "count": 70
  }
 ]
}