Skip To Content
ArcGIS Developers
Dashboard

Create (Trace Configurations)

Description

The create operation on the traceConfigurations resource provides the ability to create a single named trace configuration. Named trace configurations store the properties of a complex trace in a utility network and can be shared through a map service consumed by a web map or field app. Multiple parameters and properties are provided with the create operation that support the analytic workflows associated with the trace operation.

Learn more about named trace configurations

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

name

Description: Required parameter specifying the name of the trace configuration.

Syntax: name=<string>

description

Description: Optional parameter specifying the description of the named trace configuration.

Syntax: description=<string>

traceType

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

Values: <connected | subnetwork | subnetworkController | upstream | downstream | loops | shortestPath | isolation>

Syntax: traceType=<traceType>

Example: traceType=subnetwork

traceConfiguration

Description: Required parameter specifying the collection of trace configuration properties.

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

Syntax: traceConfiguration=<traceConfiguration>

resultTypes

Description: Optional parameter specifying the types of results to return.

Syntax :

[
  { 
    "type" : "elements" | "aggregatedGeometry",
    "includeGeometry" : true | false,
    "includePropagatedValues": true | false,
    "networkAttributeNames" :["attribute1Name","attribute2Name",...],
    "diagramTemplateName": <value>, 
    "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>},...]
  },...
]

tags

Description: Optional parameter specifying user-provided tags; this is provided as an array of strings.

Syntax: tags=[<string>]

JSON Response syntax

JSON response:

{
  “success” : <boolean>,
  “error” : {                   // only if success is false
    “extendedCode” : <HRESULT>,
    “message” : <error message>,
    “details” : [ <detail> ]
}
}

Example usage

Create a named trace configuration for a utility network using the create operation.

Request URL and parameters:

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

f=json
name=Connected_IncludeContainers
description=Connected trace example with containers
traceType=connected
traceConfiguration=
		{
    "includeContainers": true,
    "includeContent": false,
    "includeStructures": false,
    "includeBarriers": true,
    "validateConsistency": true,
    "validateLocatability": false,
    "includeIsolated": false,
    "ignoreBarriersAtStartingPoints": false,
    "includeUpToFirstSpatialContainer": true,
    "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":[]}]
tags=["Connected","Include_Containers"]

JSON response:

{
 "success": true
}