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: 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: An 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: The geodatabase version to use for the network feature class. This parameter applies only if the isDataVersioned property of the network layer is true.

If this parameter is not specified, the published map's version is used.

Syntax: gdbVersion=<version>

sessionID

Description: An optional parameter representing the token (GUID) used to lock the version. If a named version is being edited, sessionId must be provided.

Syntax: sessionId=<guid>

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

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"}