Query Overrides

  • URL:http://<utilitynetworkservice-url>/queryOverrides
  • Version Introduced:10.6

Description

Network attributes support the ability to have their values overridden without having to edit features and validate the network topology (build the index). The utility network also supports the ability to place ephemeral connectivity (e.g., jumpers in an electrical network) between two devices or junctions without having to edit features or connectivity associations and validate the network topology (build the index). This operation allows the client to query all the overrides associated with the network attributes (by network attribute id). In addition, all connectivity overrides are returned.

License:
The ArcGIS Utility Network Management extension is required to use these resources.

Request Parameters

ParameterDetails
f

Description: Optional parameter representing the output format of the response (default is JSON).

attributeIDs

Description: Optional parameter specifying an array of network attribute IDs to return the override values for.

Syntax: [ <long> ]

allAttributes

Description: Boolean parameter that is set to true when all the attribute overrides are to be returned.

allConnectivity

Description: Boolean parameter that is set to true when all the connectivity overrides are to be returned.

JSON Response Syntax

JSON response:

{
  "attributeOverrides" : [
    {
      "attributeID" : <long>,
      "attributes" : [
        {
          "globalID" : <guid>,
          "longValue" : <long>,
          "doubleValue" : <double>
        }
      ]
    }
  ],
  "connectivityOverrides" : [
    {
      "fromGlobalID" : <guid>,
      "fromTerminalID" : <long>,
      "toGlobalID" : <guid>,
      "toTerminalID" : <long>
    }
  ],
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "hresult" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}