Utility Network service

URL:: https://<root>/<serviceName>/UtilityNetworkServer
Methods:: GETPOST
Operations:: Disable Subnetwork Controller, Disable Topology, Enable Subnetwork Controller, Enable Topology, Export Subnetwork, Query Network Moments, Synthesize Association Geometries, Trace, Update Is Connected, Update Subnetwork, Validate Network Topology
Child Resources:: Associations, Locations, Trace Configurations
Required Capability:: Most operations require that organization members be assigned a license for the ArcGIS Advanced Editing user type extension
Version Introduced:: 10.6

Description

The Utility Network service exposes analytic capabilities such as tracing, and enables you to perform validation of the network topology and manage subnetworks (managing sources or sinks, updating subnetworks, exporting subnetworks, and so on). The Utility Network service is conceptually similar to the Network Analysis service for transportation networks.

The capabilities property was introduced in ArcGIS Enterprise 10.8.1 to return the capabilities that the service supports. These capabilities are not configurable and are dependent on the version of the utility network being used. The exception is the supportsTraceSystemNetworkAttributes capability introduced with ArcGIS Enterprise 11.0 which applies to all versions of the utility network.

Resources and operations available in the Utility Network service

Example usage

Request URL:

https://myserver.esri.com/server/rest/services/LandUse/UtilityNetworkServer

JSON Response syntax

Utility network is Utility Network version 7.

Use dark colors for code blocksCopy
{
 "name": "Utility Network Server",
 "type": "Map Server Extension",
 "capabilities": {
  "supportsAggregatedGeometryAsTraceResult": true,
  "supportsExportSubnetworkAssociations": true,
  "supportsFilterBarriers": true,
  "supportsIncludeUpToFirstSpatialContainer": true,
  "supportsQueryAssociations": true,
  "supportsJunctionEdgeAssociations": true,
  "supportsMidspanAssociations": true,
  "supportsTraverseAssociations": true,
  "supportsTraceAllowIndeterminateFlow": true,
  "supportsTraceConfigurations": true,
  "supportsTraceValidateLocatability": true,
  "supportsValidationTypes": true,
  "supportsValidationSets": true,
  "supportsValidationTypeRebuild": true,
  "supportsValidationTypeForceRebuild": true,
  "supportsDiagnostics": true,
  "supportsLocations": true,
  "supportsAssociations": true,
  "supportsTraceConnectivityResults": true,
  "supportsAsyncExportSubnetwork" : true,
  "supportsAsyncUpdateIsConnected" : true,
  "supportsAsyncTrace" : true,
  "supportsAsyncEnableTopology" : true,
  "supportsAsyncDisableTopology" : true,
  "supportsAsyncLocationsQuery" : true,
  "supportsExportSubnetworkIncludeDomainDescriptions" : true,
  "supportsTraceSystemNetworkAttributes" : true,
  "supportsValidationDiscoveredSubnetworks" : true,
  "supportsTraceFeatureElementsResults": true,
  "supportsTraceAssociationResults": true,
  "supportsPBFResponse": true,
  "supportsOutSR": true,
  "supportsFlowDirections": true,
  "supportsTraceSynthesizeGeometries": true
 }
}

Utility network is Utility Network version 5 or 6.

