Skip To Content
ArcGIS Developers
Dashboard

Get Batch Run Details

Description

License:

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

Note:

This resource is dependent on ArcGIS Data Reviewer’s ArcMap runtime-based server object extension (SOE). ArcGIS Enterprise 10.9.x, part of the ArcGIS 2021 releases, will be the last release of ArcGIS Enterprise to support services published from ArcMap.

To prepare for this change, Esri recommends that customers consider Data Reviewer capabilities enabled using ArcGIS Pro and integrated in the Validation service.

This operation returns a feature set that contains batch run information in JSON feature objects retrieved by REVBATCHRUNTABLE and REVCHECKRUNTABLE. The returned feature set will not include geometries. The feature set holds a list of fields and field aliases, and an array of attribute values for the batch run IDs.

Request parameters

ParameterDetails
batchRunIds

A JSON array of batch run IDs.

Example

batchRunIds=[64D035A5-2E03-4D78-B6B8-86D033FE8F00]
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Retrieve batch run information for a single ID:

https://machine.domain.com/webadaptor/rest/services/reviewer/MapServer/exts/DataReviewerServer/ReviewerResults/getBatchRunDetails?batchRunIds=[64D035A5-2E03-4D78-B6B8-86D033FE8F00]&f=pjson

JSON Response example

The batchRunStatus field in the returned feature set can contain the following values:

  • 0—Successful
  • 1—Successful with errors
  • 2—Successful with warnings
  • 3—Successful with errors and warnings
  • 4—Failed

The batchRunContext field in the returned feature set can contain the following values:

  • 0—Desktop
  • 1—Engine
  • 2—Server

This operation requires a JSON array of batch run IDs. Find batch run IDs by checking the batchRunId property of a job's execution details or by clicking a job ID in the Batch Validation list. Delimit items in the array with a comma.

{
  "fieldAliases": {
    "batchRunId": "BatchRunId",
    "batchJobFile": "BatchJobFile",
    "batchRunContext": "BatchRunContext",
    "batchRunStatus": "BatchRunStatus",
    "batchRunStartTime": "BatchRunStartTime",
    "batchRunEndTime": "BatchRunEndTime",
    "totalResults": "TotalResults",
    "totalValidated": "TotalValidated"
  },
  "fields": [
    {
      "name": "batchRunId",
      "type": "esriFieldTypeGlobalID"
    },
    {
      "name": "batchJobFile",
      "type": "esriFieldTypeString"
    },
    {
      "name": "batchRunContext",
      "type": "esriFieldTypeInteger"
    },
    {
      "name": "batchRunStatus",
      "type": "esriFieldTypeInteger"
    },
    {
      "name": "batchRunStartTime",
      "type": "esriFieldTypeDate"
    },
    {
      "name": "batchRunEndTime",
      "type": "esriFieldTypeDate"
    },
    {
      "name": "totalResults",
      "type": "esriFieldTypeInteger"
    },
    {
      "name": "totalValidated",
      "type": "esriFieldTypeInteger"
    }
  ],
  "features": [
    {
      "attributes": {
        "batchRunId": "{64D035A5-2E03-4D78-B6B8-86D033FE8F00}",
        "batchJobFile": "C:\\arcgisserver\\directories\\arcgissystem\\arcgisuploads\\services\\ExecuteBatchJob.GPServer\\i5b623f4a-f4f4-4271-86ea-bfadcd48dfa0\\SewerUC2011_wo_Valency.rbj",
        "batchRunContext": 2,
        "batchRunStatus": 0,
        "batchRunStartTime": 1332126739000,
        "batchRunEndTime": 1332126790000,
        "totalResults": 333,
        "totalValidated": 109839
      }
    }
  ]
}