app

URI

<apps_uri>/{appId}[.<format>]

支持的方法

GET、PUT、DELETE、HEAD

父资源

apps

介绍

应用资源。支持查看应用程序的详细信息，支持编辑更新应用程序的详细信息，支持删除应用程序。

支持的方法：

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/apps/{appId}.rjson

GET 请求

获取指定应用程序的详细信息。

响应结构

对 app 资源执行 GET 请求，返回的资源表述结构如下：

名称 类型 含义
address String 应用程序的地址。
appName String 应用程序的名称。
createTime Long 应用程序的注册时间。
authorizeSetting List<IportalAuthorizeEntity> 授权信息。应用的权限类型包括：DELETE（查看/编辑/删除）、READ（查看）、READWRITE（查看/编辑）。
description String 应用程序的描述信息。
id Integer 应用程序的 id 标识。
nickname String 注册者的昵称。
tags List<String> 应用程序的标签。
thumbnail String 应用程序的缩略图路径。
type AppType 应用程序的类型。
updateTime Long 应用程序的更新时间。
userName String 注册者的名称。
contactInfo ContactInfo 应用的联系人信息。
detailImages String[] 应用程序的描述图片。
checkStatus CheckStatus 应用审核状态。
checkTime Long 应用审核时间。
checkUser String 应用审核人名称。
checkUserNick String 应用审核人昵称。
verifyReason String 应用审核意见。

响应示例

对 app 资源：http://localhost:8190/iportal/web/apps/1683827090.rjson 执行 GET 请求，返回的 rjson 格式的表述如下：

{

    "thumbnail": "http://127.0.0.1:8190/iportal/services/../web/static/portal/img/app/defaultThumbnail.jpg",

    "address": "https://wiki.ispeco.com/pages/viewpage.action?pageId=65537225",

    "contactInfo": {

        "contactOrganization": "超图",

        "contactUser": "wm",

        "email": "12359566@qq.com"

    },

    "appName": "地理信息管理平台",

    "authorizeSetting": [

        {

            "permissionType": "DELETE",

            "aliasName": "iPortal1",

            "entityRoles": [

                "DATA_CENTER",

                "PORTAL_USER"

            ],

            "entityType": "USER",

            "entityName": "iPortal1",

            "entityId": null

        },

        {

            "permissionType": "SEARCH",

            "aliasName": "GUEST",

            "entityRoles": [],

            "entityType": "USER",

            "entityName": "GUEST",

            "entityId": null

        }

    ],

    "description": "地理信息集成、管理与共享",

    "updateTime": 1608636386544,

    "verifyReason": null,

    "userName": "iPortal1",

    "type": "PCAPP",

    "tags": [

        "超图",

        "用户应用"

    ],

    "checkUser": null,

    "checkUserNick": null,

    "checkStatus": "SUCCESSFUL",

    "checkTime": null,

    "createTime": 1607396629359,

    "nickname": "iPortal1",

    "detailImages": [],

    "id": 1683827090

}

PUT 请求

编辑更新指定应用程序的基本信息。

请求参数

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

字段 类型 说明
appName String 应用程序的名称。
address String 应用程序的地址。

description

 String 应用程序的描述信息。

tags

 List<String> 应用程序的标签。
thumbnail String 应用程序的缩略图路径。
contactInfo ContactInfo 应用的联系人信息。
type AppType 应用程序的类型。
detailImages String[] 应用程序的描述图片。

响应结构

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

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

响应示例

修改应用的名称，对 app 资源：http://localhost:8190/iportal/web/apps/1683827090.json 执行 PUT 请求，发送请求体如下：

{

    "detailImages": [],

    "address": "https://wiki.ispeco.com/pages/viewpage.action?pageId=65537225",

    "appName": "地理信息管理平台",

    "description": "地理信息集成、管理与共享",

    "tags": [

        "超图",

        "用户应用"

    ],

    "thumbnail": "http://127.0.0.1:8190/iportal/services/../resources/thumbnail/app/app1683827090.png",

    "type": "PCAPP",

    "contactInfo": {

        "contactOrganization": "超图",

        "contactUser": "wm",

        "email": "12359566@qq.com"

    }

}

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

{ "succeed": true}

DELETE 请求

删除指定 id 的应用程序。

响应结构

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

字段 类型 说明
succeed boolean 删除应用程序是否成功。
error Httperror 出错信息，如果删除应用程序成功，则没有本字段。

响应示例

对 app 资源:http://localhost:8190/iportal/web/apps/6.rjson 执行 DELETE 请求，返回的 rjson 格式响应结果如下：

{ "succeed": true}

HEAD 请求

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

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

请参见