Batch Validation

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.

Batch validation executes a Data Reviewer batch job within ArcGIS Data Reviewer Server. A batch job represents a quality control model containing groups of Data Reviewer checks. Checks validate data based on conditions, rules and spatial relationships. Checks also specify sets of features or rows to validate. The validation process verifies that features, or rows, conform to rules defined within the model. Validation results are written to the Data Reviewer workspace.

Reviewer batch jobs are stored as .rbj files. You can create batch jobs and save them as .rbj files using Data Reviewer tools in ArcGIS Data Reviewer Server.

To execute batch validation, you must upload .rbj files to the Data Reviewer map server. Use the ArcGIS Server uploads functionality to upload .rbj files. This operation returns the GUID of an uploaded item. Use this GUID in the Batch Job File Item Id setting of the executeJob and scheduleNewJob operations.

Batch Validation operates in two execution modes: adhoc (immediate) or scheduled. Requests to the BatchValidation resource will return a collection for each mode. Each item in the collection represents a job. Clicking on the item exposes job specific functionality including editJob, enableJob, disableJob and deleteJob.

scheduleNewJob allows you to schedule and queue jobs for execution. executeJob immediately starts validation. Both methods execute asynchronously.

scheduleNewJob requires a schedule format as a cron expression.

Note:

Cron expressions represent times and dates as seconds, minutes, hours, day-of-month, month, day-of-week, year, in number and wildcard characters.

Request parameters

Example usage

URL for batch validation.

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

JSON Response example

{
  "scheduledJobs": [{
    "name": "e4aa6cfd-430c-4a22-a136-201ba3ee7f70",
    "id": "e4aa6cfd-430c-4a22-a136-201ba3ee7f70"
  }, {
    "name": "e1c97421-6be5-4e00-834d-3d248144953c",
    "id": "e1c97421-6be5-4e00-834d-3d248144953c"
  }],
  "adhocJobs": [{
    "name": "ca2f425b-b304-4c98-add8-d4ddbf7244ba",
    "id": "ca2f425b-b304-4c98-add8-d4ddbf7244ba"
  }, {
    "name": "e5ac1cf1-18c8-4fdf-9161-6989367fe060",
    "id": "e5ac1cf1-18c8-4fdf-9161-6989367fe060"
  }]
}