Find Network Features (Network Diagram service)—REST APIs

URL:https://<diagram-url>/findNetworkFeatures
Version Introduced: 10.6

Description

The findNetworkFeatures operation is performed on a Diagram resource. It returns an array of network feature global IDs.

This is the operation to use to search for the diagram features referenced in the diagram resource that are associated with a set of utility network features or a set of diagram features represented in another network diagram.

License:

The active portal account must be licensed with the ArcGIS Advanced Editing user type extension to use this operation.

Request parameters


Parameter	Details
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
fromFeatures	Required An array of diagram network feature global IDs. Syntax: fromFeatures=["<DgFeatglobalID1>", ...,"<DgFeatglobalIDN>"] Example: fromFeatures=["{34740A9C-F8B4-4812-B08F-187139EA9547}"]
includeAggregations	Required Boolean True—The operation returns all the network features associated with the diagram features specified in the fromFeatures parameter, whether those features are reduced or collapsed in the diagram resource. False—The operation only returns the network features 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 features associated with the specified diagram features that are visibly represented in the diagrams. Syntax: includeAggregations=<true \| false> Example: includeAggregations=true
f	Description: 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: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/findNetworkFeatures

Parameters:

gdbVersion=
sessionId=
moment=
fromFeatures=["{1EE98487-730C-4193-8510-8BF975332237}"]
includeAggregations=true
f=pjson

Sent URL (GET): 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&f=pjson

JSON Response syntax

{
 "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:

{
 "features": [
  {
   "globalID": "{AF41424F-1073-4640-A596-220AC3A33DA6}",
   "featureOID": 3094,
   "networkSourceID": 6,
   "geometryType": 1
  }
 ]
}

Feedback on this topic?