- URL:https://<networkdiagramserver-url>/findDiagramNames
- Version Introduced: 10.6
Description
The findDiagramNames operation is performed on a Network Diagram Service resource. The result of this operation is an array of strings, each one corresponding to a network diagram's name.
This operation is used to retrieve the set of diagrams that cover a given extent, verify a particular WHERE clause, or contain specific utility network features or diagram features.
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 |
| extent | Description: A JSON envelope object representing the extent that you want the network extent of the resulting diagrams to intersect. Syntax: extent = { "xmin": <xmin>, "ymin": <ymin>, "xmax": <xmax>, "ymax": <ymax>, "zmin": <zmin>, "zmax": <zmax>, "mmin": <mmin>, "mmax": <mmax>, "spatialReference": <spatialReference>} } Example: Retrieve published network diagrams in which networkExtent intersects a given envelope: extent = { "xmin": 1030002.4739352614, "ymin": 1862854.181471862, "xmax": 1030398.5958464295, "ymax": 1863341.463633, "spatialReference": {"wkid": 102671} } |
| where | Description: A WHERE clause for the query filter. Any legal SQL WHERE clause operating on some fields in the DIAGRAMS table is allowed. See the network diagram fields section below for the exact list of field names that can be used in this WHERE clause. Syntax: creator='<updatedBy>' Example: creator = 'user4732' |
| features | Description: A set of utility network feature Global IDs, or network diagram feature Global IDs represented in a given diagram that are included in the resulting queried diagrams. This parameter is a JSON object composed of two items:
Syntax: features= { "globalIDs":["<globalID1>", ...,"<globalIDN>"], "diagram" : "<diagramName>" } Example: Case 1—Retrieve published network diagrams including the utility network junction with globalID = {48509846-410E-4042-A158-EFD1813567A7}: features={"globalIDs":["{48509846-410E-4042-A158-EFD1813567A7}"]} Case 2—Retrieve published network diagrams including utility network features associated with the diagram feature contained in diagram "Basic_RMT003" with diagram feature globalID = {2072E89B-BAE8-4495-A765-FC7EDF7E373F}: features={"globalIDs":["{2072E89B-BAE8-4495-A765-FC7EDF7E373F}"], "diagram"="Basic_RMT003"} |
| excludeSystemDiagrams | Description: Boolean.
Syntax: excludeSystemDiagrams = <true | false> Example: excludeSystemDiagrams = true |
| f | Description: The response format. The default response format is html. Values: <html | json> |
Network diagram fields for the WHERE clause
| Field name to use in the WHERE clause | Data type | Related item in the JSON diagram info object |
|---|---|---|
NAME | String | name |
USERTAG | String | tag |
CREATIONDATE | Date | creationDate |
CREATOR | String | creator |
LASTUPDATE | Date | lastUpdateDate |
UPDATEDBY | String | lastUpdateBy |
Example usage
Retrieve all diagrams in version ABV1 referencing utility network features for which globalIDs are {F8199534-8B77-4D26-8C3C-8A55DB66728E}, {5AD29D27-0BBE-4DD9-AFD4-3AFE22CE93F9}, or {95FB5F92-90A1-4EF7-AAC0-353599D3789B}:
- URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/findDiagramNames
- Parameters:
gdbVersion=ABV1 sessionId= moment= extent= where= features={"globalIDs":["{F8199534-8B77-4D26-8C3C-8A55DB66728E}","{5AD29D27-0BBE-4DD9-AFD4-3AFE22CE93F9}","{95FB5F92-90A1-4EF7-AAC0-353599D3789B}"]} f=pjson - Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/findDiagramNames?gdbVersion=ABV1&sessionId=&moment=&extent=&where=&features=%7B%22globalIDs%22%3A%5B%22%7BF8199534-8B77-4D26-8C3C-8A55DB66728E%7D%22%2C%22%7B5AD29D27-0BBE-4DD9-AFD4-3AFE22CE93F9%7D%22%2C%22%7B95FB5F92-90A1-4EF7-AAC0-353599D3789B%7D%22%5D%7D&f=pjson
JSON Response syntax
An array of strings, each one corresponding to a diagram name.{
"diagramNames": [
"< diagramName1 >",
"...",
"< diagramNameN >"
]
}
JSON Response example
{
"diagramNames": [
"Basic_Network891G25RT2",
"DiagramTest3"
]
}