BIMFACE服务器端API接口

源文件相关

在注册成为BIMFACE的应用开发者后,要能在浏览器里浏览你的模型或者获取你模型内的BIM数据, 首先需要把你的模型文件上传到BIMFACE。根据不同场景,BIMFACE提供了丰富的文件相关的接口。

文件相关所有接口都需要提供有效的Access Token。不支持View Token。

源文件上传

普通文件流上传

PUT https://file.bimface.com/upload
说明

使用普通文件流上传,不支持表单方式; 文件流需要在request body中传递

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Header

Content-Type
必填

取值:application/octet-stream

string

Header

Content-Length
必填

数据流文件长度

integer (int64)

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload?name=3F.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
"Content-Length: 11672"
请求体
你需要上传的文件流
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

指定外部文件url方式上传

PUT https://file.bimface.com/upload
说明

如果需要上传的文件不在本地,且该文件可以通过指定的HTTP URL可以下载,BIMFACE支持直接传一个外部的HTTP文件URL, BIMFACE会去下载该文件,而无须用户先下载,再上传。

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

etag
可选

文件etag

string

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

Query

url
必填

文件所在url

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload?name=example.rvt&url=http(s)://xxxxxxxxxxx
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

文件直传

BIMFACE使用了分布式对象存储来存储用户上传的模型/图纸文件。如使用普通的文件上传接口, 文件流会通过BIMFACE的服务器,再流向最终的分布式存储系统,整个上传过程会受BIMFACE服务器的带宽限制,上传速度非最优。 如使用文件直传接口,开发者应用在申请到一个Policy凭证后,可以直接上传文件跟BIMFACE后台的分布式存储系统, 这样上传速度和稳定性都会有提升,是我们推荐的上传方式。

另外,很多BIMFACE应用都有自己的Web前端页面,这种情况我们也推荐使用文件直传接口。

文件直传的逻辑图如下:

web policy upload
使用流程如下:
  1. 开发者应用向BIMFACE申请上传Policy请求;

  2. BIMFACE返回上传Policy和签名给开发者应用;

  3. 开发者应用使用在第二个步骤中获取的URL信息,直接上传文件数据到BIMFACE后端的分布式对象存储。

获取文件直传的policy凭证

GET https://file.bimface.com/upload/policy
参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/upload/policy?name=example.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "accessId" : "QLYNXu7B9OTjErYR",
    "callbackBody" : "eyJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkIiwiY2FsbGJhY2tIb3N0IjoiZmlsZS5iaW1mYWNlLmNvbSIsImNhbGxiYWNrVXJsIjoiaHR0cHM6Ly8xMTYuMjI4LjE5NS4xOC9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrQm9keSI6Im9iamVjdD0ke29iamVjdH0mc2l6ZT0ke3NpemV9JmV0YWc9JHtldGFnfSZuYW1lPXRlc3QucGRmJmZpbGVJZD0xNDgzMDY1NTc0NzU0NTI4JmFwcGtleT1hRGxQZjEzVXRpR3M3eXVIQ2Q4ZUhTTEhiSEpUVThTZCZzb3VyY2VJZD0mZmlsZUJ1Y2tldD1iZi1kZXYtc3JjZmlsZSJ9",
    "expire" : 1542792319,
    "host" : "https://bf-dev-srcfile.oss-cn-shanghai.aliyuncs.com",
    "objectKey" : "2f15df1c430b4ad3b0644029111b703a",
    "policy" : "eyJleHBpcmF0aW9uIjoiMjAxOC0xMS0yMVQwOToyNToxOS45OTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXV19",
    "signature" : "q4NrZ1By/msuHOHlgpgX56mMUhY=",
    "sourceId" : "a3da94969c054b3795cef542a6fb7bd6"
  },
  "message" : ""
}

根据policy凭证在web端上传文件

通过接口“https://file.bimface.com/upload/policy”获取文件直传的policy凭证后,可以直接在前端使用表单上传方式将文件上传到BIMFACE的对象存储上。

BIMFACE 控制台就是通过这种方式来实现文件上传的,可以F12→network查看请求详情。

以获取到的policy凭证为以下数据示例:

