Identify (Network Diagrams)

Description

The Identify operation is performed on a Diagram Map resource. The result of this operation is an identify results resource.

License:
The ArcGIS Utility Network Management extension is required to use this operation.

Request Parameters

ParameterDetails
gdbVersion

Description: The name of the geodatabase version.

Syntax: gdbVersion=<version>

Example: gdbVersion=ABV1

moment

Description: The session moment.

Syntax: moment=<moment>

Example: moment=1490867969324

geometry

Required

Description: The geometry to identify on. The type of the geometry is specified by the geometryType parameter. The structure of the geometries is same as the structure of the JSON geometry objects returned by the ArcGIS REST API. In addition to the JSON structures, for points and envelopes, you can specify the geometries with a simpler comma-separated syntax.

Syntax:

  • JSON structures: geometry=<geometryType>&geometry={ geometry}
  • Point simple syntax: geometry=esriGeometryPoint&geometry=<x>,<y>
  • Envelope simple syntax: geometry=esriGeometryEnvelope&geometry=<xmin>,<ymin>,<xmax>,<ymax>

Example:

  • JSON structures: geometry=esriGeometryPoint&geometry={x: -104, y: 35.6}
  • Point simple syntax:geometry=esriGeometryPoint&geometry=-104,35.6
  • Envelope simple syntax: geometry=esriGeometryEnvelope&geometry=-104,35.6,-94.32,41

geometryType

Description: The type of geometry specified by the geometry parameter. The geometry type could be a point, line, polygon, or an envelope. The default geometry type is a point (esriGeometryPoint)

Syntax: geometryType=esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope

Example: geometryType=esriGeometryPoint

sr

Description: The well-known ID of the spatial reference of the input and output geometries as well as the mapExtent . If sr is not specified, the geometry and the mapExtent are assumed to be in the spatial reference of the map, and the output geometries are also in the spatial reference of the map.

tolerance

Required

Description: The distance in screen pixels from the specified geometry within which the identify should be performed. The value for the tolerance is an integer.

Syntax: tolerance=<int>

Example: tolerance=2

imageDisplay

Required

Description: The screen image display parameters (width, height, and DPI) of the map being currently viewed.

The mapExtent and the imageDisplay parameters are used by the server to determine the layers visible in the current extent. They are also used to calculate the distance on the map to search based on the tolerance in screen pixels.

Syntax: imageDisplay=<width>,<heigth>,<dpi>

Example: imageDisplay=496,496,96

returnGeometry

Description: If true , the result set will include the geometries associated with each result. The default is true.

Syntax: returnGeometry=<true | false>

Example: returnGeometry=true

maxAllowableOffset

Description: This option can be used to specify the maximum allowable offset to be used for generalizing geometries returned by the identify operation. The maxAllowableOffset is in the units of the sr. If sr is not specified, maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

Syntax: maxAllowableOffset=<int>

Example: maxAllowableOffset=2

returnZ

Description: If true, Z values will be included in the results if the features have Z values. Otherwise, Z values are not returned. The default is false.

Syntax: returnZ=<true | false>

Example: returnZ=true

Note:

This parameter only applies if returnGeometry=true.

returnM

Description: If true, M values will be included in the results if the features have M values. Otherwise, M values are not returned. The default is false.

Syntax: returnM=<true | false>

Example: returnM=true

Note:

This parameter only applies if returnGeometry=true.

returnUnfomattedValues

Description: If true, the values in the result will not be formatted i.e. numbers will returned as is and dates will be returned as epoch values..

Syntax: returnUnfomattedValues=<true | false>

Example: returnUnfomattedValues=true

Note:

The default value is false i.e. numbers and dates are formatted based on server's setting. Subtype and domain values will be returned as numeric values instead of descriptions.

returnFieldName

Description: If true, field names will be returned instead of field aliases.

Syntax: returnUnfomattedValues=<true | false>

Example: returnUnfomattedValues=true

Note:

The default value is false. In case with layers joins, fully qualified field names will be returned.

