traceUpResult


URI

<fa3DNetworkDataName_uri>/traceupresult[.<format>]

Supported methods

GET, HEAD

Parent resource

fa3DNetworkDataName

Introduction

traceUpResult is the upstream tracking resource in 3D facility network analysis. Search the upstream of specified arc or node. Return the arc, node and total cost in upstream.

Supported Methods:

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}/traceupresult.rjson

GET request

Gets the arc, node and total cost in upstream.

Request parameter

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

Name Type Description
edgeID String [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 String [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

The structure of the response resource representation after implementing the GET request on the traceUpResult resource will be 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/traceupresult.rjson?edgeID=2&isUncertainDirectionValid=true&weightName=SMLENGTH) on the traceUpResult resource will be as follows:

{

    "cost": 37.33550375233476,

    "edges": [

        1,

        415

    ],

    "nodes": [

        77,

        78

    ]

}

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

See