Use dark colors for code blocksCopy
{
 "name": "Utility Network Server",
 "type": "Map Server Extension",
 "capabilities": {
  "supportsAggregatedGeometryAsTraceResult": true,
  "supportsAssociations": true,
  "supportsDiagnostics": true,
  "supportsExportSubnetworkAssociations": true,
  "supportsFilterBarriers": true,
  "supportsIncludeUpToFirstSpatialContainer": true,
  "supportsQueryAssociations": true,
  "supportsJunctionEdgeAssociations": true,
  "supportsMidspanAssociations": true,
  "supportsTraverseAssociations": true,
  "supportsLocations": true,
  "supportsTraceAllowIndeterminateFlow": true,
  "supportsTraceConfigurations": true,
  "supportsTraceConnectivityResults": true,
  "supportsTraceFeatureElementsResults": true,
  "supportsTraceValidateLocatability": true,
  "supportsValidationTypes": true,
  "supportsValidationSets": true,
  "supportsValidationTypeRebuild": true,
  "supportsValidationTypeForceRebuild": true,
  "supportsAsyncExportSubnetwork" : true,
  "supportsAsyncUpdateIsConnected" : true,
  "supportsAsyncTrace" : true,
  "supportsAsyncEnableTopology" : true,
  "supportsAsyncDisableTopology" : true,
  "supportsAsyncLocationsQuery" : true,
  "supportsExportSubnetworkIncludeDomainDescriptions" : true,
  "supportsTraceSystemNetworkAttributes" : true,
  "supportsValidationDiscoveredSubnetworks" : true,
  "supportsTraceFeatureElementsResults": true,
  "supportsTraceAssociationResults": true,
  "supportsPBFResponse": true,
  "supportsOutSR": true,
  "supportsTraceSynthesizeGeometries": true
 }
}

Utility network is Utility Network version 4.

Use dark colors for code blocksCopy
{
 "name": "Utility Network Server",
 "type": "Map Server Extension",
 "capabilities": {
  "supportsAggregatedGeometryAsTraceResult": true,
  "supportsAssociations": true,
  "supportsDiagnostics": true,
  "supportsExportSubnetworkAssociations": true,
  "supportsExportSubnetworkIncludeDomainDescriptions" : true,
  "supportsFilterBarriers": true,
  "supportsIncludeUpToFirstSpatialContainer": true,
  "supportsQueryAssociations": true,
  "supportsJunctionEdgeAssociations": true,
  "supportsMidspanAssociations": true,
  "supportsTraverseAssociations": true,
  "supportsTraceConnectivityResults": true,
  "supportsLocations": true,
  "supportsValidationTypes": true,
  "supportsValidationSets": true,
  "supportsValidationTypeRebuild": true,
  "supportsValidationTypeForceRebuild": true,
  "supportsAsyncExportSubnetwork" : true,
  "supportsAsyncUpdateIsConnected" : true,
  "supportsAsyncTrace" : true,
  "supportsAsyncEnableTopology" : true,
  "supportsAsyncDisableTopology" : true,
  "supportsAsyncLocationsQuery" : true,
  "supportsTraceSystemNetworkAttributes" : true,
  "supportsValidationDiscoveredSubnetworks" : true,
  "supportsTraceFeatureElementsResults": true,
  "supportsTraceAssociationResults": true,
  "supportsPBFResponse": true,
  "supportsOutSR": true,
  "supportsTraceSynthesizeGeometries": true
 }
}

Utility network is Utility Network version 3.

Use dark colors for code blocksCopy
{
 "name": "Utility Network Server",
 "type": "Map Server Extension",
"capabilities": {
  "supportsAggregatedGeometryAsTraceResult": true,
  "supportsAssociations": true,
  "supportsDiagnostics": true,
  "supportsExportSubnetworkAssociations": true,
  "supportsExportSubnetworkIncludeDomainDescriptions" : true,
  "supportsFilterBarriers": true,
  "supportsIncludeUpToFirstSpatialContainer": true,
  "supportsQueryAssociations": true,
  "supportsTraceConnectivityResults": true,
  "supportsValidationTypes": true,
  "supportsValidationSets": true,
  "supportsValidationTypeRebuild": true,
  "supportsValidationTypeForceRebuild": true,
  "supportsAsyncExportSubnetwork" : true,
  "supportsAsyncUpdateIsConnected" : true,
  "supportsAsyncTrace" : true,
  "supportsAsyncEnableTopology" : true,
  "supportsAsyncDisableTopology" : true,
  "supportsTraceSystemNetworkAttributes" : true,
  "supportsValidationDiscoveredSubnetworks" : true,
  "supportsTraceFeatureElementsResults": true,
  "supportsTraceAssociationResults": true,
  "supportsPBFResponse": true,
  "supportsOutSR": true,
  "supportsTraceSynthesizeGeometries": true
 }
}