Alter (Trace Configurations)

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

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 named trace configuration. This enables existing map services to continue use of the named trace configuration without requiring the map to be republished.

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\`
`globalId` (Required)	Specifies the global ID of the named trace configuration to alter.
`name` (Optional)	Specifies the altered name of the named trace configuration. Syntax: `name=<string>`
`description`	Specifies the altered description of the named trace configuration. Syntax: `description=<string>`
`traceType` (Optional)	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 \| upstream \| downstream \| shortestPath` Syntax: `traceType=<traceType>` Example: `traceType=shortestPath`
`traceConfiguration` (Optional)	Specifies the collection of altered trace configuration properties. To reference the collection of trace configuration properties, see traceConfiguration properties. Syntax: `traceConfiguration=<traceConfiguration>`
`resultTypes` (Optional)	Specifies the altered types of results to return. 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 the altered 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\

globalId

(Required)

Specifies the global ID of the named trace configuration to alter.

name

(Optional)

Specifies the altered name of the named trace configuration.

Syntax: name=<string>

description

Specifies the altered description of the named trace configuration.

Syntax: description=<string>

traceType

(Optional)

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 |  upstream | downstream | shortestPath

Syntax: traceType=<traceType>

Example: traceType=shortestPath

traceConfiguration

(Optional)

Specifies the collection of altered trace configuration properties.

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

Syntax: traceConfiguration=<traceConfiguration>

resultTypes

(Optional)

Specifies the altered types of results to return.

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 the altered user-provided tags as an array of strings.

Syntax: tags=[<string>]

JSON Response syntax

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

Example usage

Alter the name and description of a named trace configuration in a trace network and add two tags using the alter operation.

Request URL and parameters:

https://myserver.esri.com/server/rest/services/Landbase/TraceNetworkServer/traceConfigurations/alter

Use dark colors for code blocksCopy
f=json
globalId={51D30E0E-C37C-4D29-A572-659A5BCC0E2A}
name=ConnectedTrace_update
description=Connected trace example(updated 112020)
traceType=connected
traceConfiguration= {}
resultTypes=[]
tags=["newTag1", "newTag2"]

JSON response:

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