{
    "code": "success",
    "message": null,
    "data": {
        "host": "https://bf-prod-srcfile.oss-cn-beijing.aliyuncs.com",
        "policy": "eyJleHBpcmF0aW9uIjoiMjAxOS0wOC0xNVQwNjowOTozMC41NTFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA3Mzc0MTgyNF0seyJzdWNjZXNzX2FjdGlvbl9zdGF0dXMiOiIyMDAifSxbInN0YXJ0cy13aXRoIiwiJGtleSIsIiJdXX0=",
        "accessId": "5nGlEwOIzrwCVaDZ",
        "signature": "QGMtcEzm2KrVg7cr266CVMc9syM=",
        "expire": 1565849370,
        "callbackBody": "eyJjYWxsYmFja1VybCI6Imh0dHBzOi8vZmlsZS5iaW1mYWNlLmNvbS9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrSG9zdCI6ImZpbGUuYmltZmFjZS5jb20iLCJjYWxsYmFja0JvZHkiOiJvYmplY3RcdTAwM2Qke29iamVjdH1cdTAwMjZzaXplXHUwMDNkJHtzaXplfVx1MDAyNmV0YWdcdTAwM2Qke2V0YWd9XHUwMDI2bmFtZVx1MDAzZHVwbG9hZFRlc3RfMjAxOTA1MTYucnZ0XHUwMDI2ZmlsZUlkXHUwMDNkMTY3MTk0ODkzMjkwODQ0OFx1MDAyNmFwcGtleVx1MDAzZHJPNzdrQXd1V3BXajZTMlRMVzdmSDJSS1NOWWNBcmxFXHUwMDI2c291cmNlSWRcdTAwM2RcdTAwMjZmaWxlQnVja2V0XHUwMDNkYmYtcHJvZC1zcmNmaWxlIiwiY2FsbGJhY2tCb2R5VHlwZSI6ImFwcGxpY2F0aW9uL3gtd3d3LWZvcm0tdXJsZW5jb2RlZCJ9",
        "objectKey": "af20e3d3a0e44377b2260129a5e90402",
        "sourceId": null
    }
}

通过表单方式上传时,请求的构造方式为:

名称 对应值

请求url

返回体中的host

name

请求体中的name

key

返回体中的objectKey

policy

返回体中的policy

OSSAccessKeyId

返回体中的accessId

callback

返回体中的callbackBody

signature

返回体中的signature

success_action_status

200

file

需要上传文件的binary数据流

