5. 接口-上传附件
1. 接口地址
接口请求域名:https://api.vika.cn
请求方法:POST
POST /datasheets/{datasheetId}/attachments
2. 接口描述
上传一个附件,并绑定到一张维格表。
每次请求只可上传 1 个附件。
上传完附件后,附件数据并不会直接插入到表中,需要再调用接口 「创建记录」 或 「更新记录」 将附件数据插入到某个类型为 “附件” 的字段中。
3. 输入参数说明
参数名称 | 数据类型 | 参数类型 | 说明 |
---|---|---|---|
datasheetId | String | Path | 维格表 ID |
Content-Type | String | Request Header | multipart/form-data |
4. 示例
示例1:上传一个附件,并绑定到维格表(ID为 dstWUHwzTHd2YQaXEE
)。
请求示例(cURL):
curl -X POST \
https://api.vika.cn/fusion/v1/datasheets/dstWUHwzTHd2YQaXEE/attachments \
-H 'Authorization: Bearer {你的 API Token}' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F '=@D:\temp\2020\09\熊猫\3.png'
返回示例:
正常情况下,维格表服务端会返回下述 JSON 数据包。
{
"code": 200,
"success": true,
"data": {
"token": "space/2020/09/23/eecd57292901446c8734af6d1cb4f501",
"mimeType": "image/gif",
"size": 42484,
"height": 240,
"width": 240,
"name": "3.gif",
"url": "https://s1.vika.cn/space/2020/09/23/eecd57292901446c8734af6d1cb4f501"
},
"message": "SUCCESS"
}
返回对象说明:
参数名称 | 数据类型 | 说明 |
---|---|---|
code | Int | 业务状态码,200 表示业务请求成功,其他状态码详见 《附录:状态码列表》 |
success | Boolean | 全局状态值,如果为 false ,则表示发生了业务错误或接口调用错误。 |
message | String | 返回信息,执行错误时返回错误信息。 |
data | Attachment Object | 返回的附件对象 |
- token | String | 附件的存储 token |
- mimeType | String | 附件的媒体类型 |
- size | Number | 附件的存储大小,单位:字节 |
- height | Number | 如果附件是图片,则存在此字段,表示图片的高度 |
- width | Number | 如果附件是图片,则存在此字段,表示图片的宽度 |
- name | String | 附件的名称 |
- preview | String | 只有附件会生成缩略图的情况下会存在此字段,表示缩略图的网络访问地址 |
- url | String | 附件的网络访问地址 |