geometryPrecision

Description: This option can be used to specify the number of decimal places in the response geometries returned by the operation. This applies to X and Y values (not m or z-values)

Syntax: geometryPrecision=<geometryPrecision>

Example: geometryPrecision=3

mapExtent

Required

Description: The extent or bounding box of the map currently being viewed. Unless the sr parameter has been specified, the mapExtent is assumed to be in the spatial reference of the map.

The mapExtent and the imageDisplay parameters are used by the server to determine the layers visible in the current extent. They are also used to calculate the distance on the map to search based on the tolerance in screen pixels.

Syntax: mapExtent=<xmin>,<ymin>,<xmax>,<ymax>

Example: mapExtent=1034222.0452205129,1871589.0737789497,1034702.7306108437,1871863.8619432822

f

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

Values: <html | json>

Example Usage

Identifying diagram features in a specific envelope (<xmin>,<ymin>,<xmax>,<ymax>)=(1034510, 1871808, 1034512, 1871809) in the network diagram DiagramTest1 which is in version ABV1: http://batz.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/map/identify?gdbVersion=ABV1&moment=&geometry=1034510%2C1871808%2C1034512%2C1871809&geometryType=esriGeometryEnvelope&sr=&tolerance=2&imageDisplay=496%2C496%2C96&returnGeometry=&maxAllowableOffset=&returnZ=&returnM=&returnUnformattedValues=&returnFieldName=&geometryPrecision=&mapExtent=1034222.0452205092%2C1871589.0737789422%2C1034702.7306108437%2C1871863.8619432747&f=pjson

JSON Response Syntax

{
 "results": [
  {
   "layerId": <layerId1>,
   "layerName": "<layerName1>",
   "displayFieldName": "<displayFieldName1>",
   "value": "<value1>",
   "attributes": {
    "<FieldName11>": "<FieldValue11>",
    ...,
    "<FieldName1N>": "<FieldValue1N>"
   },
   "geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon>",
   "geometry": {<geometry1>}
   },
   ...
  {
   "layerId": <layerIdN>,
   "layerName": "<layerNameN>",
   "displayFieldName": "<displayFieldNameN>",
   "value": "<valueN>",
   "attributes": {
    "<FieldNameN1>": "<FieldValueN1>",
    ...,
    "<FieldNameNN>": "<FieldValueNN>"
   },
   "geometryType": "<esriGeometryPoint | esriGeometryPolyline | esriGeometryPolygon>",
   "geometry": {<geometryN>}
   }

  }
 ]
}

JSON Response Example

{
 "results": [
  {
   "layerId": 103,
   "layerName": "Electric Distribution Junction",
   "displayFieldName": "Asset group",
   "value": "Connection Point",
   "attributes": {
    "Element object ID": "40328",
    "Element global ID": "{51AF7B03-6B08-452F-BF83-B213C2CC2CBE}",
    "Element ID": "9",
    "Element rotation": "0",
    "Shape": "Point",
    "Object ID": "3142",
    "Asset group": "Connection Point",
    "Asset type": "Low Voltage Attachment",
    "Association status": "None",
    "Is connected": "True",
    "Creation date": "8/29/2017 2:48:26 PM",
    "Creator": "MAP",
    "Last update": "8/29/2017 2:48:26 PM",
    "Updated by": "MAP",
    "Global ID": "{C0718A4C-608F-4025-BAFF-445CB0EBA9DA}",
    "Label Text": " ",
    "Notes": "Null",
    "Phases Built": "ABCN",
    "Phases Normal": "ABCN",
    "Phases Current": "ABC",
    "Phases Energized": "ABC",
    "Symbol Rotation": "0",
    "Subnetwork name": "RMT003"
   },
   "geometryType": "esriGeometryPoint",
   "geometry": {
    "x": 1034511.3176078424,
    "y": 1871808.4880382717,
    "spatialReference": {
     "wkid": 102671,
     "latestWkid": 3435
    }
   }
  }
 ]
}