Skip To Content
ArcGIS Developers
Dashboard

Get Lifecycle Status Strings

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.

Data Reviewer defines a 'result' as a row, or feature, submitted to the Data Reviewer workspace. Data Reviewer exposes a quality control workflow in which a result is reviewed, corrected, and verified. Lifecycle status describes the result's state within the Reviewer quality control workflow.

Lifecycle status has three phases:

  • Review
  • Correction
  • Verification

Results move from Review to Correction to Verification. Each category has different life cycle status values. These lifecycle status values describe how a result was handled within a life cycle phase.

This REST operation retrieves a JSON array of lifecycle status objects. Each array member has a descriptionType, descriptionString and descriptionCode.

descriptionString defines the lifecycle status string for a result. For example, a descriptionString of Exception indicates that a result's life cycle phase is Verification meaning that the result has completed the Data Reviewer quality control workflow.

descriptionCode pertains to a specific lifecycle status. For example, a descriptionCodeof 2 means that a result is in Correction phase and is yet to be verified.

ArcGIS Data Reviewer Server 10.x will return 7 for descriptionType for all lifecycle status codes.

Use this REST operation to retrieve lifecycle status values for use in other REST operations like WriteResult, WriteFeatureAsResult, and updateLifecycleStatus.

Request parameters

ParameterDetails
f

The response format. The default response format is html.

Values: html | json

Example usage

Retrieve the lifecycle status list from a Data Reviewer workspace:

https://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer/utilities/getLifecycleStatusStrings?f=pjson

JSON Response example

{
 "lifecycleStatusString": [
  {
   "descriptionType": 7,
   "descriptionString": "Unknown",
   "descriptionCode": 0
  },
  {
   "descriptionType": 7,
   "descriptionString": "Reviewed",
   "descriptionCode": 1
  },
  {
   "descriptionType": 7,
   "descriptionString": "Resolved",
   "descriptionCode": 2
  },
  {
   "descriptionType": 7,
   "descriptionString": "Mark As Exception",
   "descriptionCode": 3
  },
  {
   "descriptionType": 7,
   "descriptionString": "Acceptable",
   "descriptionCode": 4
  },
  {
   "descriptionType": 7,
   "descriptionString": "Unacceptable",
   "descriptionCode": 6
  },
  {
   "descriptionType": 7,
   "descriptionString": "Exception",
   "descriptionCode": 9
  },
  {
   "descriptionType": 7,
   "descriptionString": "New",
   "descriptionCode": 10
  },
  {
   "descriptionType": 7,
   "descriptionString": "Passed",
   "descriptionCode": 11
  },
  {
   "descriptionType": 7,
   "descriptionString": "Failed",
   "descriptionCode": 12
  },
 ]
}