Query (Trace Configurations)

URL:
https://<root>/<serviceName>/UtilityNetworkServer/traceConfigurations/query
Methods:
POST
Version Introduced:
10.9

Description

The query operation returns all properties from one or more named trace configurations in a utility network.

Request parameters

ParameterDetails

f

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

Use dark colors for code blocksCopy
1
f=html | json | pjson

globalIds

(Optional)

Specifies the global IDs of the named trace configurations to be queried; this is provided as an array of strings.

Use dark colors for code blocksCopy
1
Syntax: globalIds=["<guid>"]

Example: globalIds= ["{D35AC002-499E-42E4-AE8E-BEE122F1F6B0}","{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]

creators

(Optional)

Specifies the creators of the named trace configurations to be queried; this is provided as an array of strings.

Use dark colors for code blocksCopy
1
Syntax: creators=[<string>]

tags

(Optional)

Specifies the user tags of the named trace configurations to be queried; this is provided as an array of strings.

Use dark colors for code blocksCopy
1
Syntax: tags=[<string>]

names

(Optional)

Specifies the names of the named trace configurations to be queried; this is provided as an array of strings.

Use dark colors for code blocksCopy
1
Syntax: names=[<string>]

JSON Response 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
29
30
{
  “traceConfigurations” : [
    {
      “name” : <string>,
      “description” : <string>,
      “traceType” : “connected” |“upstream” | “downstream” | “shortestPath” | "subnetwork" | "subnetwork controllers" | "loops" | "isolation",
      “traceConfiguration” : <traceConfiguration>,
      “resultTypes” :     [
      {
       “type” : ”elements” | “aggregatedGeometry”,
       “includeGeometry" : true | false,
       “includePropagatedValues”: true | false,
       “networkAttributeNames" :[“attribute1Name","attribute2Name”,...],
       “diagramTemplateName”: <value>,
       “resultTypeFields”:[{“networkSourceId”:<long>,”fieldname”:<value>},...]
      }
     ],
      “minNumStartingPoints” : “none” | “one” | “many”,
      “tags” : [ <string> ],
      “creator” : <string>,
      “globalId” : <guid>
    }
  ],
  “success” : <boolean>,
  “error” : {                   // only if success is false
    “extendedCode” : <HRESULT>,
    “message” : <error message>,
    “details” : [ <detail> ]
  }
}

Example usage

In this example, the query operation is used to return information for two named trace configurations by providing their global IDs.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/Naperville_Elec/UtilityNetworkServer/traceConfigurations/query

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
f=json
globalIds= ["{D35AC002-499E-42E4-AE8E-BEE122F1F6B0}", "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]
creators=
tags=
names=

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
{
 "traceConfigurations": [
  {
   "name": "Connected_RMT002",
   "description": "Connected trace on RMT002",
   "traceType": "connected",
   "traceConfiguration": {
    "includeContainers": false,
    "includeContent": false,
    "includeStructures": false,
    "includeBarriers": true,
    "validateConsistency": true,
    "validateLocatability": false,
    "includeIsolated": false,
    "ignoreBarriersAtStartingPoints": false,
    "includeUpToFirstSpatialContainer": false,
    "allowIndeterminateFlow": true,
    "domainNetworkName": "",
    "tierName": "",
    "targetTierName": "",
    "subnetworkName": "",
    "diagramTemplateName": "",
    "shortestPathNetworkAttributeName": "",
    "filterBitsetNetworkAttributeName": "",
    "traversabilityScope": "junctionsAndEdges",
    "maxPaths": -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": [ ]
   },
   "resultTypes": [
    {
     "type": "aggregatedGeometry",
     "includeGeometry": false,
     "includePropagatedValues": false,
     "networkAttributeNames": [
     ],
     "diagramTemplateName": "",
     "resultTypeFields": [
     ]
    }
   ],
   "minNumStartingPoints": "one",
   "creationDate": 1605637404000,
   "tags":    "tags": ["tag1,"tag2"],
   "creator": "unadmin",
   "globalId": "{D35AC002-499E-42E4-AE8E-BEE122F1F6B0}"
  },
  {
   "name": "Connected_RMT002_Container",
   "description": "Connected trace on RMT002 (Include Containers)",
   "traceType": "connected",
   "traceConfiguration": {
    "includeContainers": true,
    "includeContent": true,
    "includeStructures": false,
    "includeBarriers": true,
    "validateConsistency": true,
    "validateLocatability": false,
    "includeIsolated": false,
    "ignoreBarriersAtStartingPoints": false,
    "includeUpToFirstSpatialContainer": false,
    "allowIndeterminateFlow": true,
    "domainNetworkName": "",
    "tierName": "",
    "targetTierName": "",
    "subnetworkName": "",
    "diagramTemplateName": "",
    "shortestPathNetworkAttributeName": "",
    "filterBitsetNetworkAttributeName": "",
    "traversabilityScope": "junctionsAndEdges",
    "maxPaths": -1,
    "maxHops": -1,
    "conditionBarriers": [],
    "functionBarriers": [],
    "arcadeExpressionBarrier": "",
    "filterBarriers": [],
    "filterFunctionBarriers": [],
    "filterScope": "junctionsAndEdges",
    "functions": [],
    "nearestNeighbor": {
     "count": -1,
     "costNetworkAttributeName": "",
     "nearestCategories": [],
     "nearestAssets": [ ]
    },
    "outputFilters": [],
    "outputConditions": [],
    "propagators": [ ]
   },
   "resultTypes": [
    {
     "type": "elements",
     "includeGeometry": false,
     "includePropagatedValues": false,
     "networkAttributeNames": [
     ],
     "diagramTemplateName": "",
     "resultTypeFields": [
     ]
    }
   ],
   "minNumStartingPoints": "one",
   "creationDate": 1605637302000,
   "tags":    "tags": ["tag3,"tag4"],
   "creator": "unadmin",
   "globalId": "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"
  }
],
 "success": true
}

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