- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
上传附件
功能介绍
上传附件，创建事件单的场景下，如需上传附件，需要先调用该接口将文件上传到obs。上传成功时，该接口将返回文档唯一id。支持文件类型：.jpg,.png,.docx,.txt,.pdf，且文本大小不超10M。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/external/incident/attachments
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file |
是 |
File |
参数解释： 需要上传的文件，以表单的形式上传。 约束限制： 内容为二进制binary文本。支持文件类型：.jpg,.png,.docx,.txt,.pdf，且文本大小不超10M。 取值范围： 不涉及 默认取值： 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
|
provider_code |
String |
参数解释： 服务编码。 取值范围： 不涉及 默认取值： 049 |
|
msg |
String |
参数解释： 请求响应描述。
取值范围： 不涉及 默认取值： 不涉及 |
|
data |
ExternalAttachment object |
上传成功后的附件信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
doc_id |
String |
参数解释： 附件唯一id。 取值范围： 不涉及 默认取值： 不涉及 |
|
doc_name |
String |
参数解释： 附件文件名。 取值范围： 不涉及 默认取值： 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
参数解释： 服务标识。 取值范围： 不涉及 默认取值： 049 |
|
error_code |
String |
参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
|
error_msg |
String |
参数解释： 请求响应描述。 取值范围： 不涉及 默认取值： 不涉及 |
请求示例
上传附件请求示例。
POST https://{Endpoint}/v1/external/incident/attachments
form-data表单：
key: file
value: binary二进制文件响应示例
状态码：200
请求成功。
更多状态码请参考状态码。
{
"error_code" : "GOM.00000000",
"error_msg" : null,
"provider_code" : "049",
"data" : {
"doc_id" : "78f86d47-55d6-4e98-ba51-b293ac95bc8a",
"doc_name" : "uploadFile.doc"
}
}状态码：400
服务器未能处理请求。
更多状态码请参考状态码。
{
"error_code" : "GOM.00007256",
"error_msg" : "参数错误",
"provider_code" : "049",
"data" : null
}错误码
请参见错误码。