请求示例
web policy request
POST / HTTP/1.1
Host: bf-prod-srcfile.oss-cn-beijing.aliyuncs.com
User-Agent: PostmanRuntime/7.15.2
Accept: */*
Postman-Token: 0c31cbde-ee57-4528-be60-7468bddf49b1,d7fb57d1-9df2-439a-bfe2-c6081365c21f
Host: bf-prod-srcfile.oss-cn-beijing.aliyuncs.com
Accept-Encoding: gzip, deflate
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Length: 5125934
Connection: keep-alive

Content-Disposition: form-data; name="name"
uploadTest_20190516.rvt
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="key"
af20e3d3a0e44377b2260129a5e90402
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="policy"
eyJleHBpcmF0aW9uIjoiMjAxOS0wOC0xNVQwNjowOTozMC41NTFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA3Mzc0MTgyNF0seyJzdWNjZXNzX2FjdGlvbl9zdGF0dXMiOiIyMDAifSxbInN0YXJ0cy13aXRoIiwiJGtleSIsIiJdXX0=
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="OSSAccessKeyId"
5nGlEwOIzrwCVaDZ
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="success_action_status"
200
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="callback"
eyJjYWxsYmFja1VybCI6Imh0dHBzOi8vZmlsZS5iaW1mYWNlLmNvbS9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrSG9zdCI6ImZpbGUuYmltZmFjZS5jb20iLCJjYWxsYmFja0JvZHkiOiJvYmplY3RcdTAwM2Qke29iamVjdH1cdTAwMjZzaXplXHUwMDNkJHtzaXplfVx1MDAyNmV0YWdcdTAwM2Qke2V0YWd9XHUwMDI2bmFtZVx1MDAzZHVwbG9hZFRlc3RfMjAxOTA1MTYucnZ0XHUwMDI2ZmlsZUlkXHUwMDNkMTY3MTk0ODkzMjkwODQ0OFx1MDAyNmFwcGtleVx1MDAzZHJPNzdrQXd1V3BXajZTMlRMVzdmSDJSS1NOWWNBcmxFXHUwMDI2c291cmNlSWRcdTAwM2RcdTAwMjZmaWxlQnVja2V0XHUwMDNkYmYtcHJvZC1zcmNmaWxlIiwiY2FsbGJhY2tCb2R5VHlwZSI6ImFwcGxpY2F0aW9uL3gtd3d3LWZvcm0tdXJsZW5jb2RlZCJ9
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="signature"
QGMtcEzm2KrVg7cr266CVMc9syM=
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Content-Disposition: form-data; name="file";
filename="/C:/Users/jianqq/Downloads/b (1).rvt
------WebKitFormBoundary7MA4YWxkTrZu0gW--
HTTP响应示例
响应 200
{
    "code": "success",
    "message": null,
    "data": {
        "fileId": 1671948932908448,
        "name": "uploadTest_20190516.rvt",
        "status": "success",
        "etag": "85BECD325859F9F715F9FE9E4C3FBD04",
        "suffix": "rvt",
        "length": 5124105,
        "createTime": "2019-08-15 14:06:21"
    }
}

断点续传

当文件比较大,或者所在网络网速较慢的情况下,单个文件上传的时间会比较长。如果中间有任何的网络错误, 本次上传就会被中断,那么文件就会需要重新上传,非常浪费时间。

为解决这个问题,BIMFACE提供了断点上传的接口,开发者可以利用这些接口对文件进行上传,即使上传过程种出现错误, 下一次也可以从上次错误的文件位置开始继续上传。

使用流程如下:
  1. 发送请求,申请创建一个追加文件,并记录该追加文件ID;

  2. 每次上传前,使用该文件ID查询当前上传到的具体位置信息;

  3. 本地文件读取定位到在2)里获取的位置,调用追加上传接口,继续上传文件。

创建追加文件

POST https://file.bimface.com/appendFiles
说明

进行断点续传前,先创建追加文件

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

length
必填

上传文件长度

integer (int64)

Query

name
必填

文件的全名,使用URL编码(UTF-8),最多256个字符

string

Query

sourceId
可选

调用方的文件源ID,不能重复

string

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles?length=5353522&name=A4.rvt
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

查询追加文件信息

GET https://file.bimface.com/appendFiles/{appendFileId}
说明

根据appendFileId查询追加文件信息

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

appendFileId
必填

追加文件id

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles/1216113551663296
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

追加文件信息

POST https://file.bimface.com/appendFiles/{appendFileId}/data
说明

根据创建的追加文件信息进行追加上传;文件流需要在request body中传递

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

bearer {accessToken}

string

Path

appendFileId
必填

追加文件id

integer (int64)

Query

position
可选

追加上传开始位置

integer (int64)

0

响应
HTTP代码 说明 类型

200

OK

201

Created

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

消耗
  • application/json

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/appendFiles/123456789/data
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
请求体
你需要上传的文件流
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "appendFileId" : 1216113551663296,
    "createTime" : "2017-11-09 13:25:03",
    "file" : {
      "createTime" : "2017-11-09 13:25:03",
      "etag" : "19349858cjs98ericu989",
      "fileId" : 1216113551663296,
      "length" : 39044,
      "name" : "-1F.rvt",
      "status" : "success",
      "suffix" : "rvt"
    },
    "length" : 39044,
    "name" : "-1F.rvt",
    "position" : 0,
    "status" : "success"
  },
  "message" : ""
}

源文件信息获取

获取文件信息

GET https://file.bimface.com/files/{fileId}
说明

根据文件ID获取文件详细信息

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/files/1419273043501216
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  },
  "message" : ""
}

获取文件信息列表

GET https://file.bimface.com/files
说明

根据多种查询条件获取文件详细信息列表,支持分页

参数
类型 名称 说明 类型 默认值

Header

Authorization
必填

bearer {accessToken}

string

Query

endTime
可选

截止日期,格式为 yyyy-MM-dd

string

Query

offset
可选

查询结果偏移,从查询结果的第offset条开始返回数据

integer (int64)

Query

rows
可选

查询结果数, 默认为100, 最大500

integer (int64)

100

Query

startTime
可选

起始日期,格式为 yyyy-MM-dd

string

Query

status
可选

文件状态,uploading,success,failure

string

Query

suffix
可选

文件后缀

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/files
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : [ {
    "createTime" : "2017-11-09 13:25:03",
    "etag" : "19349858cjs98ericu989",
    "fileId" : 1216113551663296,
    "length" : 39044,
    "name" : "-1F.rvt",
    "status" : "success",
    "suffix" : "rvt"
  } ],
  "message" : ""
}

获取文件上传状态信息

GET https://file.bimface.com/files/{fileId}/uploadStatus
说明

根据文件ID获取文件上传状态信息

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Path

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/files/1419273043501216/uploadStatus
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "failedReason" : "input.stream.read.error",
    "fileId" : 1216113551663296,
    "name" : "-1F.rvt",
    "status" : "failure"
  },
  "message" : ""
}

应用支持的文件类型

GET https://file.bimface.com/support
说明

获取当前应用支持转换的文件类型,如上传的文件格式不在列表里,BIMFACE不支持对其发起转换。

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/support
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : {
    "length" : 1073741824,
    "types" : [ "rvt", "rfa", "dwg", "dxf", "skp", "ifc", "dgn", "obj", "stl", "3ds", "dae", "ply", "igms", "zip", "gtj", "bfcatzip" ]
  },
  "message" : ""
}

源文件下载

获取文件下载链接

GET https://file.bimface.com/download/url
说明

应用通过该接口获取文件的下载地址,然后下载文件。下载地址有效时间是5分钟

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

fileId
必填

文件ID

integer (int64)

Query

name
可选

文件名

string

响应
HTTP代码 说明 类型

200

OK

401

Unauthorized

无内容

403

Forbidden

无内容

404

Not Found

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/download/url?fileId=1419273043501216
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "data",
  "message" : ""
}

源文件删除

删除文件

DELETE https://file.bimface.com/file
说明

根据文件ID删除文件

参数
类型 名称 说明 类型

Header

Authorization
必填

bearer {accessToken}

string

Query

fileId
必填

文件ID

integer (int64)

响应
HTTP代码 说明 类型

200

OK

204

No Content

无内容

401

Unauthorized

无内容

403

Forbidden

无内容

生成
  • */*

  • application/json

