Find Network Features from OIDs

URL:: https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/findNetworkFeaturesFromOIDs
Methods:: POST
Version Introduced:: 11.5

Description

The findNetworkFeaturesFromOIDs searches for the network elements associated with a set of diagram features represented in a diagram. It works from the diagram feature object IDs while the findNetworkFeatures operation works from the diagram feature global IDs. 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`
`junctionObjectIDs` (Required)	An array of diagram junction object IDs (long). Syntax: Use dark colors for code blocksCopy `1 junctionObjectIDs=[<DgJctObjectID1>, ...,<DgJctObjectIDN>]` Example: Use dark colors for code blocksCopy `1 junctionObjectIDs=[430,431]`
`edgeObjectIDs` (Required)	An array of diagram edge object IDs (long). Syntax: Use dark colors for code blocksCopy `1 edgeObjectIDs=[<DgEdgeObjectID1>, ...,<DgEdgeObjectIDN>]` Example: Use dark colors for code blocksCopy `1 edgeObjectIDs=[]`
`containerObjectIDs` (Required)	An array of diagram container object IDs (long). Syntax: Use dark colors for code blocksCopy `1 containerObjectIDs=[<DgContObjectID1>, ...,<DgContObjectIDN>]` Example: Use dark colors for code blocksCopy `1 containerObjectIDs=[]`
`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 junctionObjectIDs, edgeObjectIDs, and containerObjectIDs parameters, 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 junctionObjectIDs, edgeObjectIDs, and containerObjectIDs parameters 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

junctionObjectIDs

(Required)

An array of diagram junction object IDs (long).

Syntax:

Use dark colors for code blocksCopy
junctionObjectIDs=[<DgJctObjectID1>, ...,<DgJctObjectIDN>]

Example:

Use dark colors for code blocksCopy
junctionObjectIDs=[430,431]

edgeObjectIDs

(Required)

An array of diagram edge object IDs (long).

Syntax:

Use dark colors for code blocksCopy
edgeObjectIDs=[<DgEdgeObjectID1>, ...,<DgEdgeObjectIDN>]

Example:

Use dark colors for code blocksCopy
edgeObjectIDs=[]

containerObjectIDs

(Required)

An array of diagram container object IDs (long).

Syntax:

Use dark colors for code blocksCopy
containerObjectIDs=[<DgContObjectID1>, ...,<DgContObjectIDN>]

Example:

Use dark colors for code blocksCopy
containerObjectIDs=[]

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 junctionObjectIDs, edgeObjectIDs, and containerObjectIDs parameters, 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 junctionObjectIDs, edgeObjectIDs, and containerObjectIDs parameters 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

The following is a sample request URL for the findNeworkFeaturesFromOIDs operation that demonstrates retrieving the network elements associated with the diagram junctions whose object ID are 430 and 431 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/findNetworkFeaturesFromOIDs

Parameters:

Use dark colors for code blocksCopy
gdbVersion=
sessionId=
moment=
junctionObjectIDs=[430,431]
edgeObjectIDs=[]
containerObjectIDs=[]
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/FindNetworkFeaturesFromOIDs?gdbVersion=&sessionId=&moment=&junctionObjectIDs=%5B430%2C431%5D&edgeObjectIDs=%5B%5D&containerObjectIDs=%5B%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": [
  {
   "featureOID": 8390,
   "globalID": "{7DD27ABD-F3DB-4FC4-BBC4-B75C9547E393}",
   "networkSourceID": 9,
   "geometryType": 1
  },
  {
   "featureOID": 13396,
   "globalID": "{3D5DD9F9-61B9-4375-86D5-32111D65F402}",
   "networkSourceID": 9,
   "geometryType": 1
  }
 ]
}