scene


URI

<scenes_uri>/{id}[.<format>]

支持的方法

GETPUTDELETEHEAD

父资源

scenes

子资源

sceneShareSetting

介绍

scene 资源是指定场景的详细信息资源,支持检索,更新和删除场景。

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/scenes/{id}.rjson

GET 请求

获取指定场景的详细信息。

响应结构

对 scene 资源执行 GET 请求,获取指定的场景信息,由以下字段组成:

字段 类型 说明
authorizeSetting List<IportalAuthorizeEntity> 三维场景的授权信息。
createTime Long 三维场景的添加时间。
description String 三维场景的描述信息。
id Integer 三维场景的标识。
name String 三维场景的名称。
nickname String 添加者的昵称。
tags List<String> 三维场景的标签。
thumbnail String 场景的缩略图路径。
updateTime Long 三维场景的更新时间。
url String 三维场景的地址。例如:http://ip:port/iportal/services/realspace-sample/rest/realspace/scenes/scene
userName String 三维场景的添加者。
visitCount Integer 三维场景的访问次数。

响应示例

对 scene 资源:http://localhost:8190/iportal/web/scenes/6.rjson 执行 GET 请求,返回的 rjson 格式的资源表述如下:

{

    "authorizeSetting": [

        {

            "aliasName": "GUEST",

            "entityId": null,

            "entityName": "GUEST",

            "entityType": "USER",

            "permissionType": "READ"

        },

        {

            "aliasName": "admin",

            "entityId": null,

            "entityName": "admin",

            "entityType": "USER",

            "permissionType": "DELETE"

        }

    ],

    "createTime": 1439171597118,

    "description": null,

    "id": 6,

    "name": "scene_olympicnight",

    "nickname": "admin",

    "tags": [

        "系统场景"

    ],

    "thumbnail": null,

    "updateTime": 1439171597118,

    "url": "http://192.168.120.40:8190/iportal/services/3D-sample/rest/realspace/scenes/scene_olympicnight",

    "userName": "admin",

    "visitCount": 2

}

PUT 请求

更新指定的场景信息。只有场景的添加者和门户管理员有权限对场景进行更新。

请求参数

发送请求时,需要在请求体中包含如下参数:

字段 类型 说明
tags List<String> 场景的标签。
name String 场景的名称。
description String 场景的描述信息。
thumbnail String 场景的缩略图路径。
authorizeSetting List<IportalAuthorizeEntity> 场景的授权信息。

响应结构

返回的资源表述结构如下:

字段 类型 说明
succeed boolean 更新服务是否成功。
error Httperror 出错信息,如果更新服务成功,则没有本字段。

响应示例

修改场景名称为:scene_1,对 scene 资源:http://localhost:8190/iportal/web/scenes/13.json 执行 PUT 请求,发送请求体如下:

{

    "name": "scene_1"

}

则返回的 rjson 格式的表述如下:

{ "succeed": true}

DELETE 请求

删除指定的场景。

响应示例

对 scene 资源:http://localhost:8190/iportal/web/scenes/13.rjson 执行 DELETE 请求,返回的 rjson 格式的表述如下:

{ "succeed": true}

HEAD 请求

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

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

请参见