智简魔方文档

GET 工单详情

接口概览

项目内容
文档类型后台接口
请求方式GET
接口地址/DIR_ADMIN/v1/ticket/{id}
所属业务插件
来源模块/系统工单
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

工单详情

请求参数

名称位置类型必选说明
idpathinteger(int32)是工单 ID

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束说明
statusinteger(int32)否—状态码
msgstring否—提示信息
dataobject否——
data.ticketobject否—工单详情
data.ticket.idinteger(int32)否—工单 ID
data.ticket.client_idinteger(int32) | string否—用户 ID
data.ticket.titlestring否—工单标题
data.ticket.prioritystring否—内容
data.ticket.ticket_type_idinteger(int32)否—类型 ID
data.ticket.statusstring否—状态:Pending待接受,Handling处理中,Reply待回复,Replied已回复,Resolved已解决,Closed已关闭
data.ticket.create_timeinteger(int32)否—创建时间
data.ticket.attachment[string]否—工单附件,数组,返回所有附件
data.ticket.last_reply_timeinteger(int32)否—工单最后回复时间
data.ticket.usernamestring否—用户名
data.ticket.host_ids[integer]否—关联产品 ID,数组
data.ticket.can_operateinteger(int32)否—是否可操作
data.ticket.upstream_ticket_idinteger(int32)¦null否—上游工单 ID
data.ticket.delivery_statusinteger(int32)¦null否—传递状态:1已开启传递,0已关闭传递
data.ticket.delivery_operateinteger(int32)否—传递操作:0不显示按钮,1发起传递,2开启传递,3终止传递
data.ticket.replies[object]否—沟通记录,数组
data.ticket.replies[].idinteger(int32)否—回复 ID,注意:有一个回复 ID为0,是工单内容默认填充,这里不能修改
data.ticket.replies[].contentstring否—内容
data.ticket.replies[].attachment[string]否—附件访问地址,数组
data.ticket.replies[].create_timeinteger(int32)否—时间
data.ticket.replies[].typestring否—类型:Client用户回复,Admin管理员回复
data.ticket.replies[].client_namestring否—用户名,type==Client时用此值
data.ticket.replies[].admin_namestring否—管理员名,type==Admin时用此值
data.ticket.replies[].quote_reply_idinteger(int32)否—引用的回复 ID,0表示未引用
data.ticket.replies[].quote_infoobject¦null否—引用的回复信息,未引用时为null
data.ticket.replies[].quote_info.idinteger(int32)否—被引用回复 ID
data.ticket.replies[].quote_info.contentstring否—被引用内容(截取前100字)
data.ticket.replies[].quote_info.typestring否—类型:Client/Admin
data.ticket.replies[].quote_info.sender_namestring否—发送者名称
data.ticket.replies[].quote_info.create_timeinteger(int32)否—发送时间
data.ticket.replies[].quote_info.is_deletedinteger(int32)否—该回复是否已被删除:1是,0否
data.ticket.replies[].client_idstring否——
data.ticket.forwards[object]否——
data.ticket.forwards[].nicknamestring否—管理员名
data.ticket.forwards[].forward_nicknamestring否—转入理员名
data.ticket.forwards[].notesstring否—备注
data.ticket.forwards[].ticket_type_namestring否—转入部门名
data.ticket.forwards[].create_timeinteger(int32)否—时间
data.ticket.ticket_numstring否——
data.ticket.contentstring否——
data.ticket.colorstring否——
data.ticket.post_admin_idstring否——
data.ticket.admin_namestring否——
data.ticket.upstream_host_idnull否——
data.ticket.downstream_deliveryinteger(int64)否——

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束说明
statusinteger(int32)是—错误状态码
msgstring是—错误提示