Execute Job

Description

License:

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

A REST resource that executes a Reviewer batch job file (.rbj). Execution is asynchronous. The operation returns a jobId in a JSON object.

Note:

This operation does not support cron scheduling.

The batchValidationSettings parameter contains the following name/value pairs:

  • batchJobFileItemId: The itemId of an uploaded batch job file. Use the reviewer map server's upload operation to upload the batch job file to the server. The upload operation returns the itemId. See the ArcGIS Server REST API documentation for more information about uploading.
  • sessionId: 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 ArcGIS Data Reviewer for Desktop Session Manager tool or using the Create Reviewer Session geoprocessing tool. Use the full string format of session id: Session 1 : Session 1.
  • productionWorkspace: This parameter is 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 (.rbj). The workspace path can be absolute or UNC. The ArcGIS server account must have access to the folder that contains the workspace (fGdb) or the connection file that references the workspace (eGdb). Example: c:\\arcgisserver\\data\\arcsde_connection_file.sde.
  • productionWorkspaceVersion: This parameter is optional and applies only if a production workspace is specified and it is an enterprise geodatabase. The productionWorkspaceVersion parameter allows you to validate data in a particular version. If the productionWorkspaceVersion parameter is not specified, the validations are done in the version saved in the production workspace connection file. Example: "productionWorkspaceVersion" : "SDE.DEFAULT".
  • analysisArea: This parameter is 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 JSON structure: "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}}.
  • changedFeaturesOnly: This parameter is optional and only applies to multiversioned eGdb data. The default value is false. If true, validation is limited to features that have changed from a parent to the child version. Changes between versions include the following:
    • Features inserted in the child version but not the parent.
    • Features changed in the child version and unchanged in the parent.
    • Features changed in both child and parent versions.
    • Features changed in the child version and deleted in the parent.
Note:

To validate data with changedFeaturesOnly, the connection file in productionWorkspace must reference a child version.

Request parameters

ParameterDetails
batchValidationSettings

Description: JSON object with four name/value pairs

Values: {"batchJobFileItemId":"<upload itemId>", "sessionId":"<reviewer_session_id>","productionWorkspace":"<path to production workspace>" ,"productionWorkspaceVersion":"<name of version>" ,"analysisArea":<JSON polygon>,"changedFeaturesOnly": true | false}

batchValidationJobTitle

Description: The batch validation job title. This information is stored in the scheduler database with the adhoc job information. It is not stored in the Data Reviewer workspace. The getJobDetails operation returns information that includes the job title.

Values: String

batchValidationJobCreatedBy

Description: Indicates the user name that executes the adhoc job. This information is stored in the scheduler database with the adhoc job information. It is not stored in the Data Reviewer workspace. The getJobDetails operation returns information that includes the job created by name.

Values: String

f

Description: The response format. The default response format is html.

Values: html | json

Example usage

Example 1: Execute a batch job. The request specifies a production workspace, an upload itemId, and a session. Submitting this request will return an adhoc job id, but actual batch validation execution may fail if you don't have this production workspace or session. To use this sample request:

  1. Change the production workspace (or remove it).
  2. Change the session id if your Reviewer workspace does not have a sesion called "Session 1: Session 1."
  3. Upload a batch job file. The upload operation returns an itemId. Change the batchJobFileItemId to your uploaded itemId.

http://localhost:6080/arcgis/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

{
  "adhocJobId": "ifff042a8-cbc5-43e7-b1ad-1a4edd593c0e"
}

Example 2: Execute a batch job. The request specifies a production workspace, an upload itemId, an analysisArea, and a session. Submitting this request will return an adhoc job id, but actual batch validation execution will fail if you don't have this production workspace, session or the analysisArea does not contain the features in your batch job. To use this sample request:

  1. Change the production workspace (or remove it).
  2. Change the session id if your Data Reviewer workspace does not have a session called "Session 1 : Session 1."
  3. Change the analysisArea to a JSON polygon that contains features to validate in your production workspace.
  4. Upload a batch job file. The upload operation returns an itemId. Change the batchJobFileItemId to your uploaded itemId.
http://localhost:6080/arcgis/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 repsonse example

{
  "adhocJobId": "fe63a23e-ffaf-4228-a509-14dc25c56238"
}