sinks

URI

<fa3DNetworkDataName_uri>/sinks[.<format>]

Supported methods

GET, HEAD

Parent resource

fa3DNetworkDataName

Introduction

sinks is the sink resource. Through the sinks resource, you can search sink according to the given arc or node ID.

Supported Methods:

GET: Gets the arc, node and cost of minimum cost path from the given arc or node.
HEAD: Check whether the sinks resource exists, or have the right to access the sinks resource.

Supported output formats: RJSON, JSON, XML, HTML, JSONP

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.

http://supermapiserver:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/{networkDataName}/sinks.rjson

GET request

Gets the arc, node and cost of minimum cost path from the given arc or node.

Request parameter

Implement a GET request on the sinks resource. Some parameters should be contained in the URL, as follows:

Name	Type	Description
edgeID	int	[Required] The specified arc ID in 3D facility network analysis. In the URI, there are only edgeID parameter or nodeID parameter. They cannot exist at the same time.
nodeID	int	[Required] The specified arc ID in 3D facility network analysis. In the URI, there are only edgeID parameter or nodeID parameter. They cannot exist at the same time.
isUncertainDirectionValid	boolean	Whether the uncertain flow works in 3D facility network analysis. When it is true, it is valid; otherwise, false. Default is false, and the flow field is 2, representing the flow is the uncertain flow.
weightName	String	[Required] The specified weight field name in 3D facility network analysis.

Response structure

Implement the GET request on the sinks resource. In the response message body, there are the arc, node and cost of minimum cost path from the given arc or node. Detailed representation structure is as follows:

Field	Type	Description
cost	double	The cost in 3D facility network analysis results.
edges	int[]	The arc ID array in 3D facility network analysis results.
nodes	int[]	The node ID array in 3D facility network analysis results.

Response example

The rjson format representation of implementing the GET request (http://localhost:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/Network@Pipe3D/sinks.rjson?edgeID=2&isUncertainDirectionValid=true&weightName=SMLENGTH) on the sinks resource will be as follows:

{ "cost": 487.20820125617655, "edges": [ 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 21, 22, 23, 27, 28, 29, 33, 35, 38, 39, 40, 44, 47, 48, 52, 281, 282, 283, 284, 285, 286, 287, 288, 289 ], "nodes": [ 76, 71, 72, 73, 69, 70, 67, 68, 65, 66, 63, 64, 59, 60, 96, 97, 121, 122, 126, 142, 143, 152, 154, 157, 163, 164, 250, 314, 315, 377, 427, 428, 423, 424, 425, 426, 450, 451 ] }

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information written in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check if the sinks resource exists, or if the sinks resource can be accessed by clients. It can also determine if the sinks resource supports an output format <format> if performed on a URI with .<format> included.