Skip to content
URL:
https://<root>/<serviceName>/UtilityNetworkServer/trace
Methods:
POST
Version Introduced:
10.6

Description

The trace operation is used to run traces on your network which can be configured to discover information or solve problems. A trace refers to a preconfigured algorithm that systematically travels a network to return results. Generalized traces allow you to trace across multiple types of domain networks. Multiple parameters and properties are provided with the trace operation that support various analytic workflows.

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 clean dirty areas and to ensure that it reflects the most recent edits or updates made to the network. The trace operation is supported both synchronously and asynchronously.

Learn more about utility network trace types

Request parameters

ParameterDetails

f

Specifies the output format of the response. The pbf response format was introduced at ArcGIS Enterprise 11.2. The default response format is html.

Values: html | json | pjson | pbf

gdbVersion

(Optional)

The name of the geodatabase version. The default is sde.DEFAULT .

Syntax:

Use dark colors for code blocksCopy
1
2

gdbVersion=<version>

sessionId

(Optional)

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 that holds the exclusive lock.

Syntax:

Use dark colors for code blocksCopy
1
2

sessionId=<guid>

moment

(Optional)

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.

Syntax:

Use dark colors for code blocksCopy
1
2

moment=<Epoch time in seconds>

Example:

Use dark colors for code blocksCopy
1
2

moment=1730456642

traceType

(Required)

The trace type. This specifies the core algorithm that will be run to analyze the network. Trace types can be configured using the traceConfiguration parameter.

Values: connected | subnetwork | subnetworkController | upstream | downstream | loops | shortestPath | isolation | path | circuit

Syntax:

Use dark colors for code blocksCopy
1
2

traceType=<traceType>

Example:

Use dark colors for code blocksCopy
1
2

traceType=subnetwork

traceLocations

(Required)

Specifies the locations for starting points, stopping points, and barriers. An empty array must be used when performing a subnetwork trace if a subnetworkName is provided as part of the traceConfiguration —for example, traceLocations=[] .

traceLocations is ignored by the trace if the following required properties are not defined:

  • A percentAlong value is required for edge features and objects.

  • A terminalID value is required for junction features and objects.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
[
 {
   "traceLocationType" : `startingPoint` | `stoppingPoint` | `barrier`,
   "globalId" : <guid>,
   "terminalId" : <long>,   // optional
   "percentAlong" : <double>, // optional
   "isFilterBarrier" : true | false, // optional, introduced at 10.8.1
   "firstUnit" : <short>, // optional, introduced at 11.5 for use with grouped objects in a telecom domain network.
   "lastUnit" : <short>,  // optional, introduced at 11.5 for use with grouped objects in a telecom domain network.
 }
]

traceConfiguration

(Optional)

The collection of trace configuration properties. Depending on the trace type, some of the trace configuration properties are required.

To reference the collection of trace configuration properties, see the traceConfiguration properties section below.

Syntax:

Use dark colors for code blocksCopy
1
2

traceConfiguration=<traceConfiguration>

Learn more about using multiple conditional expressions

traceConfigurationGlobalId

(Optional)

Introduced at ArcGIS Enterprise 10.9. The global ID of a named trace configuration. When specified, this configuration is used instead of the traceConfiguration parameter. Additionally, named trace configurations are persisted with their own trace type so the trace type parameter is ignored.

Syntax:

Use dark colors for code blocksCopy
1
2

traceConfigurationglobalId=<guid>

resultType

This parameter was deprecated at ArcGIS Enterprise 10.8.

resultTypes

(Optional)

The types of results to return for the trace. The connectivity type was introduced at ArcGIS Enterprise 10.9.1. The features and associations types were introduced at ArcGIS Enterprise 11.1. The paths, circuits, and relatedRecords types were introduced at ArcGIS Enterprise 11.5.

Learn more about how to work with result types.

Syntax :

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "type" : "elements" | "aggregatedGeometry" | "connectivity" | "features" | "associations" | "paths" | "circuits" | "relatedRecords",
    "includeGeometry" : true | false,
    "includePropagatedValues": true | false,
    "includeDomainDescriptions" : true | false,
    "networkAttributeNames" :["attribute1Name","attribute2Name",...],
    "diagramTemplateName": <value>,
    "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>}],
    "relationshipClasses" : [ ​
        {​
          "originLayerId" : <long>,         // Required with relatedRecords.  The id of the origin layer.
          "destinationLayerId" : <long>,   // Required with relatedRecords.  The id of the destination layer.
          "outFields" : ["fieldName1, fieldName2"],  // Optional.  The fields in the destination table that includes the values to return.
          "relationshipOutFields" : ["fieldName1, fieldName2"]    // Optional.  The fields from the intermediate table in an attribute relationship class that includes the values to return.

        },...],
]

async

(Optional)

Introduced at ArcGIS Enterprise 10.9.1. If true, the request is processed as an asynchronous job, and a URL is returned that a client can visit to check the status of the job. The default is false.

Use dark colors for code blocksCopy
1
async=true | false

outSR

(Optional)

Introduced at ArcGIS Enterprise 11.1. Specifies the output spatial reference for the trace result.

Syntax:

Use dark colors for code blocksCopy
1
2

outSR={wkid=<wkid>}

traceConfiguration properties

The traceConfiguration parameter is a collection of trace configuration properties that include basic properties for a trace and control trace settings for traversability, functions, filters, outputs, and propagators.

PropertyDetails

includeContainers

(Optional)

Specifies whether to include containers in the trace result. The default is false.

Values: true | false

includeContent

(Optional)

Specifies whether to include content in the trace result. The default is false .

Values: true | false

includeStructures

(Optional)

Specifies whether to include structures in the trace result. The default is false.

Values: true | false

includeBarriers

(Optional)

Specifies whether to include barrier features that stop a trace in the trace result. The default is true.

Values: true | false

validateConsistency

(Optional)

Specifies whether to validate the consistency of the trace results. The default is true.

Values: true | false

validateLocatability

(Optional)

Specifies whether to validate whether traversed junction or edge objects have the necessary containment, attachment, or connectivity association in their association hierarchy. The default is false.

Values: true | false

synthesizeGeometries

(Optional)

Introduced with ArcGIS Enterprise 11.3. Specifies whether geometries will be inferred and created (synthesized) for associations and edge objects traversed during a trace operation. This property is only applicable when using the aggregatedGeometry type for resultTypes. The default is false.

Values: true | false

includeIsolated

(Optional)

Specifies whether to include isolated features for an isolation trace. The default is false.

Values: true | false

ignoreBarriersAtStartingPoints

(Optional)

Specifies whether dynamic barriers in the trace configuration are ignored for starting points. This can be useful when performing an upstream protective device trace using the discovered protective devices (barriers) as starting points to find subsequent upstream protective devices. The default is false.

