/DataContainer

接的师兄的工作,专门管理数据的上传下载的,比较稳定

Primary LanguageJava

DataContainer

@[TOC]

批量上传接口(需要上传配置文件)

  • 请求方式 POST
  • 接口参数

BODY formdata


字段 示例值
name test
userId 1
serverNode china
origination developer
  • 接口示例
curl --location --request POST 'http://221.226.60.2:8082/configData' \
--form 'datafile=@/path/to/file' \
--form 'name=test' \
--form 'userId=1' \
--form 'serverNode=china' \
--form 'origination=developer'
  • 返回值
{"code":1,"message":"upload file success!","data":{"file_name":"test","source_store_id":"6d8b9bad-59f3-495b-9d74-41159f7f4049"},"result":"suc"}

下载接口

  • 请求方式 GET
  • 接口参数

字段 示例值
id 0b86cb92-4380-4075-b6bb-a9a3ac94ad07
  • URL URL : /data/[id]
  • 接口示例
http://221.226.60.2:8082/data/0b86cb92-4380-4075-b6bb-a9a3ac94ad07
  • 返回值 下载的数据,无返回值

数据展示接口(下载接口加上信息过滤)

  • 请求方式 GET
  • 接口参数

字段 示例值
id 6649b522-4803-4202-83f4-8c9532c062d5
type html
  • URL URL : /data/[id]?type=[file type]
  • 接口示例
http://221.226.60.2:8082/data/6649b522-4803-4202-83f4-8c9532c062d5?type=html
  • 支持的为HTTP支持的ContentType HTML(0, "text/html;charset=utf-8"), Plain(1, "text/plain"), XML(2, "text/xml"), GIF(3, "image/gif"), JPG(4, "image/jpeg"), PNG(5, "image/png"), XHTML(6, "application/xhtml+xml"), XML_DATA(6, "application/xml"), Atom_XML(6, "application/atom+xml"), JSON(6, "application/json"), PDF(6, "application/pdf"), WORD(6, "application/msword"), OCTET_STREAM(6, "application/octet-stream"), X_WWW_FORM_URLENCODED(6, "application/x-www-form-urlencoded ");
  • 返回值 页面展示文件内容,例如type为html则不下载数据,展示为网页

批量下载接口

  • 请求方式 GET
  • 接口参数 PARAMS

字段 示例值
oids 0b86cb92-4380-4075-b6bb-a9a3ac94ad07,0f6dfa51-ae74-4295-98f4-96f49a17350b
  • 接口示例
http://221.226.60.2:8082/batchData?oids=0b86cb92-4380-4075-b6bb-a9a3ac94ad07,0f6dfa51-ae74-4295-98f4-96f49a17350b
  • 返回值 下载的zip包,无返回值

删除接口

  • 请求方式 DELETE
  • 接口参数

字段 示例值
uid 893b08ef-73ab-4d29-aaa9-239bc3115001
  • URL URL : /data/[id]
  • 接口示例
http://221.226.60.2:8082/data/0b86cb92-4380-4075-b6bb-a9a3ac94ad07
  • 返回值
{
    "code": 1,
    "message": "delete file success",
    "data": "",
    "result": "suc"
}

批量删除接口

  • 请求方式 DELETE
  • 接口参数 PARAMS

字段 示例值
oids b5d92fa5-edf8-4385-aaa9-d2015928a047,92614796-6a5d-4467-b2e2-959dcaa59016
  • 接口示例
http://221.226.60.2:8082/batchData?oids=b5d92fa5-edf8-4385-aaa9-d2015928a047,92614796-6a5d-4467-b2e2-959dcaa59016
  • 返回值
{
    "code": 1,
    "message": "All file delete success",
    "data": "",
    "result": "suc"
}

可视化接口

  • 请求方式 GET
  • 接口参数 PARAMS

字段 示例值
uid e684ef96-cbad-468d-853e-e80fe157fbf5
  • 接口示例
http://221.226.60.2:8082/visual?uid=e684ef96-cbad-468d-853e-e80fe157fbf5
  • 返回值 下载的png文件,无返回值

无需配置文件上传接口

  • 请求方式 POST
  • 接口参数 BODY formdata

字段 示例值
name test
userId 1
serverNode china
origination developer
  • 接口示例
