文档首页/ 工单管理/ API参考/ API v2（推荐）/ 附件功能/ 上传附件
更新时间：2023-12-18 GMT+08:00
查看PDF
分享

上传附件

功能介绍

上传附件接口，使用form-data，上传附件需要满足"附件限制"返回的关于大小等限制

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/servicerequest/accessorys

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：1

最大长度：5000

X-Language

否

String

语言环境，值为通用的语言描述字符串，比如zh-cn等，默认为zh-cn。

会根据语言环境对应展示一些国际化的信息，比如工单类型名称等。

最小长度：1

最大长度：32

X-Time-Zone

否

String

环境时区，值为通用的时区描述字符串，比如GMT+8等，默认为GMT+8。

涉及时间的数据会根据环境时区处理。

最小长度：1

最大长度：32
表2 FormData参数

参数

是否必选

参数类型

描述

file

是

File

文件内容

form_data

是

String

附件的一些信息，比如来源，文件名称，格式要求为json字符串{"fileName":"test.jpg","accessoryFrom":"incident"}

最小长度：1

最大长度：5000

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

accessory_id

String

附件id

最小长度：1

最大长度：64

请求示例

POST https://{endpoint}/v2/servicerequest/accessorys

{
  "form_data" : "{/'accessFrom/':/'message/'}",
  "file" : "file"
}

响应示例

状态码： 200

上传成功，返回附件的id

{
  "accessory_id" : "123456"
}

状态码

状态码

描述

200

上传成功，返回附件的id

错误码

请参见错误码。

父主题： 附件功能