Values: true | false

includeUpToFirstSpatialContainer

(Optional)

Specifies whether to limit the containers returned in the trace result. This property depends on the includeContainers property and no-ops if includeContainers is false. If includeContainers is true and this property is true, containment associations up to and including the first spatial container are returned; otherwise, all containment associations are returned. The default is false.

Values: true | false

allowIndeterminateFlow

(Optional)

Specifies whether network features with indeterminate flow stop traversability or are included in the trace results. This property is only honored when running an upstream, downstream, or isolation trace.

Values: true | false

useDigitizedDirection

(Optional)

Introduced at ArcGIS Enterprise 11.3. Specifies whether the direction of flow will be based on the digitized direction of the line, From global ID and To global ID of the edge object in the association, and the Flow direction attribute. Applies when the traceType is upstream or downstream, otherwise it is ignored. The default is false.

Learn more about flow direction in a utility network

Values: true | false

domainNetworkName

(Optional)

Specifies the name of the domain network where the trace is starting. This is required for subnetwork-based traces and is ignored when useDigitizedDirection is true.

Syntax:

Use dark colors for code blocksCopy
1
2

domainNetworkName=<string>

Example:

Use dark colors for code blocksCopy
1
2

domainNetworkName=Electric

tierName

(Optional)

Specifies the name of the tier where the trace is starting. This is required for subnetwork-based traces and is ignored when useDigitizedDirection is true.

Syntax:

Use dark colors for code blocksCopy
1
2

tierName=<string>

Example:

Use dark colors for code blocksCopy
1
2

tierName=Distribution

targetTierName

(Optional)

Specifies the name of the tier where an upstream or downstream trace ends. This is ignored when useDigitizedDirection is true.

Syntax:

Use dark colors for code blocksCopy
1
2

targetTierName=<string>

subnetworkName

(Optional)

Specifies the name of the subnetwork that will be traced. The starting points of the trace are the controllers of this subnetwork.

Syntax:

Use dark colors for code blocksCopy
1
2

subnetworkName=<string>

shortestPathNetworkAttributeName

(Optional)

Specifies the network attribute name used for determining cost when calculating the shortest path. This is required for a shortest path trace.

Syntax:

Use dark colors for code blocksCopy
1
2

shortestPathNetworkAttributeName=<string>

filterBitsetNetworkAttributeName

(Optional)

This is used during upstream and downstream traces to ensure that trace results include any bit that is set in the starting points for the network attribute. Also used during a loops trace to only return loops with the same bit set all around the loop.

Syntax:

Use dark colors for code blocksCopy
1
2

filterBitsetNetworkAttributeName=<string>

traversabilityScope

(Optional)

Specifies the network element types to which the condition, category, or function barriers apply. The default is junctionsAndEdges.

Values: junctions | edges | junctionsAndEdges

filterScope

(Optional)

Specifies the network element types to which the filter barriers or filter function barriers apply. The default is junctionsAndEdges.

Values: junctions | edges | junctionsAndEdges

numPaths

(Optional)

Introduced at ArcGIS Enterprise 11.5. Specifies the maximum number of paths that will be returned between a given set of starting points and stopping points for a valid path. This parameter is only honored when the traceType is path. The default is 2.

Syntax:

Use dark colors for code blocksCopy
1
2

numPaths=<long>

maxHops

(Optional)

Introduced at ArcGIS Enterprise 11.5. Specifies the maximum number of hops between edges allowed in the valid path, excluding the starting point. All edges and junction-junction connectivity associations are evaluated as having a fixed unit length of 1 on traversal. Terminal devices are evaluated as having a fixed unit length of 2. This parameter is only honored when the traceType is path or circuit. The default is 100.

Syntax:

Use dark colors for code blocksCopy
1
2

maxHops=<long>

inferConnectivity

(Optional)

Specifies whether the path trace will use connectivity inference to traverse containment associations and find a path between the specified starting and stopping location. This parameter is only honored when the traceType is path. The default is false.

Values: true | false

circuitName

(Optional)

Specifies the name of the circuit that will be traced. When a value is provided for the circuitName parameter, the starting location for the circuit is used as the starting point for the trace, and traceLocations is not required. This parameter is only honored when the traceType is circuit.

Syntax:

Use dark colors for code blocksCopy
1
2

circuitName=<string>

conditionBarriers

(Optional)

Specifies an array of objects (representing network attribute or network category conditions) that serve as barriers. If isSpecificValue is true, the network attribute is compared to a specific value; otherwise, the network attribute is compared to another network attribute. To use a feature's network category value, ensure the name and type are set as Category and that isSpecificValue is set as true. The default is null.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "name" : <string>,
    "type" : "networkAttribute" | "category"
    "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
    "value" : <string>,
    "combineUsingOr" : <true | false>,
    "isSpecificValue" : <true | false>
  }
]

Learn more about using multiple conditional expressions

functionBarriers

(Optional)

Specifies an array of objects representing function barriers.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
[
  {
    "functionType" : "add" | "subtract" |
                   "average" | "count" |
                   "min" | "max",
    "networkAttributeName" : <string>,
    "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
    "value" : <string>,
    "useLocalValues":true | false
  }
]

filterBarriers

(Optional)

Specifies an array of objects (representing network attribute or category conditions) that serve as filter barriers If isSpecificValue is true, the network attribute is compared to a specific value; otherwise, the network attribute is compared to another network attribute. The default is null.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
  {
    "name" : <string>,
    "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
    "value" : string (numeric),
    "combineUsingOr" : <true | false>,
    "isSpecificValue" : <true | false>
  }
]

Learn more about using multiple conditional expressions

filterFunctionBarriers

(Optional)

Specifies an array of objects representing filter function barriers.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
  {
    "functionType" : "add" | "subtract" |
                   "average" | "count" |
                   "min" | "max",
    "networkAttributeName" : <string>,
    "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
    "value" : string (numeric)
  }
]

functions

(Optional)

Specifies an array of objects representing functions. Each function can have an optional array of network attribute conditions.

Syntax:

Use dark colors for code blocksCopy
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
[
  {
    "functionType" : "add" | "subtract"
                   | "average" | "count"
                   | "min" | "max",
    "networkAttributeName" : <string>,
    "conditions":
    [
      {
        "name" : <string>,
        "type" : "networkAttribute" | "category",
        "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual |
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
        "value" : <string>,
        "combineUsingOr" : <true | false>,
        "isSpecificValue" : <true | false>
     }
   ],
   "summaryAttributeName" : <string>
 }
]

Learn more about using multiple conditional expressions

nearestNeighbor

(Optional)

Specifies the parameters needed for calculating nearest neighbors. The default is null.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "count" : int
  "costNetworkAttributeName" : string,
  "nearestCategories" : array of string,
  "nearestAssets"
  [
    {
      "networkSourceId" : long,
      "assetGroupCode" : long,
      "assetTypeCode" : long
    }
  ]
}

