appsShareSetting


URI

<apps_uri>/sharesetting[.<format>]

支持的方法

PUT

父资源

apps

介绍

appsShareSetting 资源是应用的共享设置资源。通过发送 PUT 请求,可以批量更新应用的权限信息。应用创建者和管理员可以更新应用的权限信息。

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/apps/sharesetting.rjson

PUT 请求

批量更新应用的权限信息。

请求参数

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

名称 类型 含义
ids List<Integer> 应用 id 数组。
entities List<IportalAuthorizeEntity> 共享设置。权限类型包括 SEARCH(检索),READ(查看), READWRITE(编辑)。

响应结构

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

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

响应示例

appsShareSetting 资源对应的批量更新应用的共享方式有五种,分别为私有、公开、指定部门、指定群组和指定用户。其中,公开又包含允许所有用户(包含匿名用户)可检索、可查看和允许所有用户(仅限登录用户)可编辑。并且可以同时设置该资源的共享方式为公开、指定部门、指定群组和指定用户,也可以单独设置共享方式,下面就单独设置共享方式分别举例说明(请确保应用创建者或管理员处于登录状态):

1. 私有

对 appsShareSetting 资源:http://localhost:8190/iportal/web/apps/sharesetting.rjson 执行 PUT 请求,批量修改应用的共享设置信息为私有,即只允许应用注册者和管理员可以检索、查看、编辑应用:

{

    "ids": [

        "7",

        "8"

    ],

    "entities": []

}

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

{"succeed": true}

2. 公开

对 appsShareSetting 资源:http://localhost:8190/iportal/web/apps/sharesetting.rjson 执行 PUT 请求,批量修改应用的共享设置信息为公开,即所有用户(包含匿名用户)可以检索、查看,并且所有用户(仅限登录用户)可以编辑该应用,发送请求体如下:

{

    "ids": [

        7,

        8

    ],

    "entities": [

        {

            "entityName": "GUEST",

            "entityType": "USER",

            "permissionType": "READWRITE"

        }

    ]

}

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

{"succeed": true}

3. 指定部门

对 appsShareSetting 资源:http://localhost:8190/iportal/web/apps/sharesetting.rjson 执行 PUT 请求,批量修改应用的共享设置信息为指定部门,即该部门内的所有成员都可以编辑该应用,发送请求体如下:

{

    "ids": [

        7,

        8

    ],

    "entities": [

        {

            "entityId": 2,

            "entityType": "DEPARTMENT",

            "permissionType": "READWRITE"

        }

    ]

}

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

{"succeed": true}

4. 指定群组

对 appsShareSetting 资源:http://localhost:8190/iportal/web/apps/sharesetting.rjson 执行 PUT 请求,批量修改应用的共享设置信息为指定群组 Id 为1,该群组内的所有成员都可以编辑该应用,发送请求体如下:

{

    "ids": [

        7,

        8

    ],

    "entities": [

        {

            "entityId": 1,

            "entityType": "IPORTALGROUP",

            "permissionType": "READWRITE"

        }

    ]

}

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

{"succeed": true}

5. 指定用户

对 appsShareSetting 资源:http://localhost:8190/iportal/web/apps/sharesetting.rjson 执行 PUT 请求,批量修改应用的共享设置信息为指定用户,即指定用户 liyl 可以编辑该应用,发送请求体如下:

{

    "ids": [

        7,

        8

    ],

    "entities": [

        {

            "entityName": "liyl",

            "entityType": "USER",

            "permissionType": "READWRITE"

        }

    ]

}

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

{"succeed": true}

请参见