curl --location --request POST 'http://221.226.60.2:8082/data' \
--form 'datafile=@/path/to/file' \
--form 'name=test' \
--form 'userId=1' \
--form 'serverNode=china' \
--form 'origination=developer'
  • 返回值
{"code":1,"message":"upload file success!","data":{"file_name":"test","source_store_id":"6d8b9bad-59f3-495b-9d74-41159f7f4049"},"result":"suc"}

更改dataTemplate接口

  • 请求方式 POST
  • 接口参数 PARAMS

字段 示例值 意义
oid e684ef96-cbad-468d-853e-e80fe157fbf5 数据的id
templateId d3605b83-af8d-491c-91b3-a0e0bf3fe714 需要新增或者更改的templateId
type add or type 操作的类型
  • 接口示例
http://221.226.60.2:8082/editTemplateId?oid=af44f4c9-da19-480f-9253-f21250fa10a5&templateId=d3605b83-af8d-491c-91b3-a0e0bf3fe7&type=add
  • 返回值 新增成功:
{
    "code": 0,
    "msg": "add success",
    "data": "oid is af44f4c9-da19-480f-9253-f21250fa10a5"
}

编辑成功

{
    "code": 0,
    "msg": "edit success",
    "data": "oid is af44f4c9-da19-480f-9253-f21250fa10a5"
}

全局搜索接口

  • 请求方式 GET
  • 接口参数 PARAMS

字段 示例值 意义
name shp 全局搜索的关键字名称
  • 接口示例
http://221.226.60.2:8082/globalSearch?name=test特殊符号
  • 返回值
{
    "code": 0,
    "msg": "success",
    "data": [
        {
            "name": "test特殊符号",
            "oid": "5d96a719-d260-4f1b-99c7-19f22b337de8"
        },
        {
            "name": "test特殊符号",
            "oid": "5d96a719-d260-4f1b-99c7-19f22b337de8"
        }
    ]
}

元数据接口

  • 请求方式 GET
  • 接口参数 PARAMS

字段 示例值 意义
dataId ffa79772-5b31-4802-b56a-e54433bc5a6c 数据id
  • 接口示例
http://221.226.60.2:8082/getMetaData?dataId=ffa79772-5b31-4802-b56a-e54433bc5a6c
  • 返回值
{
    "code": 0,
    "msg": "success",
    "data": {
        "zipOid": "fcc70a25-14c5-4e80-9747-8966b2e22d90",
        "dataOids": [
            "320101f6-7c7b-497b-998d-8d25300ce0e7",
            "22c50b1d-db04-41c2-bb4a-e793275a10a0"
        ],
        "name": "test特殊符号",
        "origination": "portal",
        "serverNode": "china",
        "uid": "65",
        "date": "2020-08-28T11:37:31.845+0000",
        "type": "template",
        "dataTemplate": null,
        "dataTemplateId": "1816a01c-343a-472e-027c-6390fe3eba70",
        "path": "E:/upload/upload_ogms/fcc70a25-14c5-4e80-9747-8966b2e22d90",
        "configFile": true,
        "cache": null
    }
}

配置文件

  • 字段
<UDXZip>
    <Name> 文件列表,不包含配置文件,数目要上传文件数一致(不包含配置文件)
        <add value:文件名>
        ...
    </Name>   
    <DataTemplate    type:数据类型,可选参数 id, schema, none > 数据类型id,在type为id时有值</DataTemplate>
</UDXZip>
  • 基本内容
<UDXZip>
	<Name>//列出文件名,文件名不需要一一对应,但文件个数要和实际上传文件数对应
		<add value="dem.prj" />
		 <add value="dem.tif" />
	</Name>
    // type 参数可为id,schema,none,分别表示raw data、schema data 和其他任意数据
    //此尖括号下的内容为对应的数据模板的id,目前只有三种id可选,分别代表type=id的两种数据,shp和tiff
    //shp:['4996e027-209b-4121-907b-1ed36a417d22'],
    //tiff:['d3605b83-af8d-491c-91b3-a0e0bf3fe714','f73f31ff-2f23-4c7a-a57d-39d0c7a6c4e6']
    //此例中的id是tiff数据
	<DataTemplate type="id">d3605b83-af8d-491c-91b3-a0e0bf3fe714</DataTemplate>
</UDXZip>
  • 可选模板
主要在type为id的数据类型,进行可视化时使用

shp:['4996e027-209b-4121-907b-1ed36a417d22'],
tiff:['d3605b83-af8d-491c-91b3-a0e0bf3fe714','f73f31ff-2f23-4c7a-a57d-39d0c7a6c4e6']