sinks

URI

<fa3DNetworkDataName_uri>/sinks[.<format>]

支持的方法

GET、HEAD

父资源

fa3DNetworkDataName

介绍

sinks 为汇查找资源，通过 sinks 资源您可以根据给定弧段或节点 ID 查找汇，即从给定弧段或节点出发，根据流向查找流出该弧段或节点的下游汇点，并返回给定弧段或节点到达该汇的最小耗费路径所包含的弧段、结点及耗费。

支持的方法：

GET：获取给定弧段或节点到达该汇的最小耗费路径所包含的弧段、结点及耗费。
HEAD：检查 sinks 资源是否存在，或权限是否可以访问 sinks 资源。

支持的表述格式：RJSON、JSON、XML、HTML、JSONP。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiserver 是服务器名。

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

GET 请求

获取给定弧段或节点到达该汇的最小耗费路径所包含的弧段、结点及耗费。

请求参数

对 sinks 资源执行 GET 请求，需要在 URI 中包含一些参数，参数如下：

名称	类型	含义
edgeID	int	【必选参数】三维设施网络分析中指定的弧段 ID ，在请求 URI 中只能包含 edgeID 参数或 nodeID 参数，两者不能同时存在。
nodeID	int	【必选参数】三维设施网络分析中指定的节点 ID ，在请求 URI 中只能包含 nodeID 参数与 edgeID 参数，两者不能同时存在。
isUncertainDirectionValid	boolean	三维设施网络分析中指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。默认为 false ，流向字段的值为 2 时代表该弧段的流向为不确定流向。
weightName	String	【必选参数】三维设施网络分析中指定的权值字段名称。

响应结构

对 sinks 资源执行 GET 请求，在响应消息的实体主体里包括给定弧段或节点到达该汇的最小耗费路径所包含的弧段、结点及耗费信息，具体表述结构如下：

字段	类型	说明
cost	double	三维设施网络分析结果中的耗费。
edges	int[]	三维设施网络分析结果中的弧段 ID 数组。
nodes	int[]	三维设施网络分析结果中的结点 ID 数组。

响应示例

对 sinks 资源执行 GET 请求（http://localhost:8090/iserver/services/networkAnalyst3D-Pipe3D/rest/facilityanalyst3d/Network@Pipe3D/sinks.rjson?edgeID=2&isUncertainDirectionValid=true&weightName=SMLENGTH），返回 rjson 格式的资源描述如下：

{ "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 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 sinks 资源是否存在，或者客户端是否有权限访问 sinks 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 sinks 资源是否支持<format>格式的表述。