outputFilters

(Optional)

Specifies an array of objects representing the output filter. The default is null.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
[
 {
  "networkSourceId" : long,
  "assetGroupCode" : long,
  "assetTypeCode" : long
 }
]

outputConditions

(Optional)

Specifies the type of features returned based on a network attribute or category.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
 {
  "name": "<string>",
  "type": "networkAttribute" | "category",
  "operator": "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
  "value": <string>,
  "combineUsingOr": <true | false>,
  "isSpecificValue": <true | false>
 }
]

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
[
 {
  "name": "Line Asset Group",
  "type": "networkAttribute",
  "operator": "equal",
  "value": 1,
  "combineUsingOr": false,
  "isSpecificValue": true
 }
]

Learn more about using multiple conditional expressions

propagators

(Optional)

Specifies an array of objects to define. The default is null.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[
 {
  "networkAttributeName" : "<string>",
  "substitutionAttributeName": "<string>",
  "propagatorfunctionType" : "bitwiseAnd" | "min" | "max",
  "operator" : "equal" | "notEqual"
               | "greaterThan"
               | "greaterThanEqual"
               | "lessThan"
               | "lessThanEqual"
               | "includesTheValues"
               | "doesNotIncludeTheValues"
               | "includesAny"
               | "doesNotIncludeAny",
  "value" : "<string (numeric)>",
  "propagatedAttributeName": "<string>"
 }
]

JSON Response syntax

JSON response (when async = false):

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
{
  "traceResults" : {
    "elements" : [
      {
        "networkSourceId" : <long>,
        "globalId" : <guid>,
        "objectId" : <long>,
        "terminalId" : <long>,
        "assetGroupCode" : <long>,
        "assetTypeCode" : <long>,
        "positionFrom" : <double>,
        "positionTo" : <double>,
        "firstUnit" : <short>, // When the utility network contains a telecom domain network.
        "lastUnit" : <short>  // When the utility network contains a telecom domain network.

      }
    ],
    "connectivity": [
      {
        "viaNetworkSourceId": <long>,
        "viaGlobalId": <guid>,
        "viaObjectId": <long>,
        "viaPositionFrom": <double>,
        "viaPositionTo": <double>,
        "viaGeometry": <geometry>,
        "viaFirstUnit" : <short>, // When the utility network contains a telecom domain network.
        "fromNetworkSourceId": <long>,
        "fromGlobalId": <guid>,
        "fromObjectId": <long>,
        "fromTerminalId": <long>,
        "fromGeometry": <geometry>,
        "fromFirstUnit" : <short>, // When the utility network contains a telecom domain network.
        "toNetworkSourceId": <long>,
        "toGlobalId": <guid>,
        "toObjectId": <long>,
        "toTerminalId": <long>,
        "toGeometry": <geometry>,
        "toFirstUnit" : <short>, // When the utility network contains a telecom domain network.
        "lastUnit" : <short>, // When the utility network contains a telecom domain network.
        "viaNetworkSourceName": <string>,
        "fromNetworkSourceName": <string>,
        "fromTerminalName": <string>,
        "toNetworkSourceName": <string>,
        "toTerminalName": <string>
      },
    ],
    "featureElements": [
      {
        "networkSourceId": <long>,
        "globalId": <guid>,
        "objectId": <long>,
        "terminalId": <long>,
        "assetGroupCode": <long>,
        "assetTypeCode": <long>,
        "firstUnit" : <short>, // When the utility network contains a telecom domain network.
        "lastUnit" : <short>,  // When the utility network contains a telecom domain network.
        "positionFrom": <double>,
        "positionTo": <double>,
        "geometry": <geometry>,
        "networkSourceName": <string>,
        "assetGroupName": <string>,
        "assetTypeName": <string>,
        "terminalName": <string>,
        "networkAttributesValues" : [
          {
            "<attributeName>" : <value>, ...
          }
        ],
        "networkAttributeDescriptions" : [],
        "fieldValues" : [
          {
          "fieldName" : <value>,
          "value" : <value>,
          "description" : <string>
          }
        ],
      }
    ],
    "associations": [
      {
        "associationType": <long>,
        "fromNetworkSourceId": <long>,
        "fromGlobalId": <guid>,
        "fromTerminalId": <long>,
        "toNetworkSourceId": <long>,
        "toGlobalId": <guid>,
        "toTerminalId": <long>,
        "fromNetworkSourceName": <string>,
        "fromTerminalName": <string>,
        "toNetworkSourceName": <string>,
        "toTerminalName": <string>
          }
        ],
    "relatedRecords": [
      {
        "networkSourceId": <long>,
        "networkSourceName": <string>,
        "globalId": <guid>,
        "relationshipClasses": [
          {
            "originLayerId": <long>,
            "destinationLayerId": <long>,
            "name": <string>,
            "originName": <string>,  // When includeDomainDescriptions is true.
            "destinationName": <string>, // When includeDomainDescriptions is true.
            "relationships": [
              {
                "outFields": [],
                "relationshipOutFields": []
              }
            ]
          }
        ]
      }
    ],
]
    "diagramName": <string>,
    "globalFunctionResults" : [],
    "kFeaturesForKNNFound" : <true | false>,
    "startingPointsIgnored" : <true | false>,
    "warnings" : [ <string> ]
  }
  "sourceMapping":
  {
    "networkSourceId": <string>,
    ...
  },
  "resultTypes": [
    {
      "type": "features" | "connectivity" | "controllers" | "associations" | "paths" | "relatedRecords",
      "includeGeometry": true | false,
      "includePropagatedValues": true | false,
      "networkAttributeNames": ["<networkAttributeName1>", ...],
      "diagramTemplateName": <string>,
      "resultTypeFields": [
        {
          "networkSourceId": <long>,
          "fieldName": <string>
        }
      ],
      "relationshipClasses" : [
        {
          "originLayerId" : <long>,
          "destinationLayerId" : <long>,
          "outFields" : [<string>, ...],
          "relationshipOutFields" : [<string>, ...]
        }
      ]
    }
  ],
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

JSON response (when async = true):

Use dark colors for code blocksCopy
1
2
3
{
  "statusUrl" : <url>
}

JSON response to the status URL (when pending or in progress):

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "status" : "<Pending | InProgress>",
  "submissionTime" : <datetime>,
  "lastUpdatedTime" : <datetime>
 }

Example usage

