ArcGIS REST API - ArcGIS Services - Manage Flag (Network Diagram service)

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

Description

The manageFlag operation is performed on a Diagram resource. This operation returns the moment the manageFlag operation happens when it applies on a stored diagram.

It is used to add or remove root junction, end junction, pivot junction and barrier flags on a particular diagram feature.

License:

The active portal account must be licensed with the ArcGIS Utility Network user type extension or the ArcGIS Trace Network 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
action	Required Description: The flag operation to execute: Add—to add a new flag on a particular diagram feature, Remove—to remove a flag from a particular diagram feature. Syntax: action=<add \| remove> Example: action=remove
flagType	Required Description: The type of flag you want to manage; that is, esriDiagramRootJunction to manage a root junction, esriDiagramEndJunction for an end junction flag, esriDiagramPivotJunction for a pivot junction flag, and esriDiagramBarrierEdge or esriDiagramBarrierJunction for a barrier flag. Syntax: flagType= <esriDiagramRootJunction \| esriDiagramEndJunction \| esriDiagramPivotJunction \| esriDiagramBarrierEdge \| esriDiagramBarrierJunction> Example: flagType=esriDiagramRootJunction
flagID	Required Description: The Diagram Element ID of the diagram feature to which you want the flag to be added or from which you want the flag to be removed, depending on the specified action. Syntax: flagID = <DEID> Example: flagID = 20
f	Description: The response format. The default response format is html. Values: <html \| json>

Example Usage

Adding a pivot flag on the junction which Diagram Element ID is 17 on the DiagramTest1 in version ABV1; that is:

URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag

Parameters:

gdbVersion=ABV1
sessionId=
action=add
flagType=esriDiagramPivotJunction
flagID=17
f=pjson

Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag?gdbVersion=ABV1&sessionId=&action=add&flagType=esriDiagramPivotJunction&flagID=17&f=pjson

Adding a barrier flag on the edge which Diagram Element ID is 47 on the DiagramTest1 in version ABV1; that is:

URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag

Parameters:

gdbVersion=ABV1
sessionId=
action=add
flagType=esriDiagramBarrierEdge
flagID=47
f=pjson

Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag?gdbVersion=ABV1&sessionId=&action=add&flagType=esriDiagramBarrierEdge&flagID=47&f=pjson

Removing the pivot flag on the junction which Diagram Element ID is 9 on the DiagramTest1 in version ABV1; that is:

URL: https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag

Parameters:

gdbVersion=ABV1
sessionId=
action=remove
flagType=esriDiagramRootJunction
flagID=9
f=pjson

Sent URL (GET): https://myserver.esri.com/server/rest/services/Naperville/NetworkDiagramServer/diagrams/DiagramTest1/manageFlag?gdbVersion=ABV1&sessionId=&action=remove&flagType=esriDiagramRootJunction&flagID=9&f=pjson

JSON Response Syntax

{"moment": <moment>}

JSON Response Example

{
 "moment": 1504862838167
}