URI
<fa3DNetworkDataName_uri>/tracedownresult[.<format>]
Supported methods
Parent resource
Introduction
TraceDownResult is the downstream tracking resource for 3D facility network analysis. It is to find the downstream of the specified arc or node, and return the arcs, nodes and total cost in the downstream.
Supported Methods:
- GET: gets the arcs, nodes and total cost in the downstream.
- HEAD: Checks whether traceDownResult resource exists, or whether it can be accessed.
Supported output formats:(rjson、json、html、xml、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}/tracedownresult.rjson
GET request
GET: gets the arcs, nodes and total cost in the downstream.
Request parameter
Proper parameters need to be included in the URI when performing a GET request on the traceDownResult resource.
Name | Type | Description |
edgeID | String | [Required parameter] Specified arc ID in the 3D facility network analysis, there will be only the edgeID or nodeID parameter in the request URL, and they cannot exist at the same time. |
nodeID | String | [Required parameter] Specified node ID in the 3D facility network analysis, there will be only the edgeID or nodeID parameter in the request URL, and they cannot exist at the same time. |
isUncertainDirectionValid | boolean |
Whether to continue the searching when the flow is not determined. True means it will continue when it meets the undetermined flow; false means it will stop searching in this direction when it meets the undetermined flow. The field value 2 means undetermined flow. |
weightName | String | [Required parameter] Specified weight field name |
Response structure
The structure of the response resource representation after implementing the GET request on the traceDownResult resource will be as follows:
Field | Type | Description |
cost | double | Cost in the result. |
edges | int[] | Arc ID array in the result. |
nodes | int[] | Node ID array in the result. |
Response example
The returned rjson format resource representation after implementing the GET request on the traceDownResult resource http://localhost:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/Network@Pipe3D/tracedownresult.rjson?edgeID=2&isUncertainDirectionValid=true&weightName=SMLENGTH is as follows:
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 judge whether traceDownResult resource exists or whether it can be accessed on the client. By implementing the HEAD request on the URI, with .<format> appended to the end, we can quickly get to know whether the traceDownResult resource supports the representation in <format> or not.