- URL:
- https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/getFlags
- Methods:
POST
- Version Introduced:
- 10.6
Description
The get
operation gets the root junction, end junction, pivot junction, and barrier flag on a particular diagram feature. It is performed on a Diagram resource. The result of this operation is a JSON Information object that returns the list of diagram element IDs bringing a flag, with its flag type and its location.
Request parameters
Parameter | Details |
---|---|
|
The name of the geodatabase version. Syntax: Example: |
|
The token (guid) used to lock the version. Syntax: Example: |
|
The session moment. Syntax: Example: |
(Required) | The type of flag you want to search for in the diagram. Syntax: Example: |
| The spatial reference of the returned geometry. The spatial reference can be specified as either a well-known ID or as a spatial reference JSON object. If |
|
The response format. The default response format is html. Values: |
Example usage
Retrieve all the root flags currently set up on the DiagramTest1 diagram in version ABV1; that is:
-
URL:
https:
//myserver.esri.com/server/rest/services/Naperville/Network Diagram Server/diagrams/Diagram Test1/get Flags -
Parameters:
Use dark colors for code blocks Copy gdbVersion=ABV1 sessionId= moment= flagType=esriDiagramRootJunction outSR= f=pjson
-
Sent URL (GET):
https:
//myserver.esri.com/server/rest/services/Naperville/Network Diagram Server/diagrams/Diagram Test1/get Flags?gdb Version=ABV1&session Id=&moment=&flag Type=esri Diagram Root Junction&out SR=&f=pjson
JSON Response syntax
An array of JSON objects composed of three items:
flag
—The type of the returned flags; that is,Type <esri
Diagram Root Junction | esri Diagram E n d Junction> flag
—The diagram junction element ID the flag is related toI D geometry
—The location of the flag
{
"flags": [
{"flagType": < flagType1 >, "flagID": < edgDEID1 >,"geometry": < geometry1 >},
…,
{"flagType": < flagTypeN >, "flagID": < edgDEIDN >,"geometry": < geometryN >}
]
}
JSON Response example
{
"flags": [
{
"flagType": "esriDiagramRootJunction",
"flagID": 1,
"geometry": {
"x": 1035414.5756438449,
"y": 1864932.12482253462,
"m": null,
"spatialReference": {
"wkid": 102671,
"latestWkid": 3435
}
}
}
]
}