Perform a subnetwork trace for the ElectricDistribution domain network in the Medium Voltage Radial tier. The trace operation request includes the traceConfiguration parameter. No telecom domain network is present in the utility network.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/LandUse/UtilityNetworkServer/trace

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
f=json
gdbVersion=SDE.DEFAULT
sessionID=
moment=
traceType=subnetwork
traceLocations=[]
traceConfiguration=
{
 "includeContainers": true,
 "includeContent": true,
 "includeStructures": true,
 "includeBarriers": true,
 "validateConsistency": true,
 "validateLocatability": false,
 "synthesizeGeometries": false,
 "includeIsolated": false,
 "ignoreBarriersAtStartingPoints": false,
 "includeUpToFirstSpatialContainer":false,
 "allowIndeterminateFlow":true,
 "useDigitizedDirection":false,
 "domainNetworkName": "ElectricDistribution",
 "tierName": "Medium Voltage",
 "targetTierName": "",
 "subnetworkName": "oakview_01",
 "diagramTemplateName": "",
 "shortestPathNetworkAttributeName": "",
 "filterBitsetNetworkAttributeName": "",
 "traversabilityScope": "junctionsAndEdges",
 "numPaths": -1,
 "maxHops": -1,
 "conditionBarriers": [
    {
      "name": "Device Status",
      "type": "networkAttribute",
      "operator": "equal",
      "value": 1,
      "combineUsingOr": false,
      "isSpecificValue": true
    }
 ],
 "functionBarriers": [],
 "arcadeExpressionBarrier": "",
 "filterBarriers": [],
 "filterFunctionBarriers": [],
 "filterScope": "junctionsAndEdges",
 "functions": [],
 "nearestNeighbor": {
      "count": -1,
      "costNetworkAttributeName": "",
      "nearestCategories": [],
      "nearestAssets": []
 },
 "outputFilters": [],
 "outputConditions": [],
 "propagators": [
   {
     "networkAttributeName":"Phases Current",
     "substitutionAttributeName":"phasessub",
     "propagatorFunctionType":"bitwiseAnd",
     "operator":"includesAny",
     "value":15,
     "propagatedAttributeName":""
   }
 ]
},
resultTypes= [
  {
   "type":"features",
   "includeGeometry":true,
   "includePropagatedValues":false,
   "includeDomainDescriptions":false,
   "networkAttributeNames":["Is subnetwork controller"],
   "diagramTemplateName":"",
   "resultTypeFields":[{"networkSourceId":9,"fieldName":"phasescurrent"}]
  },
  {
   "type":"connectivity",
   "includeGeometry":false,
   "includePropagatedValues":false,
   "includeDomainDescriptions":false,
   "networkAttributeNames":[],
   "diagramTemplateName":"",
   "resultTypeFields":[]
   }
]
async=false

JSON response:

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
{
  "traceResults": {
    "featureElements": [
      {
        "networkSourceId": 12,
        "globalId": "{CE537B94-E634-4F7E-9DA2-A3F219EA8D8A}",
        "objectId": 21,
        "terminalId": 1,
        "assetGroupCode": 5,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807667.161118746,
          "y": 1846163.1724515558,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 12,
        "globalId": "{1E737D64-32D3-4F9C-97E5-6CAAA163B497}",
        "objectId": 18,
        "terminalId": 1,
        "assetGroupCode": 1,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807667.716891915,
          "y": 1846152.3732605577,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 12,
        "globalId": "{245E6D0A-0BDC-4DF8-B9ED-3A613991A6A2}",
        "objectId": 20,
        "terminalId": 1,
        "assetGroupCode": 1,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807735.146219,
          "y": 1846163.219695568,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 12,
        "globalId": "{923E8163-2BFA-430D-987A-21A4E37C879D}",
        "objectId": 19,
        "terminalId": 1,
        "assetGroupCode": 1,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807705.951395497,
          "y": 1846162.8719272316,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 12,
        "globalId": "{046362B3-E6A2-4C52-BC3E-C7BF641E8914}",
        "objectId": 9,
        "terminalId": 1,
        "assetGroupCode": 5,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807851.27131483,
          "y": 1846266.5347776414,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 12,
        "globalId": "{A43506DE-91DB-44A0-9A4C-FD6D8DCD1C55}",
        "objectId": 7,
        "terminalId": 1,
        "assetGroupCode": 1,
        "assetTypeCode": 1,
        "geometry": {
          "x": 6807863.391041249,
          "y": 1846185.0434708149,
          "z": 0,
          "m": null
        }
      },
      {
        "networkSourceId": 10,
        "globalId": "{DF8BF4A1-4681-47CF-BE4A-96CF0D6C6458}",
        "objectId": 2247,
        "assetGroupCode": 4,
        "assetTypeCode": 3,
        "positionFrom": 0,
        "positionTo": 1,
        "geometry": {
          "hasZ": true,
          "hasM": true,
          "paths": [
            [
              [
                6807862.803443998,
                1846266.5859586448,
                0,
                null
              ],
              [
                6807963.476470992,
                1846261.9025690556,
                0,
                null
              ]
            ]
          ]
        }
      }
    ],
    "connectivity": [
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{0EE946B2-78D0-4BAC-8B74-D025CBA2EDC3}",
        "viaObjectId": 16,
        "viaPositionFrom": 0.771530936343911,
        "viaPositionTo": 1,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{CE537B94-E634-4F7E-9DA2-A3F219EA8D8A}",
        "fromObjectId": 21,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 12,
        "toGlobalId": "{1E737D64-32D3-4F9C-97E5-6CAAA163B497}",
        "toObjectId": 18,
        "toTerminalId": 1,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{74CDDEB8-25E5-40CA-80A6-5EE0FA47C3C8}",
        "viaObjectId": 5,
        "viaPositionFrom": 0,
        "viaPositionTo": 1,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{65991DC0-C048-4180-BE3F-D95FAE816A72}",
        "fromObjectId": 4,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 9,
        "toGlobalId": "{58A65781-93D2-4EBE-8CFB-E4AF4C4ED6AE}",
        "toObjectId": 5,
        "toTerminalId": 1,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{669946F4-B6E3-4CEA-9D5A-34521B9BF330}",
        "viaObjectId": 461,
        "viaPositionFrom": 0.07442874427180345,
        "viaPositionTo": 0.670766639232807,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{C0896252-1AF0-46CF-AF86-139F215870DA}",
        "fromObjectId": 337,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 12,
        "toGlobalId": "{1D3999D1-28C6-4463-A28E-96B36C591AAC}",
        "toObjectId": 413,
        "toTerminalId": 1,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{669946F4-B6E3-4CEA-9D5A-34521B9BF330}",
        "viaObjectId": 461,
        "viaPositionFrom": 0.670766639232807,
        "viaPositionTo": 0.7871749615820911,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{1D3999D1-28C6-4463-A28E-96B36C591AAC}",
        "fromObjectId": 413,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 12,
        "toGlobalId": "{4BE88B18-DC04-4179-BB60-5A3E5D2637C3}",
        "toObjectId": 414,
        "toTerminalId": 1,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{669946F4-B6E3-4CEA-9D5A-34521B9BF330}",
        "viaObjectId": 461,
        "viaPositionFrom": 0.7871749615820911,
        "viaPositionTo": 1,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{4BE88B18-DC04-4179-BB60-5A3E5D2637C3}",
        "fromObjectId": 414,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 2,
        "toGlobalId": "{2F90F7D3-3401-4893-AEAC-A191CD4F0BBD}",
        "toObjectId": 2619,
        "toTerminalId": 0,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{DD1644D9-8921-4C85-9A44-1674FDF9D4FF}",
        "viaObjectId": 1,
        "viaPositionFrom": 0,
        "viaPositionTo": 0.46821569031543666,
        "viaGeometry": {},
        "fromNetworkSourceId": 2,
        "fromGlobalId": "{DFE16D5E-1D98-43AF-9F13-860EC6E1D78E}",
        "fromObjectId": 2715,
        "fromTerminalId": 0,
        "fromGeometry": {},
        "toNetworkSourceId": 12,
        "toGlobalId": "{B00A4B9A-B38F-4167-AD85-1BF33DF30047}",
        "toObjectId": 331,
        "toTerminalId": 1,
        "toGeometry": {}
      },
      {
        "viaNetworkSourceId": 10,
        "viaGlobalId": "{DD1644D9-8921-4C85-9A44-1674FDF9D4FF}",
        "viaObjectId": 1,
        "viaPositionFrom": 0.46821569031543666,
        "viaPositionTo": 0.5298812758175973,
        "viaGeometry": {},
        "fromNetworkSourceId": 12,
        "fromGlobalId": "{B00A4B9A-B38F-4167-AD85-1BF33DF30047}",
        "fromObjectId": 331,
        "fromTerminalId": 1,
        "fromGeometry": {},
        "toNetworkSourceId": 12,
        "toGlobalId": "{340219C0-41DB-4C65-B5BC-4E25868472D0}",
        "toObjectId": 332,
        "toTerminalId": 1,
        "toGeometry": {}
      }
    ],
    "elements": [],
    "diagramName": "<placeholder>",
    "globalFunctionResults": [],
    "kFeaturesForKNNFound": false,
    "startingPointsIgnored": false,
    "warnings": [],
    "sourceMapping": {
      "1": "UN_6_Associations",
      "2": "UN_6_SystemJunctions",
      "4": "StructureJunction",
      "6": "StructureBoundary",
      "7": "StructureJunctionObject",
      "5": "StructureLine",
      "8": "StructureEdgeObject",
      "9": "ElectricDistributionDevice",
      "11": "ElectricDistributionAssembly",
      "12": "ElectricDistributionJunction",
      "14": "ElectricDistributionJunctionObject",
      "10": "ElectricDistributionLine",
      "13": "ElectricDistributionSubnetLine",
      "15": "ElectricDistributionEdgeObject"
    },
    "resultTypes": [
      {
        "type": "features",
        "includeGeometry": true,
        "includePropagatedValues": false,
        "includeDomainDescriptions": false,
        "networkAttributeNames": [
          "Is subnetwork controller"
        ],
        "diagramTemplateName": "",
        "resultTypeFields": [
          {
            "networkSourceId": 9,
            "fieldName": "phasescurrent"
          }
        ]
      },
      {
        "type": "connectivity",
        "includeGeometry": false,
        "includePropagatedValues": false,
        "includeDomainDescriptions": false,
        "networkAttributeNames": [],
        "diagramTemplateName": "",
        "resultTypeFields": []
      }
    ]
  },
  "success": true
}

