Get Diagram Element Info

URL:
https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/getDiagramElementInfo
Methods:
POST
Version Introduced:
11.3

Description

The getDiagramElementInfo operation returns the Info field values for the diagram elements you want in the diagram. It is performed on a diagram resource diagram resource. The result of this operation is a JSON object composed of two arrays—one listing the queried diagram element IDs, and the second with the Info field values for each queried diagram element.

Request parameters

ParameterDetails

gdbVersion

The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

sessionId

The token (guid) used to lock the version.

Syntax: sessionId=<guid>

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

moment

The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

diagramElementFilter


(Required)

The way the diagram elements for which you want to query the Info field will be filtered out. The filtering can be processed in two different ways:

  • filterBySelection—To get Info field values for a given set of diagram junctions, diagram edges or diagram containers that you identified thanks to their diagram ObjectIDs.
  • filterByElementType—To get the Info field values for all diagram elements depending on their diagram feature type; that is, query Info field values related to all diagram junctions, all diagram edges or all diagram containers.

Syntax:

  • filterBySelection syntax: diagramElementFilter={type="filterBySelection", "junctionObjectIDs": [<DiagJctOid1>, …, <DiagJctOidN>], "edgeObjectIDs": [<DiagEdgOid1>, …, <DiagEdgOidN], "containersObjectIDs": [<DiagCtnrOid1>, …, <DiagCtnrOidN]}
  • filterByElementType syntax: diagramElementFilter={type="filterByElementType", "browseJunctions":<true|false>, "browseEdges":<true|false>, "browseContainers":<true|false>}

Example:

  • filterBySelection example: {"type": "filterBySelection", "junctionObjectIDs":[8756,8757], "edgeObjectIDs":[], "containerObjectIDs":[]}
  • filterByElementType example:{"type": "filterByElementType", "browseJunctions":true, "browseEdges":true, "browseContainers":true}

f

The response format. The default response format is html.

Values: <html | json>

Example usage

Get Info field values on diagram junctions which ObjectIDs are 7018 and 7019 in the diagram TestDiagram1:

  • URL: https://myserver.esri.com/server/rest/services/NapervilleElectric/Naperville_Electric_SQL_50898/NetworkDiagramServer/diagrams/DiagramTest1/getDiagramElementInfo

  • Parameters:

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    gdbVersion=
    sessionId=
    moment=
    diagramElementFilter={"type": "filterBySelection", "junctionObjectIDs":[7018,7019], "edgeObjectIDs":[], "containerObjectIDs":[]}
  • Sent URL (GET): https://myserver.esri.com/server/rest/services/NapervilleElectric/Naperville_Electric_SQL_50898/NetworkDiagramServer/diagrams/DiagramTest1/getDiagramElementInfo?gdbVersion=&sessionId=&moment=&diagramElementFilter=%7B%22type%22%3A+%22filterBySelection%22%2C+%22junctionObjectIDs%22%3A%5B7018%2C7019%5D%2C+%22edgeObjectIDs%22%3A%5B%5D%2C+%22containerObjectIDs%22%3A%5B%5D%7D&f=pjson

JSON Response syntax

A JSON object composed of two arrays of values:

  • diagramElementIDs —An array of Diagram Element IDs.
  • diagramElementInfo—An array of Info field values for each diagram element.
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
 "diagramElementIDs": [
  <DEID_1>,
  ...,
  <DEID_N>
 ],
 "diagramElementInfo": [
  <Info_1>,
   ...,
  <Info_N>
 ]
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
 "diagramElementIDs": [
  3,
  4
 ],
 "diagramElementInfo": [
  "Info for DEID#3",
  "Info for DEID#4"
 ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.