Create (Trace Configurations)

URL:: https://<root>/<serviceName>/UtilityNetworkServer/traceConfigurations/create
Methods:: POST
Required Capability:: Requires the ArcGIS Advanced Editing user type extension license
Version Introduced:: 10.9

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

Request parameters

Parameter Details

Parameter	Details
`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`
`name` (Required)	Specifies the name of the named trace configuration. Syntax: `name=<string>`
`description` (Optional)	Specifies the description of the named trace configuration. Syntax: `description=<string>`
`traceType` (Required)	The trace type. Specifies the core algorithm that will be used to analyze the network. Trace types can be configured using the `traceConfiguration` parameter. Use dark colors for code blocksCopy `1 traceType=connected \| subnetwork \| subnetworkController \| upstream \| downstream \| loops \| shortestPath \| isolation` Syntax: `traceType=<traceType>` Example: `traceType=subnetwork`
`traceConfiguration` (Required)	Specifies the collection of trace configuration properties. To reference the collection of trace configuration properties, see traceConfiguration properties. Syntax: `traceConfiguration=<traceConfiguration>`
`resultTypes` (Optional)	Specifies the types of results to return. The default is `elements`. Syntax : Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 [ { "type" : "elements" \| "aggregatedGeometry", "includeGeometry" : true \| false, "includePropagatedValues": true \| false, "networkAttributeNames" :["attribute1Name","attribute2Name",...], "diagramTemplateName": <value>, "resultTypeFields":[{"networkSourceId":<long>,"fieldname":<value>},...] },... ]`
`tags` (Optional)	Specifies user-provided tags as an array of strings. Syntax: `tags=[<string>]`

f

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

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

name

(Required)

Specifies the name of the named trace configuration.

Syntax: name=<string>

description

(Optional)

Specifies the description of the named trace configuration.

Syntax: description=<string>

traceType

(Required)

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

Use dark colors for code blocksCopy
traceType=connected | subnetwork | subnetworkController | upstream | downstream | loops | shortestPath | isolation

Syntax: traceType=<traceType>

Example: traceType=subnetwork

traceConfiguration

(Required)

Specifies the collection of trace configuration properties.

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

Syntax: traceConfiguration=<traceConfiguration>

resultTypes

(Optional)

Specifies the types of results to return. The default is elements.

Syntax :

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

tags

(Optional)

Specifies user-provided tags as an array of strings.

Syntax: tags=[<string>]

JSON Response syntax

JSON response:

Use dark colors for code blocksCopy
{
  “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

Use dark colors for code blocksCopy
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,
    "synthesizeGeometries": false,
    "includeIsolated": false,
    "ignoreBarriersAtStartingPoints": false,
    "includeUpToFirstSpatialContainer": true,
    "allowIndeterminateFlow": true,
    "useDigitizedDirection": false,
    "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:

Use dark colors for code blocksCopy
{
 "success": true
}