Skip To Content
ArcGIS Developers
Dashboard

Query Consistency State (Network Diagram service)

Description

The queryConsistencyState operation is performed on a Network Diagram Service resource.

It returns the consistency state for each of the diagram names specified in input.

License:
The active portal account must be licensed with the ArcGIS Utility Network user type extension or the ArcGIS Trace Network user type extension to use this operation.

Request parameters

ParameterDetails
gdbVersion

Description: The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

sessionId

Description: The token (guid) used to lock the version.

Syntax: sessionId=<guid>

Example: sessionId=44G259DE-87B0-407D-8F2E-DCB7665DD0F0

moment

Description: The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

diagramNames

Required

Description: An array of strings, each one corresponding to a diagram name, for which you want to get the consistency state.

Syntax: diagramNames=["<diagramName1>",…,"<diagramNameN>"]

Example: diagramNames=["Basic_RMT001","DiagramTest1"]

f

Description: The response format. The default response format is html.

Values: <html | json>

Example usage

Retrieve the consistency state for two diagrams called Basic_RMT001 and DiagramTest1 in version QBV1:

  • URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/queryConsistencyState
  • Parameters
    gdbVersion=ABV1
    sessionId=
    moment=
    diagramNames=["Basic_RMT001","DiagramTest1"]
    f=pjson
  • Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/queryConsistencyState?gdbVersion=ABV1&sessionId=&moment=&diagramNames=%5B%22Basic_RMT001%22%2C%22DiagramTest1%22%5D&f=pjson

JSON Response syntax

A JSON object returning the list of each input diagram name with its consistency state:

{
 "< diagramName1 >": < diagramName1_DiagramConsistencyState >,
 ...,
 "< diagramNameN >": < diagramNameN_DiagramConsistencyState >
}

With <DiagramConsistencyState>=<"esriDiagramIsConsistent" | "esriDiagramNotConsistentWithTopology" | "esriDiagramHasDirtyFeatures">

JSON Response example

{
 "Basic_RMT001": "esriDiagramNotConsistentWithTopology",
 "DiagramTest1": "esriDiagramIsConsistent"
}