Skip To Content
ArcGIS Developers
Dashboard

Query Network Moments

Description

The queryNetworkMoments operation returns the moments related to the network topology and operations against the topology. This includes when the topology was initially enabled, when it was last validated, when the topology was last disabled (and later enabled), when the definition of the utility network was last modified, and when the updateIsConnected operation was last executed.

Request parameters

ParameterDetails
f

Description: Optional parameter representing the output format of the response. The default response format is html.

Values: html | json.

gdbVersion

Description: Optional parameter specifying the name of the geodatabase version. The default is DEFAULT.

Syntax: gdbVersion=<version>

sessionId

Description: Optional parameter representing the sessionId (guid) used to lock the version. If the calling client has previously started a service session (editing) and holds an exclusive lock on the specified version, the request will fail if the sessionId is not provided. If the specified version is currently locked by any other session, the request will fail if the sessionId is not provided or does not match the sessionId that holds the exclusive lock.

Syntax: sessionId=<guid>

moment

Description: Optional parameter representing the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.

Syntax: moment=<Epoch time in seconds>

Example: moment=1601505461

momentsToReturn

Description: Optional parameter representing the collection of validate moments to return (default is all). This is provided as an array of strings.

Values:

["initialEnableTopology" | "fullValidateTopology" |
"partialValidateTopology" | "enableTopology" | "disableTopology" |
 "definitionModification" | "updateIsConnected" | "indexUpdate" | "all" ]

Example:momentsToReturn=["enableTopology","initialEnableTopology"]

JSON Response syntax

{
  "networkMoments" : [
    {
      "moment" : <momentType>,
      "time" : <datetime>,
      "duration" : <double>      // in milliseconds
    }
  ],  
  "validNetworkTopology" : <true | false>,
  "success" : <true | false>,
  "error" : {                   // only if success is false
    "extendedCode" : <HRESULT>,
    "message" : <error message>,
    "details" : [ <detail> ]
  }
}

Example usage

For the current state of a utility network, return the moment the network topology was initially enabled and the last time it was enabled using the queryNetworkMoments operation.

Request URL and parameters:

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

f=json
momentsToReturn=["enableTopology","initialEnableTopology"]

JSON response:

{
 "networkMoments": [
  {
   "moment": "enableTopology",
   "time": 1559840642,
   "duration": 1663
  },
  {
   "moment": "initialEnableTopology",
   "time": 1559035822,
   "duration": 1259
  }
 ],
 "validNetworkTopology": true,
 "success": true
}