- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- API参考
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
查询简易版事件单列表
功能介绍
该接口可分页查询到事件单列表信息，分页参数为limit与offset。该接口不支持对事件单进行除分页参数外的条件过滤，且返回的列表字段相对简单，只有事件单标题、事件单单号、描述信息、工单状态、事件级别、企业项目ID、事件单来源、创建人及责任人。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/incident-tickets
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释： 列表查询接口分页参数，表示当前查询第几页，1表示查询第一页。 约束限制： 不涉及 取值范围： 1-2147483647 默认取值： 不涉及 |
|
limit |
否 |
Integer |
参数解释： 列表查询接口分页参数，表示一页查询多少条数据，该值需大于等于1且为整数，表示分页查询时每一页最多查到的数量。 约束限制： 不涉及 取值范围： 1-100 默认取值： 50 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
参数解释： 服务标识。 取值范围： 不涉及 默认取值： 049 |
|
error_code |
String |
参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
|
error_msg |
String |
参数解释： 请求响应描述。 取值范围： 不涉及 默认取值： 不涉及 |
|
data |
data object |
参数解释： 根据条件查到的事件单信息。 取值范围： 不涉及 默认取值： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
参数解释： 查询到的事件单总数量。 取值范围： 不涉及 默认取值： 不涉及 |
|
IncidentSimpleTicketInfos |
Array of IncidentSimpleTicketInfo objects |
参数解释： 事件单工单详情信息。 取值范围： 不涉及 默认取值： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
title |
String |
参数解释： 事件单标题。 取值范围： 不涉及 默认取值： 不涉及 |
|
ticket_id |
String |
参数解释： 事件单单号。 取值范围： 不涉及 默认取值： 不涉及 |
|
description |
String |
参数解释： 事件单描述。 取值范围： 不涉及 默认取值： 不涉及 |
|
status |
String |
参数解释： 事件状态。 参考：枚举 事件状态 incident_status 取值范围： 不涉及 默认取值： 不涉及 |
|
level |
String |
参数解释： 事件级别。 参考：枚举 事件级别 incident_level 取值范围： 不涉及 默认取值： 不涉及 |
|
enterprise_project |
String |
参数解释： 企业项目ID。 取值范围： 不涉及 默认取值： 不涉及 |
|
source |
String |
参数解释： 单据来源。 参考：枚举 事件来源 incident_source 取值范围： 不涉及 默认取值： 不涉及 |
|
creator |
String |
参数解释： 创建人工号。 取值范围： 不涉及 默认取值： 不涉及 |
|
assignee |
Array of strings |
参数解释： 当前责任人，可能存在多个责任人使用列表展示，内容为责任人用户ID信息。 取值范围： 不涉及 默认取值： 不涉及 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
provider_code |
String |
参数解释： 服务标识。 取值范围： 不涉及 默认取值： 049 |
|
error_code |
String |
参数解释： 请求响应代码。 取值范围： GOM.00000000~GOM.00009999999 默认取值： GOM.00000000 |
|
error_msg |
String |
参数解释： 请求响应描述。 取值范围： 不涉及 默认取值： 不涉及 |
请求示例
查询简易版事件单列表。
GET https://{Endpoint}/v1/incident-tickets?offset=1&limit=10响应示例
状态码：200
请求成功。
更多状态码请参考状态码。
{
"error_code" : "GOM.00000000",
"error_msg" : null,
"provider_code" : "049",
"data" : {
"total" : 1,
"IncidentSimpleTicketInfos" : [ {
"title" : "incident title",
"ticket_id" : "IM202506091611180193863384",
"description" : "incident description",
"status" : "INCIDENT_STATUS_TRIGGERED",
"level" : "level_50",
"enterprise_project" : "0",
"source" : "incident_source_manual",
"creator" : "653989085ba7487184d7cf219b8aa51e",
"assignee" : [ "001427162ad8453ba6678d7cdb36bb59" ]
} ]
}
}状态码：400
服务器未能处理请求。
更多状态码请参考状态码。
{
"error_code" : "GOM.00007256",
"error_msg" : "参数错误",
"provider_code" : "049",
"data" : null
}错误码
请参见错误码。
