<myContent_uri>/datas[.<format>]
dataCapacity、myData、batchDelete、datasShareSetting
myDatas 资源是当前用户上传的所有数据信息的集合。
支持的方法:
支持的表述格式:RJSON、JSON、XML、HTML。
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/mycontent/datas.rjson
获取当前用户上传的数据列表信息。
如果参数未设置,则返回用户上传的当前第一页中的数据列表信息,设置参数后,会返回用户指定的数据列表信息,请求参数必须包含在 URI 中。
名称 | 类型 | 含义 |
userName |
String | 用户名,该参数已过期,推荐您使用参数 userNames。 |
userNames |
String[] | 数据作者名。可以根据数据作者名查询,默认查询全部。 |
type | DataItemType | 数据类型,该参数已过期,推荐您使用参数 types。可以为 AUDIO(音频文件)、MBTILES、PHOTOS(照片)、IMAGE(图片)、SMTILES、SVTILES、TPK、UDB、UGCV5、VIDEO(视频文件)、WORKSPACE(工作空间,即由文件后缀名为 *. sxwu、*. smwu、*. sxw 或 *. smw 的工作空间数据压缩而成的 zip 包)或 UNKNOWN(除前面列举的文件类型外,其它所有文件类型)。 |
types | DataItemType[] | 数据类型。可以为 WORKSPACE(工作空间,即由文件后缀名为 *. sxwu、*. smwu、*. sxw 或 *. smw 的工作空间数据压缩而成的 zip 包)、SMTILES、SVTILES、MBTiles、TPK、UDB、UGCV5、Excel 数据、CSV 数据等类型。 |
fileName | String | 文件名称。 |
serviceStatuses | ServiceStatus[] | 服务发布状态。该参数已过期。 |
serviceId | String | 服务 id 。该参数已过期。 |
ids | Integer[] | 由数据项 id 组成的整型数组。 |
keywords | String[] | 关键字。 |
orderBy | DataItemOrderBy | 排序字段。 |
orderType | OrderType | 根据升序还是降序过滤。 |
tags | String[] | 数据的标签。 |
filterFields | FilterFields[] | 用于关键字查询时的字段过滤。字段名称需大写。例如:根据文件名称的关键字符过滤,则需要设置keywords=["城市0426.zip"]&filterFields=["FILENAME"]。 |
isPublic | Boolean | 是否查询公开参数,默认值:false。 |
isNotInDir | Boolean | 根据数据是否添加到目录进行过滤。默认值:false,根据数据添加到目录进行过滤。 |
returnSubDir | Boolean | 根据是否查询子目录的数据资源过滤。true:表示返回当前查询目录及其子目录的数据资源;false:表示仅返回当前目录的数据资源。 |
dirIds | Integer[] | 由目录的 id 组成的整型数组。 |
currentPage | int | 分页页码。 |
pageSize | int | 分页中每页大小。 |
status | Status | 数据的状态。 |
createStart | Long | 查询此时间值及此时间值之后创建的数据,如果为null或者小于0,则起始时间不限制。 |
createEnd | Long | 查询此时间值及此时间值之前创建的数据,如果为null或者小于0,则截止时间不限制。 |
对 myDatas 资源执行 GET 请求,返回当前用户上传的所有数据列表信息。由以下字段组成:
字段 | 类型 | 说明 |
content | List<DataItem> | 页面内容。 |
currentPage | int | 当前第几页。 |
pageSize | int | 每页大小。 |
searchParameter | SearchParameter | 当前页搜索参数。 |
total | int | 总记录数。 |
totalPage | int | 总页数。 |
对 myDatas 资源:http://localhost:8190/iportal/web/mycontent/datas.rjson 执行 GET 请求,返回的 rjson 格式的资源表述如下:
{
"content": [
{
"MD5": "fd524f3c60c061166e63a256bb72bf0a",
"authorizeSetting": [
{
"aliasName": "admin",
"dataPermissionType": "DELETE",
"entityId": null,
"entityName": "admin",
"entityRoles": null,
"entityType": "USER"
}
],
"coordType": null,
"createTime": 1524469199567,
"dataCheckResult": {
"dataCheckInfo": null,
"serviceCheckInfos": []
},
"dataItemServices": [],
"dataMetaInfo": null,
"description": null,
"downloadCount": 0,
"fileName": "City2018.zip",
"id": 1718888275,
"lastModfiedTime": 1524469199567,
"nickname": "admin",
"publishInfo": null,
"serviceId": null,
"serviceStatus": "UNPUBLISHED",
"size": 19606161,
"status": "OK",
"storageId": "5ggo5vpo_7k3dkbve_cc0aa197_8121_41fa_a3ee_cce069b20c06",
"tags": null,
"thumbnail": "http://192.168.120.40:8090/services/../web/static/portal/img/map/cloud.png",
"type": "WORKSPACE",
"userName": "admin"
}
],
"currentPage": 1,
"pageSize": 9,
"searchParameter": {
"createEnd": null,
"createStart": null,
"currentPage": 1,
"currentUser": null,
"departmentIds": null,
"dirIds": null,
"fileName": null,
"filterFields": null,
"groupIds": null,
"ids": null,
"isNotInDir": false,
"isPublic": false,
"keywords": null,
"md5s": null,
"orderBy": null,
"orderType": "ASC",
"pageSize": 9,
"resourceIds": null,
"returnSubDir": null,
"serviceId": null,
"serviceStatuses": null,
"status": null,
"tags": null,
"type": null,
"types": null,
"userName": null,
"userNames": [
"admin"
]
},
"total": 1,
"totalPage": 1
}
如果希望获取指定的数据列表信息,如根据文件名称的关键字符过滤,则需要设置keywords=["城市0426.zip"]&filterFields=["FILENAME"],即对 myDatas 资源:http://localhost:8190/iportal/web/mycontent/datas.rjson?keywords=["City2018.zip"]&filterFields=["FILENAME"] 执行 GET 请求,返回的 rjson 格式的资源表述如下:
{
"content": [
{
"MD5": "fd524f3c60c061166e63a256bb72bf0a",
"authorizeSetting": [
{
"aliasName": "admin",
"dataPermissionType": "DELETE",
"entityId": null,
"entityName": "admin",
"entityRoles": null,
"entityType": "USER"
}
],
"coordType": null,
"createTime": 1524469199567,
"dataCheckResult": {
"dataCheckInfo": null,
"serviceCheckInfos": []
},
"dataItemServices": [],
"dataMetaInfo": null,
"description": null,
"downloadCount": 0,
"fileName": "City2018.zip",
"id": 1718888275,
"lastModfiedTime": 1524469199567,
"nickname": "admin",
"publishInfo": null,
"serviceId": null,
"serviceStatus": "UNPUBLISHED",
"size": 19606161,
"status": "OK",
"storageId": "5ggo5vpo_7k3dkbve_cc0aa197_8121_41fa_a3ee_cce069b20c06",
"tags": null,
"thumbnail": "http://192.168.120.40:8090/services/../web/static/portal/img/map/cloud.png",
"type": "WORKSPACE",
"userName": "admin"
}
],
"currentPage": 1,
"pageSize": 9,
"searchParameter": {
"createEnd": -1,
"createStart": -1,
"currentPage": 1,
"currentUser": null,
"departmentIds": null,
"dirIds": null,
"fileName": null,
"filterFields": [
"FILENAME"
],
"groupIds": null,
"ids": null,
"isNotInDir": null,
"isPublic": null,
"keywords": [
"City2018.zip"
],
"md5s": null,
"orderBy": null,
"orderType": "ASC",
"pageSize": 9,
"resourceIds": null,
"returnSubDir": null,
"serviceId": null,
"serviceStatuses": null,
"status": null,
"tags": null,
"type": null,
"types": null,
"userName": null,
"userNames": [
"admin"
]
},
"total": 1,
"totalPage": 1
}
创建数据项 id 。
请求参数
发送请求时,需要在请求体中传递如下参数:
名称 | 类型 | 含义 |
type | DataItemType | 【必选参数】
文件类型。可以为 WORKSPACE(工作空间,即由文件后缀名为 *. sxwu、*. smwu、*. sxw 或 *. smw 的工作空间数据压缩而成的 zip 包)、SMTILES、SVTILES、MBTiles、TPK、UDB、UGCV5、Excel 数据、CSV 数据等类型。 |
fileName | String | 【必选参数】
文件名称。 |
dataMetaInfo | DataMetaInfo | 【可选参数】
数据的元信息。 |
tags | List<String> | 【可选参数】
数据的标签。 |
coordType | String | 【可选参数】
数据的坐标类型。 |
响应结构
返回的资源表述结构如下:
字段 |
类型 | 说明 |
childID |
String | 子资源的 id ,即数据项 id 。 |
childContent |
Object |
子资源的内容 。 |
childUrl |
String |
子资源的 URI 。 |
customResult |
Object |
自定义结果 。 |
isAsynchronizedReturn |
boolean |
结果是否是异步返回 。对于该资源 isAsynchronizedReturn 的值总为 false 。 |
响应示例
对 myDatas 资源:http://localhost:8190/iportal/web/mycontent/datas.rjson 执行 POST 请求,可以获取上传数据时需要的数据项 id,发送请求体如下:
{
"fileName": "全国省会点.csv",
"tags": [
"用户数据"
],
"type": "CSV",
"coordType": "WGS84",
"dataMetaInfo": {
"xField": "X",
"yField": "Y",
"fileEncoding": "UTF-8"
}
}
则返回的 rjson 格式响应结果如下:
{
"childID": "1699161031",
"isAsynchronizedReturn": false,
"childContent": null,
"childUrl": null,
"customResult": null
}
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 myDatas 资源是否存在,或者客户端是否有权限访问 myDatas 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 myDatas 资源是否支持<format>格式的表述。