Overlay Events

f

(Optional)

Specifies the response format. The default response format is html.

Values: html | json

locations

A list of routes and measure values used to segment event layers. The list can be either all single measures or all measure ranges; it can't mix single measures and measure ranges. Each route can have one or more different measures. If only a routeId is provided, the entire route is returned.

Syntax:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// syntax of a single measure
[
  {
    "routeId": "<routeId1>",
    "measure": <measure1>
  },
  {
    "routeId": "<routeId1>",
    "measure": <measure2>
  }
  ...
]

// syntax of a measure range
[
  {
    "routeId": "<routeId1>",
    "fromMeasure": <measure1>,
    "toMeasure": <measure2>
  },
  {
    "routeId": "<routeId1>",
    "fromMeasure": <measure3>,
    "toMeasure": <measure4>
  }
  ...
]

// syntax to return the entire route
[
  {
    "routeId": "<routeId1>"
  },
  {
    "routeId": "<routeId2>"
  }
  ...
]

attributeSet

An attribute set that contains the event layers to query and fields to include in the result. The event layers can also be one of the following:

• An ArcGIS Utility Network Pipeline Line, Pipeline Device, or Pipeline Junction layer that has been configured for use with an LRS using the Configure Utility Network Feature Classes geoprocessing tool. This is referred to as the ArcGIS Utility Network configuration.
• An Address Range layer that has been configured as an LRS centerline using the Configure Address Feature Classes geoprocessing tool. This is referred to as the Address Data Management configuration. When the centerline layer is an Address Range layer, the centerline direction is honored in the output. The object ID field for each layer specified will always be included in the results. If a field name already exists across all layers, it is renamed.

If the input layer has address range fields from an Address Data Management configuration, and is configured as an Address Range feature class in an LRS, the values in the address range fields will be updated for each segment in the output.

Syntax:

1
2
3
4
5
6
7
8
9
10
11
[
  {
    "layerId" : "<layerId1>",
    "fields" : [ "<field1>", "<field2>", "<field3>", ... ]
  },
  {
    "layerId" : "<layerId2>",
    "fields" : [ "<field1>", "<field2>", ... ]
  },
  ...
]

addressBlockSplitType

(Optional)

Specifies how address range will be updated for each segment of the output.

• nearest—Address ranges will be updated for each segment in the output based on the nearest upstream and downstream address values.

• proportional—Address ranges will be updated for each segment in the output proportionally from the split location.

The default value is proportional.

Values: nearest | proportional

includeGeometry

(Optional)

Determines whether the output will include event geometry.

The default value is false.

Values: true | false

temporalViewDate

(Optional)

The time instant to use as a temporal view date when locating route features. If this parameter is not specified, the current date is used.

The parameter value is a number that represents the number of milliseconds since epoch (January 1, 1970) in UTC.

Syntax:

1
temporalViewDate=<timeInstant>

Example:

1
temporalViewDate=1230768000000 (1 Jan 2009 00:00:00 GMT)

outSR

(Optional)

The spatial reference of the returned geometry.

The spatial reference can be specified as either a Well-Known ID (WKID) or a spatial reference JSON object.

If outSR is not specified, the geometry is returned in the spatial reference of the map service.

gdbVersion

(Optional)

Specifies the geodatabase version to use. If this parameter is not specified, the published map's version is used.

Syntax:

1
gdbVersion=<version>

Example:

1
gdbVersion="user1.version1"

historicMoment

(Optional)

Specifies the historic moment to query. This parameter applies only if the layer is branch versioned and refers to geodatabase time (separate from LRS time).

If this parameter is not specified, the query applies to the current features.

Syntax:

1
historicMoment=<epoch time in milliseconds>

Example:

1
historicMoment=1514764800000

parallelFactor

(Optional)

Specifies the number or percentage of processes that will be used for the analysis. This parameter applies only to events that span multiple routes and nonspanning events that are not registered with the target network.

The default value, if left blank, is 0%. Any absolute value is always clamped between 0 and the number of logical cores on your machine.

Syntax:

1
parallelFactor=<value>

Example:

1
parallelFactor=8