Perform a path trace on the Telco domain network using the paths resultType.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/TelecomService/UtilityNetworkServer/trace

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

f=json
gdbVersion=SDE.DEFAULT
sessionID=
moment=
traceType=path
traceLocations=
[
  {
    "traceLocationType": "startingPoint",
    "globalId": "{F448D4AC-1BBA-4F0C-A8AD-3E0714381461}",
    "terminalId": 1,
    "percentAlong": -1,
    "isFilterBarrier": false,
    "firstUnit": 1,
    "lastUnit": 1
  },
  {
    "traceLocationType": "startingPoint",
    "globalId": "{BBBF8ACF-58D9-42E6-8A90-557673839151}",
    "terminalId": 1,
    "percentAlong": -1,
    "isFilterBarrier": false,
    "firstUnit": 1,
    "lastUnit": 1
  },
  {
    "traceLocationType": "stoppingPoint",
    "globalId": "{D8BF0EA4-BD68-46B1-B037-766C2F7AF08E}",
    "terminalId": 1,
    "percentAlong": -1,
    "isFilterBarrier": false,
    "firstUnit": 1,
    "lastUnit": 1
  },
  {
    "traceLocationType": "stoppingPoint",
    "globalId": "{4DB934A7-E421-4E6A-9D00-0B3074B54832}",
    "terminalId": 1,
    "percentAlong": -1,
    "isFilterBarrier": false,
    "firstUnit": 1,
    "lastUnit": 1
  }
]
traceConfiguration=
{
 "includeContainers": false,
 "includeContent": false,
 "includeStructures": false,
 "includeBarriers": true,
 "validateConsistency": true,
 "validateLocatability": false,
 "synthesizeGeometries": false,
 "includeIsolated": false,
 "ignoreBarriersAtStartingPoints": false,
 "includeUpToFirstSpatialContainer":false,
 "allowIndeterminateFlow":true,
 "useDigitizedDirection":false,
 "domainNetworkName": "Telco",
 "tierName": "",
 "targetTierName": "",
 "subnetworkName": "",
 "diagramTemplateName": "",
 "shortestPathNetworkAttributeName": "",
 "filterBitsetNetworkAttributeName": "",
 "traversabilityScope": "junctionsAndEdges",
 "numPaths": 2,
 "maxHops": 100,
 "inferConnectivity": false,
 "circuitName": "",
 "conditionBarriers": [],
 "functionBarriers": [],
 "arcadeExpressionBarrier": "",
 "filterBarriers": [],
 "filterFunctionBarriers": [],
 "filterScope": "junctionsAndEdges",
 "functions": [],
 "nearestNeighbor": {
   "count": -1,
   "costNetworkAttributeName": "",
   "nearestCategories": [],
   "nearestAssets": []
 },
 "outputFilters": [],
 "outputConditions": [],
 "propagators": []
},
resultTypes= [
  {
   "type":"paths",
   "includeGeometry":true,
   "includePropagatedValues":false,
   "includeDomainDescriptions":false,
   "networkAttributeNames":[],
   "diagramTemplateName":"",
   "resultTypeFields":[{}]
   }
]
async=false

JSON Response:

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

