获取工单详情
服务描述
本接口可获取工单详情。
开发须知
调用本接口前，请先获取appId
服务地址
GET https://{您的专属域名}/workorder/openapi/v1/order/{orderId}
请求参数
| 参数 |
位置 |
类型 |
是否必填 |
说明 |
| appId |
header |
String |
Y |
应用ID |
| timestamp |
header |
String |
Y |
时间戳，毫秒 |
| sign |
header |
String |
Y |
签名 |
| Content-Type |
header |
String |
Y |
application/json |
| orderId |
path |
string |
N |
工单ID |
请求数据示例：
GET https://{您的专属域名}/workorder/openapi/v1/order/200001000001
返回结果
WorkOrderDetailVo
WorkOrderBaseVo
| 参数 |
类型 |
说明 |
| attachmentVos |
AttachmentVo array |
附件信息 |
| blacklistStatus |
integer |
黑名单状态：0-否，1-是 |
| channelId |
string |
渠道ID |
| channelName |
string |
来源渠道 |
| channelType |
string |
来源渠道类型 |
| closeTime |
string (date-time) |
关闭时间 （单位：毫秒） |
| createOpGroupId |
string |
创建人组织ID |
| createOpGroupName |
string |
创建人组织名称 |
| createOpId |
long |
创建人ID |
| createOpName |
string |
创建人名称 |
| createTime |
string (date-time) |
创建时间 （单位：毫秒） |
| customerGroupId |
string |
客户组织ID |
| customerGroupName |
string |
客户组织名称 |
| customerId |
string |
客户ID |
| customerName |
string |
客户名称 |
| deadlineTime |
string (date-time) |
要求完成时间 （单位：毫秒） |
| deleteTime |
string (date-time) |
删除时间 （单位：毫秒） |
| endpointType |
integer |
来源系统:1-C端,2-B端 |
| firstResolvedTime |
string (date-time) |
首次解决时间 （单位：毫秒） |
| formId |
string |
表单ID |
| isDeleted |
integer |
是否删除：0-未删除，1-删除 |
| lastReplyTime |
string (date-time) |
最后回复时间 （单位：毫秒） |
| orderDesc |
string |
工单描述 |
| orderFlag |
integer |
是否我的星标：1-是,0-否 |
| orderId |
string |
工单ID |
| orderName |
string |
工单标题 |
| orderStatus |
integer |
工单状态：1-草稿，2-待办，3-进行中，4-已解决，5-已关闭 |
| priority |
integer |
优先级:1-低,2-正常,3-高,4-紧急 |
| processId |
string |
工单类型ID |
| processName |
string |
工单类型名称 |
| resolvedTime |
string (date-time) |
解决时间 （单位：毫秒） |
| tags |
string |
标签，如 ["标签1","标签2"] |
| updateTime |
string (date-time) |
更新时间（单位：毫秒） |
AttachmentVo
| 参数 |
类型 |
说明 |
| extName |
string |
扩展名 |
| filePath |
string |
原文件路径(groupName,fileName) |
| fileSize |
long |
原图大小,单位:byte |
| mediumFilePath |
string |
中图(groupName,fileName) |
| realName |
string |
附件名称 |
| thumbnailFilePath |
string |
小图(groupName,fileName) |
| type |
integer |
类型：1-图片；2-一般文件 |
WoOrderOperateVo
| 参数 |
类型 |
说明 |
| groupId |
string |
组ID |
| groupName |
string |
组名称 |
| operType |
integer |
操作类型：0-处理人,1-处理组,2-抄送人,3-抄送组 |
| userId |
long |
用户ID |
| userName |
string |
用户名称 |
WorkOrderExtVo
| 参数 |
类型 |
说明 |
| createTime |
string (date-time) |
创建时间 （单位：毫秒） |
| deleteTime |
string (date-time) |
删除时间 （单位：毫秒） |
| extendsData |
WoFieldItemExtendsDataDto |
扩展数据 |
| fieldItemType |
integer |
工单字段类型,0:系统字段,1:自定义字段 |
| isDeleted |
integer |
是否删除：0-未删除，1-删除 |
| itemCode |
string |
字段编码 |
| itemDesc |
string |
描述 |
| itemId |
string |
动态字段ID |
| itemStatus |
integer |
状态,0:开启,1:禁用 |
| itemType |
integer |
字段类型,0:文本,1:多行文本,2:多选下拉框,3:单选下拉框,4:复选框,5:单选框,6:数值,7:百分比,8:仅日期,9:日期和时间,10:附件 |
| itemValue |
string |
字段值 |
| memo |
string |
字段说明 |
| orderId |
string |
工单ID |
| permission |
integer |
权限,0:租户编辑,1:用户编辑,2:用户只读 |
| priority |
integer |
字段说明 |
| tenantItemName |
string |
租户显示字段名称 |
| tenantResolvedRequired |
integer |
租户解决工单时必填,0:必填,1:非必填 |
| updateTime |
string (date-time) |
更新时间（单位：毫秒） |
| userCommitRequired |
integer |
客户提交工单时必填,0-必填,1-非必填 |
| userItemName |
string |
客户显示字段名称 |
WoFieldItemExtendsDataDto
| 参数 |
类型 |
说明 |
| decimalPoint |
integer |
小数点位数，itemType=6,7时填写 |
| options |
ExtendsDataOptionsDto array |
备选值, itemType=2,3,4,5时填写 |
ExtendsDataOptionsDto
| 参数 |
类型 |
说明 |
| key |
object |
|
| value |
object |
返回结果示例：
{
"code" : "10000",
"data" : {
"baseInfo" : {
"attachmentVos" : [ {
"extName" : "string",
"filePath" : "string",
"fileSize" : 0,
"mediumFilePath" : "string",
"realName" : "string",
"thumbnailFilePath" : "string",
"type" : 0
} ],
"blacklistStatus" : 0,
"channelId" : "string",
"channelName" : "string",
"channelType" : "string",
"closeTime" : "string",
"createOpGroupId" : "string",
"createOpGroupName" : "string",
"createOpId" : 0,
"createOpName" : "string",
"createTime" : "string",
"customerGroupId" : "string",
"customerGroupName" : "string",
"customerId" : "string",
"customerName" : "string",
"deadlineTime" : "string",
"deleteTime" : "string",
"endpointType" : 0,
"firstResolvedTime" : "string",
"formId" : "string",
"isDeleted" : 0,
"lastReplyTime" : "string",
"orderDesc" : "string",
"orderFlag" : 0,
"orderId" : "string",
"orderName" : "string",
"orderStatus" : 0,
"priority" : 0,
"processId" : "string",
"processName" : "string",
"resolvedTime" : "string",
"tags" : "string",
"updateTime" : "string"
},
"ccOpertor" : [ {
"groupId" : "string",
"groupName" : "string",
"operType" : 0,
"userId" : 0,
"userName" : "string"
} ],
"dealOpertor" : [ {
"groupId" : "string",
"groupName" : "string",
"operType" : 0,
"userId" : 0,
"userName" : "string"
} ],
"extendForms" : [ {
"createTime" : "string",
"deleteTime" : "string",
"extendsData" : {
"decimalPoint" : 0,
"options" : [ {
"key" : "object",
"value" : "object"
} ]
},
"fieldItemType" : 0,
"isDeleted" : 0,
"itemCode" : "string",
"itemDesc" : "string",
"itemId" : "string",
"itemStatus" : 0,
"itemType" : 0,
"itemValue" : "string",
"memo" : "string",
"orderId" : "string",
"permission" : 0,
"priority" : 0,
"tenantItemName" : "string",
"tenantResolvedRequired" : 0,
"updateTime" : "string",
"userCommitRequired" : 0,
"userItemName" : "string"
} ],
"extendInfos" : [ {
"createTime" : "string",
"deleteTime" : "string",
"extendsData" : {
"decimalPoint" : 0,
"options" : [ {
"key" : "object",
"value" : "object"
} ]
},
"fieldItemType" : 0,
"isDeleted" : 0,
"itemCode" : "string",
"itemDesc" : "string",
"itemId" : "string",
"itemStatus" : 0,
"itemType" : 0,
"itemValue" : "string",
"memo" : "string",
"orderId" : "string",
"permission" : 0,
"priority" : 0,
"tenantItemName" : "string",
"tenantResolvedRequired" : 0,
"updateTime" : "string",
"userCommitRequired" : 0,
"userItemName" : "string"
} ]
},
"message" : "请求成功"
}
结果码说明
| 结果码 |
说明 |
| 10000 |
请求成功 |
| 20001 |
请求失败 |
| 21002 |
认证失败,请重新登录 |
FAQ: