Skip To Content
ArcGIS Developers
Dashboard

Alter (Trace Configurations)

Description

The alter operation provides the ability to alter a single named trace configuration. A named trace configuration can only be altered by an administrator or the creator of the configuration. For example, you can update an existing trace configuration to accommodate changes in the network or address incorrectly set parameters without the need to delete and re-create a trace configuration. This enables existing map services to continue use of the named trace configuration without requiring the map to be republished.

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

globalId

Description: Required parameter specifying the global ID of the named trace configuration to alter.

Syntax: globalId=<guid>

name

Description: Optional parameter specifying the altered name of the trace configuration.

Syntax: name=<string>

description

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

Syntax: description=<string>

traceType

Description: Optional parameter. The trace type 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: Optional parameter specifying the collection of altered trace configuration properties.

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

Syntax: traceConfiguration=<traceConfiguration>

resultTypes

Description: Optional parameter specifying the altered 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 altered user-provided tags; this is provided as an array of strings.

Syntax: tags=[<string>]

JSON Response syntax

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

Example usage

Alter the name, description, and resultTypes parameter of a named trace configuration in a utility network using the alter operation.

Request URL and parameters:

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

f=json
globalId={FA46F1EB-796C-4FB9-8E7B-B184EC6D43DC}
name=Connected_IncludeContainers_update
description=Connected trace example with containers (updated 112020)
traceType=
traceConfiguration={}
resultTypes=[{"type":"aggregatedGeometry","includeGeometry":false,"includePropagatedValues":false,"networkAttributeNames":[],"diagramTemplateName":"","resultTypeFields":[]}]
tags=

JSON response:

{
 "success": true
}