upstreamCirticalFaclilities

URI

<fa3DNetworkDataName_uri>/upstreamcirticalfaclilities[.<format>]

Supported methods

Parent resource

Introduction

upstreamCirticalFaclilities is the upstream critical facility search resource in 3D facility network analysis. You can search the critical facility in upstream.

Upstream critical facilities search. Namely, search the upstream critical facility node of the given arc or node. Return critical facility node ID array and the downstream arc ID array.

Supported Methods:

GET: Gets critical facility node ID array and downstream arc ID array.
HEAD: Check whether the upstreamCirticalFaclilities resource exists. or to access the upstreamCirticalFaclilities 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}/upstreamcirticalfaclilities.rjson

GET request

Gets critical facility node ID array and downstream arc ID array.

Request parameter

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

Name	Type	Description
sourceNodeIDs	int[]	[Required] The specified facility node ID array in 3D facility network analysis. It can not be null, such as [84,85].
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.

Response structure

Implement the GET request on the upstreamCirticalFaclilities resource. In the response message body, there are the critical facility node ID array and the downstream arc ID array. 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/upstreamcirticalfaclilities.rjson?sourceNodeIDs=%5B459,460,461%5D&nodeID=461&isUncertainDirectionValid=true) on the upstreamCirticalFaclilities resource will be as follows:

{

"cost": 0,

"edges": [

256,

257,

258,

259

"nodes": [460]

}

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 upstreamCirticalFaclilities resource exists, or if the upstreamCirticalFaclilities resource can be accessed by clients. It can also determine if the upstreamCirticalFaclilities resource supports an output format <format> if performed on a URI with .<format> included.