版本 2.4.8 · 最新
工单图片 ticket-images
工单附图的上传与鉴权下载。
点击任一接口,右侧显示对应的调用示例。
工单鉴权: 用户2 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/ticket-images/{id}下载工单图片
鉴权: 用户(部分参数仅管理员)
工单图片对象
| 字段 | 类型 | 说明 |
|---|---|---|
id | integer | 图片 id;下载用 GET /ticket-images/{id}。 |
mime | string | 按文件头认出的类型。 |
name | string | 上传时的文件名。 |
size | integer | 字节数。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}