Manage Flag

URL:: https://<root>/<serviceName>/NetworkDiagramServer/diagrams/<diagramName>/manageFlag
Methods:: POST
Version Introduced:: 10.6

Description

The manageFlag operation allows to add or remove root junction, end junction, pivot junction and barrier flags on a particular diagram feature. It is performed on a Diagram resource. This operation returns the moment the manageFlag operation happens when it applies on a stored diagram.

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`
`action` (Required)	The flag operation to perform: `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)	The type of flag you want to manage in the diagram; that is, `esriDiagramRootJunction`—For a root flag on a diagram junction, `esriDiagramEndJunction`—For an end flag on a diagram junction, `esriDiagramPivotJunction`—For a pivot flag on a diagram junction, `esriDiagramBarrierEdge`—For a barrier flag on a diagram edge, `esriDiagramBarrierJunction`—For a barrier flag on a diagram junction. Syntax: `flagType= <esriDiagramRootJunction \| esriDiagramEndJunction \| esriDiagramPivotJunction \| esriDiagramBarrierEdge \| esriDiagramBarrierJunction>` Example: `flagType=esriDiagramRootJunction`
`flagID` (Required)	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`	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

action

(Required)

The flag operation to perform:

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)

The type of flag you want to manage in the diagram; that is,

esriDiagramRootJunction—For a root flag on a diagram junction,
esriDiagramEndJunction—For an end flag on a diagram junction,
esriDiagramPivotJunction—For a pivot flag on a diagram junction,
esriDiagramBarrierEdge—For a barrier flag on a diagram edge,
esriDiagramBarrierJunction—For a barrier flag on a diagram junction.

Syntax: flagType= <esriDiagramRootJunction | esriDiagramEndJunction | esriDiagramPivotJunction | esriDiagramBarrierEdge | esriDiagramBarrierJunction>

Example: flagType=esriDiagramRootJunction

flagID

(Required)

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

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:

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
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

Use dark colors for code blocksCopy
{
 "moment": 1504862838167
}