URI

<dataset_uri>/shadowvolume[.<format>]

Supported methods

GETPOSTHEAD

Parent resource

dataset

Child resources

datasetSpatialQuery3DResult

Introduction

模型数据集获取阴影体,该资源只针对模型数据集,获取指定模型数据集的阴影体结果。

对该资源发送POST请求,则可以Creates a阴影体分析结果资源。

Supported methods:

  • GET:Returns a form for the POST request.
  • POST:Creates a阴影体分析结果资源。
  • HEAD:检查shadowVolumeresource exists, or if there is permission to accessshadowVolume资源。

Supported output formats:RJSON、JSON、HTML、XML。

GIS Services Resource Hierarchy

HTTP Request Methods

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

http://supermapiserver:8090/iserver/services/spatialAnalysis-BIM/restjsr/spatialanalyst/datasets/结构柱%408ExportModel/shadowvolume.rjson

GET 请求

Returns a form for the POST request.

POST 请求

Creates a阴影体分析结果资源。

Request parameters

Parameters in the request body are as follows:

名称 类型 含义
sourceDatasetFilter QueryParameter 过滤查询参数,包括属性过滤和ID过滤,只有满足条件的对象才参与阴影体分析。
shadowSetting ShadowVolumeParameter 阴影体设置参数,包括光源类型、日期、时间。
resultSetting DatasetSpatialQuery3DResultSetting 结果设置,包括结果数据集名称、最大返回记录、数据返回模式、是否覆盖已有数据。 对于数据返回模式,包括只返回数据集标识(DATASET_ONLY)、只返回记录集(RECORDSET_ONLY)和返回数据集标识和记录集(DATASET_AND_RECORDSET)三种模式,默认为只返回数据集标识。 请注意,当返回的结果数据量较大时,建议您使用只返回数据集标识模式返回数据,对返回的数据集可以进行其他空间分析操作。

Response structure

Normal response code(s): 201. The response parameters are as follows:

字段 类型 说明
postResultType postResultType POST 请求的结果类型,枚举说明 POST 请求对目标资源的影响,即处理结果是什么样的。
newResourceID String 分析结果资源的 ID。
succeed boolean 分析是否成功。
newResourceLocation String 创建的新资源的 URI。

Example of response

对shadowVolume资源:http://supermapiserver:8090/iserver/services/spatialAnalysis-BIM/restjsr/spatialanalyst/datasets/结构柱%408ExportModel/shadowvolume.rjson,操作对象选择为数据集,执行 POST 请求,请求参数如下:

{

"sourceDatasetFilter":{"attributeFilter":"", "ids":[2]},

"shadowSetting":{"shadowLightType":"SUNLIGHT", "year":2018, "month":6, "day":7, "hour":10, "minute":25, "second":0}

}

The returned resource description in rjson format is shown below:

{

"postResultType":"CreateChild",

"newResourceID":"09b8",

"succeed":true,

"newResourceLocation":"http://supermapiserver:8090/iserver/services/spatialAnalysis-BIM/restjsr/spatialanalyst/datasets/结构柱%408ExportModel/shadowvolume/09b8"

}

HEAD 请求

Returns the same HTTP response headers as a GET request, but without the response body. This allows retrieving meta-information from the response headers without transporting the entire content. The meta-information includes the media type,字符编码,压缩编码,实体内容长度等。

A HEAD request can be used to check ifshadowVolume资源是否存在,或者客户端是否有权限访问shadowVolume 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 shadowVolume 资源是否支持<format>格式的表述。

See