- URL:
- https://<BatchValidation-url>/executeJob
- Methods:
GET
- Required Capability:
- Data Reviewer Server
- Version Introduced:
- 10.1
Description
A REST resource that executes a Reviewer batch job file (.rbj
). Execution is asynchronous. The operation returns a job
in a JSON object.
Request parameters
Parameter | Details |
---|---|
| A JSON object with four name/value pairs.
|
| The batch validation job title. This information is stored in the scheduler database with the ad hoc job information. It is not stored in the Data Reviewer workspace. The getJobDetails operation returns information that includes the job title. |
| Indicates the user name that executes the ad hoc job. This information is stored in the scheduler database with the ad hoc job information. It is not stored in the Data Reviewer workspace. The getJobDetails operation returns information that includes the job created by name. |
| The response format. The default response format is Values: |
Batch validation properties
Parameter | Details |
---|---|
| The |
| The session in which validation will occur. A Reviewer session is similar to an edit session in that it represents a set of interactions with your data. While edit sessions contain editing transactions, a Reviewer session contains quality control tasks. Sessions have names. They are stored in the Reviewer workspace, and created with the Session Manager tool in the ArcGIS Data Reviewer extension for ArcMap or ArcGIS Pro, or using the Create Reviewer Session geoprocessing tool. Use the full string format of |
(Optional) | A path to a production workspace. A production workspace allows you to validate data in a different workspace than what is referenced in the Reviewer batch job file (
|
(Optional) | This property applies only if a production workspace is specified and it is an enterprise geodatabase. The
|
(Optional) | Polygon features that will be joined to create the processing area. Features that intersect this area will be validated by the Reviewer batch job. Features outside this area will not be validated. Example
|
(Optional) | This property only applies to multiversioned eGdb data. The default value is
Values: |
Example usage
Example one
Execute a batch job. The request specifies a production workspace, an upload itemId, and a session. To use this sample request, do the following:
- Change the production workspace (or remove it).
- Change the session id if your Reviewer workspace does not have a session called
"
.Session 1 : Session 1" - Upload a batch job file. The upload operation returns an
item
. Change theId batch
to your uploadedJob File Item Id item
.Id
https://machine.domain.com/webadaptor/rest/services/reviewer/MapServer/exts/DataReviewerServer/BatchValidation/executeJob?batchValidationSettings={"productionWorkspace":"c:\\data\\LocalGovernment.gdb","batchJobFileItemId":"ifff042a8-cbc5-43e7-b1ad-1a4edd593c0e","sessionId":"Session 1 : Session 1"}&batchValidationJobTitle=&batchValidationJobCreatedBy=&f=pjson
JSON Response example
Submitting the above request will return an ad hoc job id, but actual batch validation execution may fail if you don't have this production workspace or section.
{
"adhocJobId": "ifff042a8-cbc5-43e7-b1ad-1a4edd593c0e"
}
Example two
Execute a batch job. The request specifies a production workspace, an upload item
, an analysis
, and a session. To use this sample request, do the following:
- Change the production workspace (or remove it).
- Change the session id if your Data Reviewer workspace does not have a session called
"
.Session 1 : Session 1" - Change the
analysis
to a JSON polygon that contains features to validate in your production workspace.Area - Upload a batch job file. The upload operation returns an
item
. Change theId batch
to your uploadedJob File Item Id item
.Id
https://machine.domain.com/webadaptor/rest/services/reviewer/MapServer/exts/DataReviewerServer/BatchValidation/executeJob?batchValidationSettings={"productionWorkspace":"c:\\data\\LocalGovernment.gdb","batchJobFileItemId":"fe63a23e-ffaf-4228-a509-14dc25c56238","sessionId":"Session 1 : Session 1","analysisArea":{"rings":[[[-97.74,30.303],[-97.738,30.303],[-97.738,30.305],[-97.74,30.305],[-97.74,30.303]]],"spatialReference":{"wkid":4326}}}&batchValidationJobTitle=&batchValidationJobCreatedBy=&f=pjson
JSON Response example
Submitting this request will return an ad hoc job id, but actual batch validation execution will fail if you don't have this production workspace, session or the analysis
does not contain the features in your batch job.
{
"adhocJobId": "fe63a23e-ffaf-4228-a509-14dc25c56238"
}