{
  "traceResults": {
    "paths": [
      {
        "pathId": 1,
        "order": 1,
        "startingPoint": {
          "globalId": "{F448D4AC-1BBA-4F0C-A8AD-3E0714381461}",
          "terminalId": 1,
          "percentAlong": -1,
          "isFilterBarrier": false,
          "firstUnit": 1,
          "lastUnit": 1,
          "networkSourceId": 20
        },
        "stoppingPoint": {
          "globalId": "{D8BF0EA4-BD68-46B1-B037-766C2F7AF08E}",
          "terminalId": 1,
          "percentAlong": -1,
          "isFilterBarrier": false,
          "firstUnit": 1,
          "lastUnit": 1,
          "networkSourceId": 20
        },
        "pathConnectivity": [
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{6C2B921C-1641-4671-8BAB-2AAB5183B38A}",
            "edgeObjectId": 1,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{62696C18-7BDE-47B4-87ED-0ACFC754A4CA}",
            "junctionObjectId": 2,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          },
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{305DD264-988A-4327-A22E-D6A778F7F092}",
            "edgeObjectId": 2,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{C3A71DC0-ACD2-4BC7-AAF4-1EE80CF86EF4}",
            "junctionObjectId": 3,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          },
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{6A91B9B9-7AF9-4C64-AA46-9B5DBF0BA543}",
            "edgeObjectId": 6,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{D8BF0EA4-BD68-46B1-B037-766C2F7AF08E}",
            "junctionObjectId": 7,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          }
        ],
        "geometry": {
          "hasZ": true,
          "hasM": true,
          "paths": [
            [
              [
                6812027.024774224,
                1844087.451537311,
                0,
                null
              ],
              [
                6812159.711844802,
                1844093.057825312,
                0,
                null
              ]
            ],
            [
              [
                6812159.711844802,
                1844093.057825312,
                0,
                null
              ],
              [
                6812159.711844802,
                1844010.8293152303,
                0,
                null
              ]
            ],
            [
              [
                6812159.711844802,
                1844010.8293152303,
                0,
                null
              ],
              [
                6812288.661061972,
                1844008.9605525584,
                0,
                null
              ]
            ]
          ]
        }
      },
      {
        "pathId": 2,
        "order": 2,
        "startingPoint": {
          "globalId": "{F448D4AC-1BBA-4F0C-A8AD-3E0714381461}",
          "terminalId": 1,
          "percentAlong": -1,
          "isFilterBarrier": false,
          "firstUnit": 1,
          "lastUnit": 1,
          "networkSourceId": 20
        },
        "stoppingPoint": {
          "globalId": "{D8BF0EA4-BD68-46B1-B037-766C2F7AF08E}",
          "terminalId": 1,
          "percentAlong": -1,
          "isFilterBarrier": false,
          "firstUnit": 1,
          "lastUnit": 1,
          "networkSourceId": 20
        },
        "pathConnectivity": [
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{EF9A24A3-D0BC-4384-8FE2-06A6378B3CAB}",
            "edgeObjectId": 4,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{A2544F31-8ED1-4456-97AF-AD3499A31955}",
            "junctionObjectId": 5,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          },
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{E1CD069D-9FE2-43D3-9C1E-C7917DE1BE26}",
            "edgeObjectId": 8,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{4DB934A7-E421-4E6A-9D00-0B3074B54832}",
            "junctionObjectId": 11,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          },
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{218C0123-8C2C-4E57-8819-C181ABEE554B}",
            "edgeObjectId": 13,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{62FB1894-A9F1-493B-9DE1-D89A84AC6FB7}",
            "junctionObjectId": 10,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          },
          {
            "edgeNetworkSourceId": 17,
            "edgeGlobalId": "{236EC60B-199A-434A-BE04-53919576E5ED}",
            "edgeObjectId": 10,
            "edgePositionFrom": 0,
            "edgePositionTo": 1,
            "edgeFirstUnit": 1,
            "edgeLastUnit": 1,
            "junctionNetworkSourceId": 16,
            "junctionGlobalId": "{D8BF0EA4-BD68-46B1-B037-766C2F7AF08E}",
            "junctionObjectId": 7,
            "junctionTerminalId": 1,
            "junctionFirstUnit": 1,
            "junctionLastUnit": 1
          }
        ],
        "geometry": {
          "hasZ": true,
          "hasM": true,
          "paths": [
            [
              [
                6812027.024774224,
                1844087.451537311,
                0,
                null
              ],
              [
                6812157.842754051,
                1843861.3230525554,
                0,
                null
              ]
            ],
            [
              [
                6812157.842754051,
                1843861.3230525554,
                0,
                null
              ],
              [
                6812537.215026811,
                1843921.1257544757,
                0,
                null
              ]
            ],
            [
              [
                6812423.216567144,
                1844008.9605525584,
                0,
                null
              ],
              [
                6812537.215026811,
                1843921.1257544757,
                0,
                null
              ]
            ],
            [
              [
                6812288.661061972,
                1844008.9605525584,
                0,
                null
              ],
              [
                6812423.216567144,
                1844008.9605525584,
                0,
                null
              ]
            ]
          ]
        }
      }
    ],
    "elements": [],
    "diagramName": "<placeholder>",
    "globalFunctionResults": [],
    "kFeaturesForKNNFound": false,
    "startingPointsIgnored": false,
    "warnings": [],
    "sourceMapping": {
      "1": "UN_6_Associations",
      "2": "UN_6_SystemJunctions",
      "4": "StructureJunction",
      "6": "StructureBoundary",
      "7": "StructureJunctionObject",
      "5": "StructureLine",
      "8": "StructureEdgeObject",
      "9": "ElectricDistributionDevice",
      "11": "ElectricDistributionAssembly",
      "12": "ElectricDistributionJunction",
      "14": "ElectricDistributionJunctionObject",
      "10": "ElectricDistributionLine",
      "13": "ElectricDistributionSubnetLine",
      "15": "ElectricDistributionEdgeObject",
      "16": "TelcoDevice",
      "18": "TelcoAssembly",
      "19": "TelcoJunction",
      "20": "TelcoJunctionObject",
      "17": "TelcoLine",
      "21": "TelcoEdgeObject",
      "22": "TelcoCircuit",
      "23": "TelcoCircuitSection",
      "24": "TelcoSubcircuit"
    },
    "resultTypes": [
      {
        "type": "paths",
        "includeGeometry": true,
        "includePropagatedValues": false,
        "includeDomainDescriptions": false,
        "networkAttributeNames": [],
        "diagramTemplateName": "",
        "resultTypeFields": []
      }
    ]
  },
  "success": true
}

Perform a subnetwork trace for the ElectricDistribution domain network in the Medium Voltage tier to return attribute values describing the Phase and Device Status of a switch from a related table (SwitchUnit). No telecom domain network is present in the utility network.

Request URL and parameters:

