Description
Creates a new Reviewer session.
A Reviewer session organizes results discovered from automated validation and visual inspection.
Sessions define a series of validation and quality control transactions performed by data checks or manual review. Sessions are stored in a Reviewer workspace.
Reviewer sessions have properties that control how results are written to the Reviewer workspace. You can set the following properties:
- userName: The user account to associate with a session. The default userName value is the logged in account of the SOE.
- versionName: Indicates an enterprise geodatabase version to associate with the session. Results created in this session will be
written to this version. The default value is the geodatabase's default version.
- duplicateFilter: Indicates how to handle duplicate results when writing the results to the Reviewer workspace. The following options are valid:
- "Session" - When writing results to the Reviewer workspace, the system searches for duplicates by checking OBJECTID or IDENTIFIER, REVIEWSTATUS, ORIGINTABLE,
and PARAMETER fields in REVTABLEMAIN for this session. The system does not write a new result if a duplicate is found. Set this option when you do not want the system
to write duplicate results within a session.
- "Database" - When writing results to the Reviewer workspace, the system searches for duplicates by checking OBJECTID or IDENTIFIER, REVIEWSTATUS, ORIGINTABLE,
and PARAMETER fields in REVTABLEMAIN across the entire Reviewer workspace. The system does not write a new result if a duplicate is found. Set this option when you do not
want the system to generate duplicate results in any session.
- "None" - The system does not perform any duplicate checking. Duplicate results can be written to the Reviewer Workspace. This option may produce the best
performance when creating results. This is the default.
- storeGeometry: Indicates if validation result geometries are stored in the Reviewer workspace. Valid options are "true" and "false." The default is "true."
- "true" - Result geometry is stored in the REVDATASET in the Reviewer workspace. Result geometry represents the problem a check was configured to find.
You can perform spatial analysis on this geometry. This is the default.
- "false" - Result geometry is not stored in the Reviewer workspace. This may increase the performance of writing the results to the Reviewer workspace. You can only
interact with the result as a table row. You cannot view the result geometry.
Note: This functionality is supported only with enterprise geodatabases (eGdb). You cannot use this REST operation against file geodatabases (fGdb).
Parameters
Parameter |
Details |
sessionName |
Description:
Name of the Reviewer session to create. Value can be a string ("QCSession") or a Long (12345).
Values:"session name"
|
sessionProperties |
Description:
Properties to apply to the session.
Values:
{"userName":"<name>",
"versionName":"<geodatabase version name>",
"duplicateFilter":"Session"|"Database"|"None",
"storeGeometry":"true"|"false"}
|
f |
Description: The
response format. The default response format is html.
Values:
html | json |
Example Usage
Example 1: Create a new Reviewer session named qc_analysis with no session properties set.
http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/Utilities/createReviewerSession?sessionName="qc_analysis"&sessionProperties=&f=pjson
JSON Response Example
{
"sessionAttributes": {
"sessionId": 2803,
"sessionName": "\"qc_analysis\"",
"userName": "arcgis",
"versionName": "sde.DEFAULT"
}
}
Example 2: Create a new Reviewer session named QC_Pass_1 with session properties duplicateFilter set to Session and storeGeometry set to false.
http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/Utilities/createReviewerSession?sessionName="QC_Pass_1"&sessionProperties={"duplicateFilter":"Session","storeGeometry":"false"}&f=pjson
JSON Response Example
{
"sessionAttributes": {
"sessionId": 2804,
"sessionName": "\"QC_Pass_1\"",
"userName": "arcgis",
"versionName": "sde.DEFAULT"
}
}