Find Network Features

URL:: https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/findNetworkFeatures
Methods:: POST
Version Introduced:: 10.6

Description

The findNetworkFeatures operation searches for the network elements associated with a set of diagram features represented in a diagram. It is performed on a Diagram resource. It returns an array of network element global IDs.

Request parameters

Parameter Details

Parameter	Details
`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`
`fromFeatures` (Required)	An array of diagram network feature global IDs. Syntax: Use dark colors for code blocksCopy `1 fromFeatures=["<DgFeatglobalID1>", ...,"<DgFeatglobalIDN>"]` Example: Use dark colors for code blocksCopy `1 fromFeatures=["{34740A9C-F8B4-4812-B08F-187139EA9547}"]`
`includeAggregations` (Required)	A boolean statement that determines whether to include aggregated network elements. `true`—The operation returns all the network elements associated with the diagram features specified in the fromFeatures parameter, whether those elements are reduced or collapsed in the diagram resource. `false`—The operation only returns the network elements associated with diagram features specified in the fromFeatures parameter that are not reduced or collapsed in the diagram resource; that is, it only returns the network elements associated with the specified diagram features that are visibly represented in the diagrams. Syntax: Use dark colors for code blocksCopy `1 includeAggregations=<true \| false>` Example: Use dark colors for code blocksCopy `1 includeAggregations=true`
`findContainerIfNonSpatial`	A boolean statement that determines whether to include spatial containers related to the retrieved network objects . `true`—The operation also returns the hierachy of spatial containers related to any returned network objects. `false`—The operation does not return the hierachy of spatial containers related to the returned network objects. Syntax: Use dark colors for code blocksCopy `1 findContainerIfNonSpatial=<true \| false>` Example: Use dark colors for code blocksCopy `1 findContainerIfNonSpatial=false`
`f`	The response format. The default response format is html. Values: `<html \| json>`

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

fromFeatures

(Required)

An array of diagram network feature global IDs.

Syntax:

Use dark colors for code blocksCopy
fromFeatures=["<DgFeatglobalID1>", ...,"<DgFeatglobalIDN>"]

Example:

Use dark colors for code blocksCopy
fromFeatures=["{34740A9C-F8B4-4812-B08F-187139EA9547}"]

includeAggregations

(Required)

A boolean statement that determines whether to include aggregated network elements.

true—The operation returns all the network elements associated with the diagram features specified in the fromFeatures parameter, whether those elements are reduced or collapsed in the diagram resource.
false—The operation only returns the network elements associated with diagram features specified in the fromFeatures parameter that are not reduced or collapsed in the diagram resource; that is, it only returns the network elements associated with the specified diagram features that are visibly represented in the diagrams.

Syntax:

Use dark colors for code blocksCopy
includeAggregations=<true | false>

Example:

Use dark colors for code blocksCopy
includeAggregations=true

findContainerIfNonSpatial

A boolean statement that determines whether to include spatial containers related to the retrieved network objects .

true—The operation also returns the hierachy of spatial containers related to any returned network objects.
false—The operation does not return the hierachy of spatial containers related to the returned network objects.

Syntax:

Use dark colors for code blocksCopy
findContainerIfNonSpatial=<true | false>

Example:

Use dark colors for code blocksCopy
findContainerIfNonSpatial=false

f

The response format. The default response format is html.

Values: <html | json>

Example usage

Retrieve the utility network features associated with the diagram feature whose global ID is "{1EE98487-730C-4193-8510-8BF975332237}" in the "DiagramTest1" diagram resource; that is:

URL:

Use dark colors for code blocksCopy
https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/findNetworkFeatures

Parameters:

Use dark colors for code blocksCopy
gdbVersion=
sessionId=
moment=
fromFeatures=["{1EE98487-730C-4193-8510-8BF975332237}"]
includeAggregations=true
findContainerIfNonSpatial=true
f=pjson

Sent URL (GET):

Use dark colors for code blocksCopy
https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/findNetworkFeatures?gdbVersion=&sessionId=&moment=&fromFeatures=%5B%22%7B1EE98487-730C-4193-8510-8BF975332237%7D%22%5D&includeAggregations=true&findContainerIfNonSpatial=true&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
 "features": [
  {
   "globalID": "< globalID1 >", // GUID of the associated network feature
   "featureOID": < featureOID1 >, // ObjectID of the associated network feature (int)
   "networkSourceID": < networkSourceID1 >, // ID of the associated network feature source class (int)
   "geometryType": < 0 | 1 | 2 | 3 | 4 > // geometry type of the associated network feature 0: edge, 1: point, 2:?, 3:?, 4:polygon
  },
  ...
  {
   "globalID": "< globalIDN >",
   "featureOID": < featureOIDN >,
   "networkSourceID": < networkSourceIDN >,
   "geometryType": < 0 | 1 | 2 | 3 | 4 >
  }
 ]
}

JSON Response example

Example response:

Use dark colors for code blocksCopy
{
 "features": [
  {
   "globalID": "{AF41424F-1073-4640-A596-220AC3A33DA6}",
   "featureOID": 3094,
   "networkSourceID": 6,
   "geometryType": 1
  }
 ]
}