Use dark colors for code blocksCopy
1
2

https://myserver.esri.com/server/rest/services/LandUse/UtilityNetworkServer/trace
Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
f=json
gdbVersion=SDE.DEFAULT
sessionID=
moment=
traceType=subnetwork
traceLocations=[]
traceConfiguration=
{
 "includeContainers": true,
 "includeContent": true,
 "includeStructures": true,
 "includeBarriers": true,
 "validateConsistency": true,
 "validateLocatability": false,
 "synthesizeGeometries": false,
 "includeIsolated": false,
 "ignoreBarriersAtStartingPoints": false,
 "includeUpToFirstSpatialContainer":false,
 "allowIndeterminateFlow":true,
 "useDigitizedDirection":false,
 "domainNetworkName": "ElectricDistribution",
 "tierName": "Medium Voltage",
 "targetTierName": "",
 "subnetworkName": "RMT001",
 "diagramTemplateName": "",
 "shortestPathNetworkAttributeName": "",
 "filterBitsetNetworkAttributeName": "",
 "traversabilityScope": "junctionsAndEdges",
 "conditionBarriers": [
   {
     "name": "Device Status",
     "type": "networkAttribute",
     "operator": "equal",
     "value": 1,
     "combineUsingOr": false,
     "isSpecificValue": true
   }
 ],
 "functionBarriers": [],
 "arcadeExpressionBarrier": "",
 "filterBarriers": [],
 "filterFunctionBarriers": [],
 "filterScope": "junctionsAndEdges",
 "functions": [],
 "nearestNeighbor": {
     "count": -1,
     "costNetworkAttributeName": "",
     "nearestCategories": [],
     "nearestAssets": []
 },
 "outputFilters": [],
 "outputConditions": [],
 "propagators": [
 {
  "networkAttributeName":"Phases Current",
  "substitutionAttributeName":"phasessub",
  "propagatorFunctionType":"bitwiseAnd",
  "operator":"includesAny",
  "value":15,
  "propagatedAttributeName":""
}
]
},
resultTypes= [
  {
    "type": "relatedRecords",
    "includeGeometry": true,
    "includePropagatedValues": false,
    "includeDomainDescriptions": true,
    "networkAttributeNames": [],
    "diagramTemplateName": "",
    "resultTypeFields": [],
    "relationshipClasses": [
      {
        "originLayerOrTableId": 10,
        "destinationLayerOrTableId": 33,
        "outFields": [
          "Phase, ​DeviceStatus"
        ],
        "relationshipOutFields": []
      }
    ]
  }
]
async=false

JSON Response:

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

{
  "relatedRecords": [
  {
  "networkSourceId": 5,
  "networkSourceName": "ElectricDevice",
  "globalId": "{BE50E691-9297-4B9E-B6D2-24DA3D16FF8E}",
  "relationshipClasses": [
    {
      "originLayerId": 5,
      "destinationLayerId": 1,
      "name": "ElecDevice_SwitchUnit",
      "originName": "ElecDevice",
      "destinationName": "SwitchUnit",
      "relationships": [
        {
          "outFields": [
            {
              "name": "Phase",
              "value": 4,
              "description": "A"
            },
            {
              "name": "DeviceStatus",
              "value": 1,
              "description": "Closed"
            }
          ]
        },
        {
          "outFields": [
            {
              "name": "Phase",
              "value": 2,
              "description": "B"
            },
            {
              "name": "DeviceStatus",
              "value": 1,
              "description": "Closed"
            }
          ]
        },
        {
          "outFields": [
            {
              "name": "Phase",
              "value": 1,
              "description": "C"
            },
            {
              "name": "DeviceStatus",
              "value": 0,
              "description": "Open"
            }
          ]
        }
      ]
    }
  ]
 }
],
"sourceMapping": {
  "1": "UN_6_Associations",
  "2": "UN_6_SystemJunctions",
  "4": "StructureJunction",
  "6": "StructureBoundary",
  "7": "StructureJunctionObject",
  "5": "StructureLine",
  "8": "StructureEdgeObject",
  "9": "ElectricDistributionDevice",
  "11": "ElectricDistributionAssembly",
  "12": "ElectricDistributionJunction",
  "14": "ElectricDistributionJunctionObject",
  "10": "ElectricDistributionLine",
  "13": "ElectricDistributionSubnetLine",
  "15": "ElectricDistributionEdgeObject",
  "16": "ElectricTransmissionDevice",
  "18": "ElectricTransmissionAssembly",
  "19": "ElectricTransmissionJunction",
  "21": "ElectricTransmissionJunctionObject",
  "17": "ElectricTransmissionLine",
  "20": "ElectricTransmissionSubnetLine",
  "22": "ElectricTransmissionEdgeObject"
},
  "resultTypes": [
  {
    "type": "relatedRecords",
    "includeGeometry": true,
    "includePropagatedValues": false,
    "includeDomainDescriptions": true,
    "networkAttributeNames": [],
    "diagramTemplateName": "",
    "resultTypeFields": [],
    "relationshipClasses": [
      {
        "originLayerId": 5,
        "destinationLayerId": 1,
        "outFields": [
          "Phase",
          "DeviceStatus"
        ],
        "relationshipOutFields": []
      }
    ]
  }
]
}

Perform a circuit trace on the Telco domain network for a three section circuit named "CIRCUITA" using the circuits resultType.

Request URL and parameters:

Use dark colors for code blocksCopy
1
2

https://myserver.esri.com/server/rest/services/TelecomService/UtilityNetworkServer/trace
Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51

f=json
gdbVersion=SDE.DEFAULT
traceType=circuit
traceLocations=[]
traceConfiguration=
{
  "includeContainers": false,
  "includeContent": false,
  "includeStructures": false,
  "includeBarriers": true,
  "validateConsistency": true,
  "validateLocatability": true,
  "synthesizeGeometries": true,
  "ignoreBarriersAtStartingPoints": false,
  "includeUpToFirstSpatialContainer": false,
  "allowIndeterminateFlow": true,
  "useDigitizedDirection": false,
  "domainNetworkName": "Telco",
  "diagramTemplateName": "",
  "shortestPathNetworkAttributeName": "",
  "filterBitsetNetworkAttributeName": "",
  "traversabilityScope": "junctionsAndEdges",
  "numPaths": 2,
  "maxHops": 13,
  "inferConnectivity": false,
  "circuitName": "CIRCUITA",
  "conditionBarriers": [],
  "functionBarriers": [
    {
      "functionType": "add",
      "networkAttributeName": "act_len",
      "operator": "greaterThanEqual",
      "value": 52800,
      "useLocalValues": true
    }
  ],
  "arcadeExpressionBarrier": "",
  "filterBarriers": [],
  "filterFunctionBarriers": [],
  "filterScope": "junctionsAndEdges",
  "functions": [],
  "nearestNeighbor": {
    "count": -1,
    "costNetworkAttributeName": "",
    "nearestCategories": [],
    "nearestAssets": []
  },
  "outputFilters": [],
  "outputConditions": []
}

