更新时间:2024-07-31 GMT+08:00
分享

通过API方式上传简单文件

功能介绍

通过“文件管理”接口“upload_uploadFile”可以将本地的文件上传至工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)中。完成文件上传后,可在调用数据实例的创建/更新接口时,将文件与该数据实例进行关联,从而实现对象化管理文件。

“upload_uploadFile”接口最大支持上传100M文件。如需上传大于100M的文件,请使用分块上传的接口。

本文仅指导您如何通过API方式上传简单文件。关于如何创建/更新数据实例的接口请参见全量数据服务

URI

  • URI格式:

    POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/upload/uploadFile

  • 参数说明:
    表1 URI参数说明

    参数

    是否必填

    参数类型

    描述

    Endpoint

    String

    承载REST服务端点的服务器域名或IP地址。

    appID

    String

    应用ID。

    modelNumber

    String

    数据模型的编码。

    modelName

    String

    数据模型的英文名称。

    dataType

    String

    数据模型的类型。

    • entity:数据实体
    • relation:关系实体

    attributeName

    String

    数据模型的属性英文名称。

    applicationId

    String

    应用ID。

    username

    String

    用户名。

    storageType

    Integer

    文件的存储类型。

    • 0:对象存储
    • 1:BLOB

    instanceId

    String

    数据实例的唯一编码。

    exaAttr

    String

    是否为扩展属性。

    • 0:非扩展属性
    • 1:扩展属性

    encrypted

    Boolean

    是否加密。当“storageType”设置为“0”时,需要设置此参数。

    • true:加密
    • false:不加密

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户的token。

表3 请求Body参数

参数

是否必选

参数类型

描述

files

MultipartFile[]

需要上传的文件列表。

file

MultipartFile

需要上传的文件。

响应参数

表4 响应Body参数

参数

参数类型

描述

result

String

调用是否成功。

  • SUCCESS:成功
  • FAIL:失败

data

List

调用的返回结果。

errors

List

异常信息列表。

请求示例

POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/upload/uploadFile?applicationId=e22c66fb1d05453fa33162772e3cc9c0&attributeName=LargeFiles&dataType=entity&encrypted=false&exaAttr=1&modelName=Industrial_File&modelNumber=DM00127283&storageType=0&username=XDM_User
X-Auth-Token: ABCDEFJ.... 

[MultipartFile Form files]

响应示例

{
    "result": "SUCCESS",
    "data": [
        "563740223079452672"
    ],
    "errors": []
}

相关文档