文件、图片字段上传
POST /v1/fileField/attachments
此接口用于上传文件字段附件,支持一次上传多个文件,请求体采用 multipart/form-data 类型. 目前支持:pdf、doc(docx)、xls(xlsx)、ppt(pptx)、png、jpg、jpeg 和 gif 格式文件.
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dataId | 整型 | 是 | 记录 ID. |
| objectApiName | 字符串 | 是 | 记录对象api名称. |
| fieldApiName | 字符串 | 是 | 字段ApiName名称. |
响应数据
| 属性名 | 类型 | 说明 |
|---|---|---|
| code | 整型 | 响应编码. |
| message | 字符串 | 响应消息. |
| visible | 布尔型 | 是否可见, true / false . |
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/fileField/attachments?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=1234&objectApiName=customApi&fieldApiName=description' -i -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F 'file=helloWorld.pdf'
响应示例
{
"code" : 200,
"message" : "OK",
"visible" : false
}
查询文件、图片字段上传的附件列表
GET /v1/fileField/attachments
此接口查询文件、图片字段已上传的附件列表
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dataId | 整型 | 是 | 记录 ID. |
| objectApiName | 字符串 | 是 | 记录对象api名称. |
| fieldApiName | 字符串 | 是 | 字段ApiName名称. |
响应数据
| 属性名 | 类型 | 说明 |
|---|---|---|
| code | 整型 | 响应编码. |
| message | 字符串 | 响应消息. |
| visible | 布尔型 | 是否可见, true / false . |
| data | 数组 | 业务对象. |
| data[].docId | 字符串 | 附件ID标识. |
| data[].name | 字符串 | 附件文件名. |
| data[].size | 字符串 | 附件大小. |
| data[].downloadAddress | 字符串 | 下载地址. |
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/fileField/attachments?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=1234&objectApiName=customApi&fieldApiName=description' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
"code" : 200,
"message" : "OK",
"visible" : false
"data" : [ {
"docId" : "4f6adc8e1866f7dba9cd722c03b78d72",
"name" : "helloWorld.pdf",
"size" : 11
"downloadAddress" : "http://www.udesk.cn"
} ]
}
文件、图片字段删除附件
PUT /v1/fileField/attachments/remove
此接口用于删除文件、图片字段记录附件,支持一次删除该字段下多个文件。
请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| dataId | 整型 | 是 | 记录 ID. |
| objectApiName | 字符串 | 是 | 记录对象api名称. |
| fieldApiName | 字符串 | 是 | 字段ApiName名称. |
| isClear | 整型 | 是 | 是否清空，0 否 1 是. |
| docIds | 字符串数组 | 否 | 要删除的 docId 数组,如果 isClear 为 0 时数组里面必须有元素. |
响应数据
| 属性名 | 类型 | 说明 |
|---|---|---|
| code | 整型 | 响应编码. |
| message | 字符串 | 响应消息. |
| visible | 布尔型 | 是否可见, true / false . |
请求示例
$ curl 'https://s-case3.udesk.cn/api/v1/fileField/attachments/remove?email=admin@udesk.cn×tamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=201516&objectApiName=jiandanshangpin&fieldApiName=tupian&isClear=0&docIds=269eeeb278b68dcf873fc2ac540e9e3c&docIds=5d8cd5de781265c628383955d4f38f7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
"code" : 200,
"message" : "OK",
"visible" : false
}