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

Parameter Details

Parameter	Details
`f`	Specifies the output format of the response. The default response format is `html`. Values: `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. 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. 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. Syntax: `tags=[<string>]`
`names` (Optional)	Specifies the names of the named trace configurations to be queried; this is provided as an array of strings. Syntax: `names=[<string>]`

f

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

Values: 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.

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.

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.

Syntax: tags=[<string>]

names

(Optional)

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

Syntax: names=[<string>]

JSON Response syntax

Use dark colors for code blocksCopy
{
  “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
{
f=json
globalIds= ["{D35AC002-499E-42E4-AE8E-BEE122F1F6B0}", "{CE4E1432-14C2-470D-9FB3-9E1526CB889E}"]
creators=
tags=
names=

JSON response:

Use dark colors for code blocksCopy
{
 "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": [
			  {
      "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",
    "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
}