列出¶
GET /api/v1/incidents/schedule/list
概述¶
Query 请求参数¶
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| incidentsScheduleUUIDs | commaArray | 故障排班UUID列表 允许为空: False |
|
| mySchedule | string | 查看我的日程, 默认 false: 查看所有日程 允许为空: True 可选值: ['true', 'false'] |
|
| scheduleCalendar | string | 日程 日历, 默认 false: 查看日程管理 允许为空: True 可选值: ['true', 'false'] |
|
| scTimezone | string | 日程 日历 查询时的时区, 默认 Asia/Shanghai 例子: Asia/Shanghai 允许为空: False 最大长度: 48 |
|
| scDateRange | string | 日程 日历 查询时的日期范围, 默认 只有查询当天 例子: 2024/06/22~2024/07/06 允许为空: False 允许为空字符串: False 最大长度: 48 |
|
| search | string | 搜索排班名称 允许为空: True |
|
| pageIndex | integer | 页码 允许为空: False 例子: 1 $minValue: 1 |
|
| pageSize | integer | 每页返回数量 允许为空: False 例子: 10 $minValue: 1 $maxValue: 100 |
参数补充说明¶
当 scheduleCalendar=true 时，scheduleCalendarInfos[date][] 返回临时代班计算后的实际值班人，不再返回原排班人和同级 overrideInfo 的兼容结构。
每个日历数组项的主体账号字段代表该时间片的实际值班人，并包含：
scheduleUUID：该时间片所属的值班配置 UUID。scheduleTimeRange：实际值班时间片，按临时代班起止边界切分。overrideInfo：命中的完整临时代班关系；未命中时为null。
代班关系中的 substituteTargetInfo 与数组项主体账号信息一致，replacedTargetInfo 为替班前的原排班人。不同代班关系不会错误合并；同一关系的多个不连续时间片可以合并到同一个 scheduleTimeRange 数组。
日历模式示例：
{
"scheduleCalendarInfos": {
"2026/08/16": [
{
"uuid": "acnt_substitute",
"name": "Bob",
"email": "xxx@guance.com",
"scheduleUUID": "incsch_xxx",
"scheduleTimeRange": [[1786838400, 1786856400]],
"overrideInfo": {
"uuid": "incschovr_xxx",
"scheduleUUID": "incsch_xxx",
"replacedTarget": "acnt_original",
"substituteTarget": "acnt_substitute",
"startAt": 1786838400,
"endAt": 1786856400,
"timezone": "Asia/Shanghai",
"replacedTargetInfo": {
"uuid": "acnt_original",
"name": "Alice",
"email": "xxx@guance.com"
},
"substituteTargetInfo": {
"uuid": "acnt_substitute",
"name": "Bob",
"email": "xxx@guance.com"
}
}
}
]
},
"scheduleCalendarUpdateInfos": {},
"totalCount": 1,
"myScheduleCount": 1,
"totalScheduleCount": 1
}
Front 同路径日历接口继续保持原始值班人加同级 overrideInfo 的兼容结构；OpenAPI 普通列表、详情、写入接口和 AIAPI 值班列表不受影响。
请求例子¶
curl 'https://openapi.guance.com/api/v1/incidents/schedule/list?pageIndex=1&pageSize=20' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--compressed
响应¶
{
"code": 200,
"content": {
"data": [
{
"workspaceUUID": "wksp_xxxx",
"name": "default",
"timezone": "Asia/Shanghai",
"start": "00:00",
"end": "23:59",
"tagFilter": [],
"dimensionFilter": "",
"notifyTargets": [],
"strategyConfig": [],
"extend": {
"rotationCycle": "day",
"enableRotateNotification": false
},
"isDefault": true,
"rotationUpdateAt": 1768803347,
"id": 6952,
"uuid": "incsch_xxx",
"status": 0,
"creator": "SYS",
"updator": "acnt_xxx",
"createAt": 1768803072,
"deleteAt": -1,
"updateAt": 1768803347,
"inEffectNotifyTargetsInfos": [],
"notifyTargetsInfos": [],
"effectiveTimeInfos": {
"timeStr": "",
"expired": false
},
"tagFilterInfos": []
}
],
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
},
"myScheduleCount": 1,
"totalScheduleCount": 1
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "xxx"
}