dataShareSetting


URI

<myData_uri>/sharesetting[.<format>]

支持的方法

GETPUTHEAD

父资源

myData

介绍

dataShareSetting 是数据的共享设置资源,通过发送 GET 请求,可以根据数据的 id 获取指定数据的权限信息。也可以发送 PUT 请求,更新指定数据的权限信息。数据文件的上传者和管理员可以更新数据文件的权限信息。

有关数据的权限信息介绍以及如何批量更新数据的权限信息可参见 datasShareSetting 资源的 PUT 请求

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/mycontent/datas/{id}/sharesetting.rjson

GET 请求

根据数据的 id 获取指定数据的权限信息。

响应结构

对 dataShareSetting 资源执行 GET 请求,返回的资源表述结构如下:

字段 类型 说明
dataPermissionType DataPermissionType 数据的权限类型。包包括:SEARCH(检索)和 DOWNLOAD (下载) 权限。
entityType EntityType 实体类型。包括:USER(用户)、 ROLE(角色)、GROUP(用户组)、IPORTALGROUP(群组)。
entityName String 实体 Name。对应的 USER(用户)、 ROLE(角色)、GROUP(用户组)、IPORTALGROUP(群组)的名称。
aliasName String 实体的别名,比如 entityType 为 USER 时,别名表示昵称。
entityId Integer 实体的 id。用于群组的授权。

响应示例

对 dataShareSetting 资源:http://localhost:8190/iportal/web/mycontent/datas/11/sharesetting.rjson 执行 GET 请求,返回的 rjson 格式的响应结果如下,显示的权限信息是公开,即: admin 管理员有检索、下载、更新、删除权限,所有用户(包含匿名用户)可检索、下载数据文件:

[

    {

        "aliasName": "admin",

        "dataPermissionType": "DELETE",

        "entityId": null,

        "entityName": "admin",

        "entityType": "USER"

    },

    {

        "aliasName": "GUEST",

        "dataPermissionType": "DOWNLOAD",

        "entityId": null,

        "entityName": "GUEST",

        "entityType": "USER"

    }

]

PUT 请求

根据数据的 id 更新指定数据的权限信息。

请求参数

对 dataShareSetting 资源执行 PUT 请求,需要在请求体中传递如下参数:

字段 类型 说明
dataPermissionType DataPermissionType 数据的权限类型。包括:SEARCH(检索)和 DOWNLOAD (下载) 权限。
entityType EntityType 实体类型。包括:DEPARTMENT(部门)、USER(用户)、 ROLE(角色)、GROUP(用户组)、IPORTALGROUP(群组)。
entityName String 实体 Name。对应的 USER(用户)、 ROLE(角色)、GROUP(用户组)的名称。
entityId Integer 实体的 id。用于群组的授权。

响应结构

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

字段 类型 说明
succeed boolean 更新指定数据的共享设置是否成功。
error Httperror 出错信息,如果更新指定数据的共享设置成功,则没有本字段。

响应示例

对 dataShareSetting 资源:http://localhost:8190/iportal/web/mycontent/datas/11/sharesetting.rjson 执行 PUT 请求,数据的权限信息由公开修改为指定用户 zhaoyuan2 可下载数据文件,发送请求体如下:

[

    {

        "dataPermissionType": "DOWNLOAD",

        "entityId": null,

        "entityName": "zhaoyuan2",

        "entityType": "USER"

    }

]

则返回的 rjson 格式的资源表述结构如下:

{"succeed": true}

HEAD 请求

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

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

请参见