Skip To Content
ArcGIS Developers
Dashboard

Query (Trace Configurations)

Description

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

License:
The active portal account must be licensed with the ArcGIS Utility Network user type extension to use this operation.

Request parameters

ParameterDetails
f

Description: Optional parameter specifying the output format of the response. The default response format is html.

Values: html | json

globalIds

Description: Optional parameter specifying the global IDs of the named trace configurations to be queried; this is provided as an array of strings.

Syntax: globalIds=["<guid>"]

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

creators

Description: Optional parameter specifying the creators of the named trace configurations to be queried; this is provided as an array of strings.

Syntax: creators=[<string>]

tags

Description: Optional parameter specifying the user tags of the named trace configurations to be queried; this is provided as an array of strings.

Syntax: tags=[<string>]

names

Description: Optional parameter specifying the names of the named trace configurations to be queried; this is provided as an array of strings.

Syntax: names=[<string>]

JSON Response syntax

{ 
  “traceConfigurations” : [ 
    { 
      “name” : <string>, 
      “description” : <string>, 
      “traceType” : “connected” |“upstream” | “downstream” | “shortestPath” | "subnetwork" | "subnetwork controllers" | "loops" | "isolation",  
      “traceConfiguration” : <traceConfiguration>, 
      “resultTypes” : “elements” | “aggregatedGeometry”, 
      “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 ID's.

Request URL and parameters:

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

{
f=json
globalIds= ["{D35AC002-499E-42E4-AE8E-BEE122F1F6B0}", "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]
creators=
tags=
names=

JSON response:

{
 "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",
    "conditionBarriers": [],
    "functionBarriers": [],
    "arcadeExpressionBarrier": "",
    "filterBarriers": [],
    "filterFunctionBarriers": [],
    "filterScope": "junctionsAndEdges",
    "functions": [],
    "nearestNeighbor": {
     "count": -1,
     "costNetworkAttributeName": "",
     "nearestCategories": [],
     "nearestAssets": [ ]
    },
    "outputFilters": [],
    "outputConditions": [],
    "propagators": [ ]
   },
   "resultTypes": [],
   "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",
    "conditionBarriers": [],
    "functionBarriers": [],
    "arcadeExpressionBarrier": "",
    "filterBarriers": [],
    "filterFunctionBarriers": [],
    "filterScope": "junctionsAndEdges",
    "functions": [],
    "nearestNeighbor": {
     "count": -1,
     "costNetworkAttributeName": "",
     "nearestCategories": [],
     "nearestAssets": [ ]
    },
    "outputFilters": [],
    "outputConditions": [],
    "propagators": [ ]
   },
   "resultTypes": [],
   "minNumStartingPoints": "one",
   "creationDate": 1605637302000,
   "tags":    "tags": ["tag3,"tag4"],
   "creator": "unadmin",
   "globalId": "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"
  }
],
 "success": true
}