ArcGIS REST API

Generate Routes

Description

License:

The ArcGIS Pipeline Referencing for Server extension is required to use this resource.

This operation re-creates shapes and applies calibration changes for route features in an LRS Network.

Editing is supported only for multiuser (enterprise and workgroup) geodatabases. File and personal geodatabases do not support web editing.

Request Parameters

ParameterDetails
f

Description: Optional parameter to specify the response format. The default response format is html.

Values: html | json

recordCalibrationChanges

Description: An optional parameter specifying whether to record calibration changes detected on the routes. Any calibration points created, modified, or deleted outside the ArcGIS Pipeline Referencing tools will be applied to the routes in the network, and event behaviors will be applied the next time Apply Event Behaviors is run. The default is false.

Values: true | false

layerDefinition

Description: Optional parameter containing a list of Object IDs, a SQL WHERE clause, and a time instant defining the routes on which the operation will be performed.

Syntax:

{
      "objectIds": [1,2,3,4,5],
      "where": "lineName in ('MainA', 'MainB', 'MainC')",
      "time": [1200045, 1200100]
}

gdbVersion

Description: Optional parameter to specify the geodatabase version to use. If this parameter is not specified, the published map's version is used.

Syntax: gdbVersion=<version>

Example: gdbVersion="user1.version1"

sessionID

Description: Optional parameter set by a client during long transaction editing on a branch version. The sessionId is a guid value that clients establish at the beginning and use throughout the edit session. The sessonId ensures isolation during the edit session.

Syntax: sessionId=<guid>

Example: sessionId="{E81C2E2D-C6A7-40CB-BF61-FB499E53DD1D}"

returnEditMoment

Description: Optional parameter to specify whether the response will report the time edits that were applied. If returnEditMoment=true, the server will return the time edits that were applied in the response's editMoment key. The default value for this parameter is false.

Values: true|false

This parameter was added at 10.7.

returnServiceEditsOption

Description: Optional parameter that returns features edited due to the geodatabase behavior that results from applying the edits. For example, if a feature is deleted and it is the origin in a composite relationship, the destination feature is automatically deleted in the geodatabase. If returnServiceEditsOption is set to originalAndCurrentFeatures, the deleted destination feature is returned along with a reference to the deleted origin feature in the response. Note that, even for deletes, the geometry and attributes of the edited feature are returned.

Results returned from applyEdits are organized in layer-by-layer fashion. If the returnServiceEditsOption is set to originalAndCurrentFeatures, each layer may have edited features returned in an editedFeatures object.

Service-level applyEdits response structure:

[
	{
		id
		addResults
		updateReults
		deleteResults
		attachments: {
			addResults
			updateReults
			deleteResults
		}
		editMoment
		editedFeatures
		exceededTransferLimit                  
	},
	{
	...
	}
]

The editedFeatures object returns full features, including the original features prior to delete, the original and current features for updates, and the current rows for inserts that may contain implicit changes (for example, as a result of a calculation rule).

editedFeatures response structure:

"editedFeatures":{
	"adds":    [ <feature1>, <feature2>], 	// current features
	"updates": [[<originalFeature3>, < currentFeature3>], 	[<originalFeature4>, < currentFeature4>]],
	"deletes": [ <feature5>, <feature6>]	// original features
},

The response includes no editedFeatures and exceededTransferLimit=true if the count of edited features to return is more than the maxRecordCount. If clients are using this parameter to maintain a cache, they should invalidate the cache when exceededTransferLimit = true is returned. If the server encounters an error when generating the list of edits in the response, exceededTransferLimit = true is also returned.

Edited features are returned in the spatial reference of the feature service as defined by the services spatialReference object or by the spatialReference of the layers extent object.

The default for this parameter is none, which will not include editedFeatures.

Values: none|originalAndCurrentFeatures

Example Usage

Example 1

URL for generating a route.

https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/networkLayers/6/generateRoutes?recordCalibrationChanges=true&layerDefinition=&gdbVersion=sde.version1&sessionId=%7B1CC754B0-08B2-49B9-80E5-1481C3CA2871%7D&f=json

Example 2

URL for generating a line.

https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/networkLayers/6/generateRoutes?recordCalibrationChanges=true&layerDefinition= {"where":"LINEID='MainLine'"}&gdbVersion=sde.version1&sessionId=%7B1CC754B0-08B2-49B9-80E5-1481C3CA2871%7D&f=json

JSON Response Syntax

{
  "statusURL": <jobIdURL>
}

JSON Response Example

{"statusURL":"https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/jobs/j3c0a00b4314349eb8e4ff6ff7ac2db5d"}