HTTP请求示例
请求 path
https://file.bimface.com/file?fileId=1418750515413120
请求 header
"Authorization: Bearer dc671840-bacc-4dc5-a134-97c1918d664b"
HTTP响应示例
响应 200
{
  "code" : "success",
  "data" : "object",
  "message" : ""
}

数据实体类

AppendFileBean

名称 说明 类型

appendFileId
可选

样例 : 1216113551663296

integer (int64)

createTime
可选

样例 : "2017-11-09 13:25:03"

string

file
可选

样例 : FileBean

length
可选

样例 : 39044

integer (int64)

name
可选

样例 : "-1F.rvt"

string

position
可选

样例 : 0

integer (int64)

status
可选

样例 : "success"

string

FileBean

名称 说明 类型

createTime
可选

样例 : "2017-11-09 13:25:03"

string

etag
可选

样例 : "19349858cjs98ericu989"

string

fileId
可选

样例 : 1216113551663296

integer (int64)

length
可选

样例 : 39044

integer (int64)

name
可选

样例 : "-1F.rvt"

string

status
可选

样例 : "success"

string

suffix
可选

样例 : "rvt"

string

FileUploadStatusBean

名称 说明 类型

failedReason
可选

样例 : "input.stream.read.error"

string

fileId
可选

样例 : 1216113551663296

integer (int64)

name
可选

样例 : "-1F.rvt"

string

status
可选

样例 : "failure"

string

GeneralResponse

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "object"

object

message
可选

样例 : ""

string

GeneralResponse«AppendFileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : AppendFileBean

message
可选

样例 : ""

string

GeneralResponse«FileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : FileBean

message
可选

样例 : ""

string

GeneralResponse«FileUploadStatusBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

message
可选

样例 : ""

string

GeneralResponse«List«FileBean»»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : [ "FileBean" ]

< FileBean > array

message
可选

样例 : ""

string

GeneralResponse«SupportFileBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : SupportFileBean

message
可选

样例 : ""

string

GeneralResponse«UploadPolicyBean»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : UploadPolicyBean

message
可选

样例 : ""

string

GeneralResponse«string»

名称 说明 类型

code
可选

样例 : "success"

string

data
可选

样例 : "data"

string

message
可选

样例 : ""

string

SupportFileBean

名称 说明 类型

length
可选

样例 : 1073741824

integer (int64)

types
可选

样例 : [ "rvt", "rfa", "dwg", "dxf", "skp", "ifc", "dgn", "obj", "stl", "3ds", "dae", "ply", "igms", "zip", "gtj", "bfcatzip" ]

< object > array

UploadPolicyBean

名称 说明 类型

accessId
可选

样例 : "QLYNXu7B9OTjErYR"

string

callbackBody
可选

样例 : "eyJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkIiwiY2FsbGJhY2tIb3N0IjoiZmlsZS5iaW1mYWNlLmNvbSIsImNhbGxiYWNrVXJsIjoiaHR0cHM6Ly8xMTYuMjI4LjE5NS4xOC9vc3MvcmVjZWl2ZSIsImNhbGxiYWNrQm9keSI6Im9iamVjdD0ke29iamVjdH0mc2l6ZT0ke3NpemV9JmV0YWc9JHtldGFnfSZuYW1lPXRlc3QucGRmJmZpbGVJZD0xNDgzMDY1NTc0NzU0NTI4JmFwcGtleT1hRGxQZjEzVXRpR3M3eXVIQ2Q4ZUhTTEhiSEpUVThTZCZzb3VyY2VJZD0mZmlsZUJ1Y2tldD1iZi1kZXYtc3JjZmlsZSJ9"

string

expire
可选

样例 : 1542792319

integer (int64)

host
可选

样例 : "https://bf-dev-srcfile.oss-cn-shanghai.aliyuncs.com"

string

objectKey
可选

样例 : "2f15df1c430b4ad3b0644029111b703a"

string

policy
可选

样例 : "eyJleHBpcmF0aW9uIjoiMjAxOC0xMS0yMVQwOToyNToxOS45OTZaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTM2ODcwOTEyMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXV19"

string

signature
可选

样例 : "q4NrZ1By/msuHOHlgpgX56mMUhY="

string

sourceId
可选

样例 : "a3da94969c054b3795cef542a6fb7bd6"

string