JSON Response:

Use dark colors for code blocksCopy
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
{
  "traceResults": {
    "circuits": [
      {
        "name": "CIRCUITA",
        "globalId": "{4E9D7334-B6B4-47EA-974E-985109985CFD}",
        "status": "Dirty",
        "isSectioned": true,
        "isDeleted": false,
        "lastExportedTime": "",
        "lastVerifiedTime": "",
        "sectionOrder": {
          "1": [2],
          "2": [3],
          "3": []
        },
        "circuitType": "Physical",
        "sections": [
          {
            "sectionId": 1,
            "role": "Start",
            "sectionType": "Physical",
            "startLocation": {
              "sourceId": 20,
              "globalId": "{332A2863-0CE0-41BC-847B-C0F1980C9E4C}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "stopLocation": {
              "sourceId": 20,
              "globalId": "{6C59BEF8-A74C-49E7-9A9C-144FA5CB3C3A}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "path": {
              "startingPoint": {
                "globalId": "{332A2863-0CE0-41BC-847B-C0F1980C9E4C}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "stoppingPoint": {
                "globalId": "{6C59BEF8-A74C-49E7-9A9C-144FA5CB3C3A}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "pathConnectivity": [
                {
                  "edgeNetworkSourceId": 21,
                  "edgeGlobalId": "{99037876-E6C7-472D-AA4A-7C0437C480EE}",
                  "edgeObjectId": 14,
                  "edgePositionFrom": 0,
                  "edgePositionTo": 1,
                  "edgeFirstUnit": 1,
                  "edgeLastUnit": 1,
                  "junctionNetworkSourceId": 20,
                  "junctionGlobalId": "{6C59BEF8-A74C-49E7-9A9C-144FA5CB3C3A}",
                  "junctionObjectId": 13,
                  "junctionTerminalId": 1,
                  "junctionFirstUnit": 1,
                  "junctionLastUnit": 1
                }
              ]
            }
          },
          {
            "sectionId": 2,
            "role": "Midspan",
            "sectionType": "Physical",
            "startLocation": {
              "sourceId": 20,
              "globalId": "{934DEC73-3379-423B-8513-CD3CECA7BEA0}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "stopLocation": {
              "sourceId": 20,
              "globalId": "{DB1D82DC-E7D8-4954-86DA-D97231FB0F5C}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "path": {
              "startingPoint": {
                "globalId": "{934DEC73-3379-423B-8513-CD3CECA7BEA0}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "stoppingPoint": {
                "globalId": "{DB1D82DC-E7D8-4954-86DA-D97231FB0F5C}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "pathConnectivity": [
                {
                  "edgeNetworkSourceId": 21,
                  "edgeGlobalId": "{CFE4D12B-DBE1-46D1-ACF2-5AEC12A1F49F}",
                  "edgeObjectId": 15,
                  "edgePositionFrom": 0,
                  "edgePositionTo": 1,
                  "edgeFirstUnit": 1,
                  "edgeLastUnit": 1,
                  "junctionNetworkSourceId": 20,
                  "junctionGlobalId": "{DB1D82DC-E7D8-4954-86DA-D97231FB0F5C}",
                  "junctionObjectId": 15,
                  "junctionTerminalId": 1,
                  "junctionFirstUnit": 1,
                  "junctionLastUnit": 1
                }
              ]
            }
          },
          {
            "sectionId": 3,
            "role": "End",
            "sectionType": "Physical",
            "startLocation": {
              "sourceId": 20,
              "globalId": "{1DF80678-5165-4C30-80E7-9D5EC349D58C}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "stopLocation": {
              "sourceId": 20,
              "globalId": "{A946E664-D07A-4DAB-8107-0F1CDF108AC9}",
              "terminalId": 1,
              "firstUnit": 1,
              "lastUnit": 1
            },
            "path": {
              "startingPoint": {
                "globalId": "{1DF80678-5165-4C30-80E7-9D5EC349D58C}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "stoppingPoint": {
                "globalId": "{A946E664-D07A-4DAB-8107-0F1CDF108AC9}",
                "terminalId": 1,
                "percentAlong": -1,
                "isFilterBarrier": false,
                "firstUnit": 1,
                "lastUnit": 1,
                "networkSourceId": 20
              },
              "pathConnectivity": [
                {
                  "edgeNetworkSourceId": 21,
                  "edgeGlobalId": "{5D797145-FC60-4C53-A5D9-85F8A7080B19}",
                  "edgeObjectId": 22,
                  "edgePositionFrom": 0,
                  "edgePositionTo": 1,
                  "edgeFirstUnit": 1,
                  "edgeLastUnit": 1,
                  "junctionNetworkSourceId": 20,
                  "junctionGlobalId": "{A946E664-D07A-4DAB-8107-0F1CDF108AC9}",
                  "junctionObjectId": 30,
                  "junctionTerminalId": 1,
                  "junctionFirstUnit": 1,
                  "junctionLastUnit": 1
                }
              ]
            }
          }
        ],
        "subcircuits": [],
        "attributes": {
          "Band": 100,
		  "Priv": "No"
        }
      }
    ],
    "elements": [],
    "diagramName": "<placeholder>",
    "globalFunctionResults": [],
    "kFeaturesForKNNFound": false,
    "startingPointsIgnored": false,
    "warnings": [],
    "sourceMapping": {
      "1": "UN_111_Associations",
      "2": "UN_111_SystemJunctions",
      "4": "StructureJunction",
      "6": "StructureBoundary",
      "7": "StructureJunctionObject",
      "5": "StructureLine",
      "8": "StructureEdgeObject",
      "9": "ElectricDistributionDevice",
      "11": "ElectricDistributionAssembly",
      "12": "ElectricDistributionJunction",
      "14": "ElectricDistributionJunctionObject",
      "10": "ElectricDistributionLine",
      "13": "ElectricDistributionSubnetLine",
      "15": "ElectricDistributionEdgeObject",
      "16": "TelcoDevice",
      "18": "TelcoAssembly",
      "19": "TelcoJunction",
      "20": "TelcoJunctionObject",
      "17": "TelcoLine",
      "21": "TelcoEdgeObject",
      "22": "TelcoCircuit",
      "23": "TelcoCircuitSection",
      "24": "TelcoSubcircuit"
    },
    "resultTypes": [
      {
        "type": "circuits",
        "includeGeometry": true,
        "includePropagatedValues": false,
        "includeDomainDescriptions": false,
        "networkAttributeNames": [],
        "diagramTemplateName": "",
        "resultTypeFields": []
      }
    ]
  },
  "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.