dirsResources


URI

<directories_uri>/resources[.<format>]

支持的方法

GETPOSTHEAD

父资源

directories

介绍

dirsResources 资源是未添加到目录中的资源列表信息。

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/directories/resources.rjson

GET 请求

获取未添加到目录中的资源列表信息。

请求参数

如果参数未设置,则返回用户有权限查看的当前第一页中的所有未添加到目录中的资源列表信息,设置参数后,会返回用户指定的未添加到目录中的资源列表信息,请求参数必须包含在 URI 中。

名称 类型 含义
resourceName String 根据资源名称过滤。
type DirectoryResourceType 根据目录资源类型过滤。
currentPage int 分页页码。
pageSize int 分页中每页大小。

响应结构

对 dirsResources 资源执行 GET 请求,返回当前用户有权限查看的未添加到目录中的资源列表信息。由以下字段组成:

 
字段 类型 说明
content List<DirectoryResource> 页面内容。
currentPage int 当前第几页。
pageSize int 每页大小。
searchParameter SearchParameter 当前页搜索参数。
total int 总记录数。
totalPage int 总页数。

响应示例

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

{

    "content": [

        {

            "resourceCreator": "admin",

            "resourceId": 1,

            "resourceName": "ChinaProvinces",

            "updateTime": 1433898726636

        },

        {

            "resourceCreator": "admin",

            "resourceId": 2,

            "resourceName": "长春市区图",

            "updateTime": 1433898733628

        },

        {

            "resourceCreator": "admin",

            "resourceId": 3,

            "resourceName": "长春市区图_Local",

            "updateTime": 1433898733646

        },

        {

            "resourceCreator": "admin",

            "resourceId": 4,

            "resourceName": "China",

            "updateTime": 1433898733807

        },

        {

            "resourceCreator": "admin",

            "resourceId": 5,

            "resourceName": "China_4326",

            "updateTime": 1433898733817

        },

        {

            "resourceCreator": "admin",

            "resourceId": 6,

            "resourceName": "China",

            "updateTime": 1433898734312

        },

        {

            "resourceCreator": "admin",

            "resourceId": 7,

            "resourceName": "China_4326",

            "updateTime": 1433898734438

        },

        {

            "resourceCreator": "admin",

            "resourceId": 8,

            "resourceName": "China",

            "updateTime": 1433898734593

        },

        {

            "resourceCreator": "admin",

            "resourceId": 9,

            "resourceName": "China_4326",

            "updateTime": 1433898734654

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "currentPage": 1,

        "currentUser": null,

        "groupIds": null,

        "keywords": null,

        "orderType": "ASC",

        "pageSize": 9,

        "resourceIds": null,

        "resourceName": null,

        "type": "MAP"

    },

    "total": 86,

    "totalPage": 10

}

如果希望获取指定的未添加到目录中的资源列表信息,如根据资源名称过滤,则需要设置 resourceName=China,即对

maps 资源:http://localhost:8190/iportal/web/directories/resources.rjson?resourceName=China 执行

GET 请求,返回的 rjson 格式的资源表述如下:

{

    "content": [

        {

            "resourceCreator": "admin",

            "resourceId": 1,

            "resourceName": "ChinaProvinces",

            "updateTime": 1433898726636

        },

        {

            "resourceCreator": "admin",

            "resourceId": 4,

            "resourceName": "China",

            "updateTime": 1433898733807

        },

        {

            "resourceCreator": "admin",

            "resourceId": 5,

            "resourceName": "China_4326",

            "updateTime": 1433898733817

        },

        {

            "resourceCreator": "admin",

            "resourceId": 6,

            "resourceName": "China",

            "updateTime": 1433898734312

        },

        {

            "resourceCreator": "admin",

            "resourceId": 7,

            "resourceName": "China_4326",

            "updateTime": 1433898734438

        },

        {

            "resourceCreator": "admin",

            "resourceId": 8,

            "resourceName": "China",

            "updateTime": 1433898734593

        },

        {

            "resourceCreator": "admin",

            "resourceId": 9,

            "resourceName": "China_4326",

            "updateTime": 1433898734654

        },

        {

            "resourceCreator": "admin",

            "resourceId": 11,

            "resourceName": "China_4326",

            "updateTime": 1433898734798

        },

        {

            "resourceCreator": "admin",

            "resourceId": 12,

            "resourceName": "China",

            "updateTime": 1433898734948

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "currentPage": 1,

        "currentUser": null,

        "groupIds": null,

        "keywords": null,

        "orderType": "ASC",

        "pageSize": 9,

        "resourceIds": null,

        "resourceName": "China",

        "type": "MAP"

    },

    "total": 15,

    "totalPage": 2

}

POST 请求

将指定的资源放到指定名称的目录中。如果指定名称的目录不存在,则会新建一个同名目录,并将指定资源移动到该目录中。

请求参数

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

名称 类型 含义
basicDirInfo BasicDirInfo 目录的基本信息。
dirResource DirectoryResource 待移动的资源信息。

响应结构

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

字段 类型 说明
succeed boolean 单个目录添加资源是否成功。
error HttpError 出错信息,如果单个目录添加资源成功,则没有本字段。

响应示例

对 dirsResources 资源:http://localhost:8190/iportal/web/directories/resources.rjson 执行 POST 请求,在名为“人口专题图”的地图目录下添加一个地图资源,资源 id 为 551110350,发送请求体如下:

{

    "basicDirInfo": {

        "dirType": "MAP",

        "dirName": "目录二",

    },

    "dirResource": {

      "resourceId":551110350,

    }

}

则返回的 rjson 格式响应结果如下:

{

    "succeed": true

}

HEAD 请求

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

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

请参见