文档首页/ 云运维中心 COC/ API参考/ API/ 故障管理/ 问题单管理/ 获取工单历史记录
更新时间：2025-08-01 GMT+08:00
查看PDF
分享

获取工单历史记录

功能介绍

当前支持获取事件单或问题单的历史记录，工单类型通过ticket_type进行区分，事件单传值为incident，问题单传值为issues_mgmt。该接口需要指定要查询的工单单号，通过请求参数string_filters进行传递，详情见请求参数说明和请求示例。

调试

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

URI

POST /v1/{ticket_type}/list-histories

表1 路径参数

参数

是否必选

参数类型

描述

ticket_type

是

String

参数解释：

需要查询的工单类型，事件单传值incident，问题单传值issues_mgmt。

约束限制：

不涉及

取值范围：

枚举值

  • incident

  • issues_mgmt

默认取值：

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

string_filters

是

Array of ObjectFilter objects

参数解释：

字符串搜索条件，可根据该条件搜索到具体的工单。

约束限制：

数组长度：0 - 20

取值范围：

不涉及

默认取值：

不涉及

sort_filter

否

ObjectFilter object

参数解释：

查询到的历史记录排序条件，可根据操作记录的创建时间进行排序。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 ObjectFilter

参数

是否必选

参数类型

描述

operator

否

String

参数解释：

操作符包括in/like/desc/startwith/endwith/=/!=/>/<等。

约束限制：

当查询某一工单单号时，操作符为=，表示搜索特定工单。当对查询结果进行排序时，操作符为desc。

最小长度：0

最大长度：20

取值范围：

不涉及

默认取值：

不涉及

field

否

String

参数解释：

需要操作的字段名称。

约束限制：

当查询工单时，字段名称为ticket_id，当对查询结果根据创建时间排序过滤时，字段名称为start_time。

最小长度：0

最大长度：255

取值范围：

不涉及

默认取值：

不涉及

name

否

String

参数解释：

需要操作的条件名称。

约束限制：

当查询工单时，条件名称为ticket_id，当对查询结果根据创建时间排序过滤时，条件名称为start_time。

最小长度：0

最大长度：255

取值范围：

不涉及

默认取值：

不涉及

values

否

Array of objects

参数解释：

表示对某个filed进行某种操作时，需要满足的条件值。

约束限制：

当查询工单时，条件值为工单id，当对查询结果根据创建时间排序过滤时，条件值为start_time。

数组长度：0 - 1024

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

不涉及

默认取值：

049

error_code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

error_msg

String

参数解释：

请求响应描述。

取值范围：

不涉及

data

data object

参数解释：

请求成功后返回的数据。

取值范围：

不涉及
表5 data

参数

参数类型

描述

total

Long

参数解释：

操作记录的总条数。

取值范围：

不涉及

info

Array of TicketHistoryInfo objects

参数解释：

操作记录的详情。

取值范围：

不涉及
表6 TicketHistoryInfo

参数

参数类型

描述

action_id

String

参数解释：

操作标识。

取值范围：

不涉及

action

String

参数解释：

当前操作的action信息。

取值范围：

不涉及

sub_action

String

参数解释：

当前操作的子动作。

取值范围：

不涉及

operator

String

参数解释：

当前操作的操作人工号。

取值范围：

不涉及

comment

String

参数解释：

当前操作的评论信息，如操作审批或者驳回的场景下会添加评论信息。

取值范围：

不涉及

id

String

参数解释：

操作记录的主键ID。

取值范围：

不涉及

ticket_id

String

参数解释：

工单单号，数据库存储的工单唯一ID。

取值范围：

不涉及

start_time

Long

参数解释：

当前操作的起始时间，格式为13位时间戳。

取值范围：

不涉及

stop_time

Long

参数解释：

当前操作的结束时间，格式为13位时间戳。

取值范围：

不涉及

target_type

String

参数解释：

对象类型。

取值范围：

不涉及

target_value

String

参数解释：

对象值。

取值范围：

不涉及

is_deteted

Boolean

参数解释：

当前操作记录是否已被删除。

取值范围：

不涉及

update_time

Long

参数解释：

更新时间。

取值范围：

不涉及

action_name_zh

String

参数解释：

当前操作action中文名。

取值范围：

不涉及

action_name_en

String

参数解释：

当前操作action英文名。

取值范围：

不涉及

action_template_zh

String

参数解释：

当前操作action中文模板，当工单升降级时，该字段存储升降级详细信息。

取值范围：

不涉及

action_template_en

String

参数解释：

当前操作action英文模板，当工单升降级时，该字段存储升降级详细信息。

取值范围：

不涉及

status

String

参数解释：

当前操作对应的工单状态。

取值范围：

不涉及

final_sub_action

String

参数解释：

最终子动作。

取值范围：

不涉及

enum_data_list

Array of EnumDataInfo objects

参数解释：

枚举数据，操作人信息存储在枚举值内，match_type为reference__base_config.User的枚举值存储的是当前操作用户信息，其中name_zh为用户名称，biz_id为当前操作用户id。

取值范围：

不涉及
表7 EnumDataInfo

参数

参数类型

描述

is_deleted

Boolean

参数解释：

当前枚举值是否已被删除。

取值范围：

不涉及

match_type

String

参数解释：

匹配类型，当前主要关注match_type为reference__base_config.User，对应的name_zh为当前操作的用户名称。

