Trace

In this topic

Description

A trace refers to a pre-configured algorithm that systematically travels a network to return results. Generalized traces allow you to trace across multiple types of domain networks. For example, running a Connected trace from your electric network through to your gas network. An assortment of options is provided with trace to support various analytic work flows. All traces use the network topology to read cached information about network features. This can improve performance of complex traces on large networks. Trace results are not guaranteed to accurately represent a utility network when dirty areas are present. The network topology must be validated to ensure it reflects the most recent edits or updates made to the network.

License:

The ArcGIS Utility Network Management extension is required to use these resources.

Request Parameters

Parameter

Details

F

Description: Optional parameter representing the output format of the response (default is JSON).

gdbVersion

Description: The name of the geodatabase version.

Syntax: gdbVersion=<version>

sessionId

Description: Optional parameter representing the token (guid) used to lock the version. If the calling client has previously started a service session (editing) and holds an exclusive lock on the specified version, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId which holds the exclusive lock.

Syntax: sessionId=<guid>

moment

Description: Optional parameter representing the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.

traceConfiguration Properties

Description: Optional parameter representing whether or not to
include containers in the trace result (default is false).

Values: " true " | " false "

includeContent

Description: Optional parameter representing whether or not to
include content in the trace result (default is false).

Values: " true " | " false "

includeStructures

Description: Optional parameter representing whether or not to
include structures in the trace result (default is false).

Values: " true " | " false "

includeBarriers

Description: Optional parameter representing whether or not to
include barrier features that stop a trace in the trace result
(default is true).

Values: " true " | " false "

validateConsistency

Description: Optional parameter representing whether or not to
validate the consistency of the trace results (default is
false).

Values: " true " | " false "

domainNetworkName

Description: Optional parameter that specifies the name of the
domain network where the trace is starting.

Syntax: domainNetworkName=<string>

tierName

Description: Optional parameter that specifies the name of the
tier where the trace is starting.

Syntax: tierName=<string>

targetTierName

Description: Optional parameter representing the name of the
tier where upstream or downstream trace ends.

Syntax: targetTierName=<string>

subnetworkName

Description: Optional parameter representing the name of the
subnetwork that will be traced - the starting points of the trace
will be the controllers of this subnetwork .

Syntax: subnetworkName=<string>

diagramTemplateName

Description: Optional parameter representing
the name of the diagram template.

Syntax: designTemplateName=<string>

shortestPathNetworkAttributeName

Description: Required parameter for shortest path trace ;
optional otherwise. It represents the network attribute name used
for determining cost when calulating the shortest path.

Syntax: shortestPathNetworkAttributeName=<string>

filterBitsetNetworkAttributeName

Description: Optional parameter. Used during loops trace to only
return loops with the same bit set all around the loop. Used during
upstream/downstream traces to ensure that trace results include any
bit that is set in the starting points for the network
attribute.

Description: Optional parameter containing an array of objects (representing network attribute conditions) that serve as barriers - default is null. If isTypeSpecificValue is true, the network attribute is being compared with a specific value ; otherwise the network attribute is being compared with another network attribute.