取值范围：

不涉及

ticket_id

String

参数解释：

所属单号。

取值范围：

不涉及

real_ticket_id

String

参数解释：

所属真实单号。

取值范围：

不涉及

name_zh

String

参数解释：

枚举值对应的中文名。

取值范围：

不涉及

name_en

String

参数解释：

枚举值对应的英文名。

取值范围：

不涉及

user_name

String

参数解释：

操作人名称。

取值范围：

不涉及

biz_id

String

参数解释：

枚举值对应的唯一id，当match_type为reference__base_config.User时，biz_id的值为操作用户唯一Id。

取值范围：

不涉及

prop_id

String

参数解释：

当前枚举值对应的类型，操作人为operator。

取值范围：

不涉及

model_id

String

参数解释：

后台不同应用对应的模型id，历史记录对应的值为TicketHistoryInfo。

取值范围：

不涉及

状态码：400

表8 响应Body参数

参数

参数类型

描述

provider_code

String

参数解释：

服务标识。

取值范围：

不涉及

默认取值：

049

error_code

String

参数解释：

请求响应代码。

取值范围：

GOM.00000000~GOM.00009999999

默认取值：

GOM.00000000

error_msg

String

参数解释：

请求响应描述。

取值范围：

不涉及

请求示例

  • 查询问题单ISU20250701163614016045039的操作记录，并对记录进行倒序排列。

    POST https://{Endpoint}/v1/issues_mgmt/list-histories

{
  "string_filters" : [ {
    "operator" : "=",
    "field" : "ticket_id",
    "name" : "ticket_id",
    "values" : [ "ISU20250701163614016045039" ]
  } ],
  "sort_filter" : {
    "operator" : "desc",
    "field" : "start_time",
    "name" : "start_time",
    "values" : [ "start_time" ]
  }
}

  • 查询事件单IM202507072025020138492792的操作记录，并对记录进行倒序排列。

    POST https://{Endpoint}/v1/coc-api/incident/list-histories

{
  "string_filters" : [ {
    "operator" : "=",
    "field" : "ticket_id",
    "name" : "ticket_id",
    "values" : [ "IM202507072025020138492792" ]
  } ],
  "sort_filter" : {
    "operator" : "desc",
    "field" : "start_time",
    "name" : "start_time",
    "values" : [ "start_time" ]
  }
}

响应示例

状态码：200

请求成功。

更多状态码请参考状态码。

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : "049",
  "data" : {
    "total" : 2,
    "info" : [ {
      "history_kind" : "issues_mgmt_history_type_1000",
      "action_id" : "main",
      "action" : "gocm_issues_accepte",
      "sub_action" : "success",
      "operator" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "id" : "19617e76c40cee2f3ffb51e1014960e1",
      "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
      "start_time" : 1751360968334,
      "is_deteted" : false,
      "action_name_zh" : "受理",
      "action_name_en" : "Accepted",
      "status" : "issues_work_flow_status_2000",
      "final_sub_action" : "success",
      "enum_data_list" : [ {
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "主流程",
        "name_en" : "Main Process",
        "biz_id" : "issues_mgmt_history_type_1000",
        "prop_id" : "history_kind",
        "model_id" : "TicketHistoryInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.User",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "coc_developer_test",
        "name_en" : "coc_developer_test",
        "user_name" : "coc_developer_test",
        "biz_id" : "96d9d36ef5e74f7aa54122586d5df0d5",
        "prop_id" : "operator",
        "model_id" : "TicketHistoryInfo"
      } ]
    }, {
      "history_kind" : "issues_mgmt_history_type_1000",
      "action_id" : "main",
      "action" : "submit_issues_mgmt",
      "sub_action" : "success",
      "operator" : "96d9d36ef5e74f7aa54122586d5df0d5",
      "id" : "15160940fc26567c9db5fbea29e92f32",
      "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
      "start_time" : 1751358975131,
      "stop_time" : 1751360968334,
      "is_deteted" : false,
      "action_name_zh" : "创建问题单",
      "action_name_en" : "Create a trouble ticket",
      "status" : "issues_work_flow_status_1000",
      "final_sub_action" : "success",
      "enum_data_list" : [ {
        "is_deleted" : false,
        "match_type" : "enum",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "主流程",
        "name_en" : "Main Process",
        "biz_id" : "issues_mgmt_history_type_1000",
        "prop_id" : "history_kind",
        "model_id" : "TicketHistoryInfo"
      }, {
        "is_deleted" : false,
        "match_type" : "reference__base_config.User",
        "ticket_id" : "72b8d255-a194-428f-94d0-29b6d91bec6d",
        "real_ticket_id" : "ISU20250701163614016045039",
        "name_zh" : "coc_developer_test",
        "name_en" : "coc_developer_test",
        "user_name" : "coc_developer_test",
        "biz_id" : "96d9d36ef5e74f7aa54122586d5df0d5",
        "prop_id" : "operator",
        "model_id" : "TicketHistoryInfo"
      } ]
    } ]
  }
}

状态码：400

服务器未能处理请求。

更多状态码请参考状态码。

{
  "error_code" : "GOM.00067032",
  "error_msg" : "参数错误",
  "provider_code" : "049",
  "data" : null
}

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码。

400

服务器未能处理请求。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题： 问题单管理

相关文档