调用GetOnCallSchedulesDetail接口查询排班策略信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
arms:GetOnCallSchedulesDetail |
none |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Id |
integer |
是 |
排班策略 ID。 |
1234 |
| StartTime |
string |
否 |
开始值班时间,格式为 |
2022-10-01 |
| EndTime |
string |
否 |
结束值班时间,格式为 |
2022-10-30 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
21E85B16-75A6-429A-9F65-8AAC9A54**** |
| Data |
object |
排班策略详细信息。 |
|
| Id |
integer |
排班策略 ID。 |
1234 |
| Name |
string |
排名策略名称。 |
排班策略测试 |
| Description |
string |
排班策略描述信息。 |
测试 |
| AlertRobotId |
integer |
换班通知的钉钉机器人地址。 |
https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5****** |
| ScheduleLayers |
array<object> |
值班班次。 |
|
|
array<object> |
|||
| ContactIds |
array |
排班人员 ID 列表。 |
|
|
integer |
排班人员 ID。 |
[123, 234, 456] |
|
| StartTime |
string |
换班生效起始时间。 |
2022-10-01 |
| ShiftLength |
integer |
换班周期,单位为小时。 |
8 |
| RotationType |
string |
换班类型:
|
DAY |
| Restrictions |
array<object> |
排班限制时间。 |
|
|
object |
|||
| RestrictionType |
string |
限制时间类型:
|
daily_restriction |
| StartTimeOfDay |
string |
每天开始值班时间。 |
09:00 |
| EndTimeOfDay |
string |
每天结束值班时间。 |
18:00 |
| RenderedLayerEntries |
array<object> |
查询时间范围内的排班人员。 |
|
|
array<object> |
|||
|
array<object> |
|||
| Start |
string |
排班人开始值班时间。 |
2022-10-01 |
| End |
string |
排班人结束值班时间。 |
2022-10-30 |
| SimpleContact |
object |
排班人信息。 |
|
| Id |
integer |
排班人 ID。 |
123 |
| Name |
string |
排班人名称。 |
员工1 |
| RenderedSubstitudeEntries |
array<object> |
查询时间范围内的替班人员。 |
|
|
array<object> |
|||
| Start |
string |
替班人开始值班时间。 |
2022-10-01 |
| End |
string |
替班人结束值班时间。 |
2022-10-30 |
| SimpleContact |
object |
替班人信息。 |
|
| Id |
integer |
替班人 ID。 |
234 |
| Name |
string |
替班人名称。 |
员工2 |
| RenderedFinnalEntries |
array<object> |
最终值班人员信息。 |
|
|
array<object> |
|||
| Start |
string |
值班人开始值班时间。 |
2022-10-01 |
| End |
string |
值班人结束值班时间。 |
2022-10-30 |
| SimpleContact |
object |
值班人信息。 |
|
| Id |
integer |
值班人 ID。 |
123 |
| Name |
string |
值班人名称。 |
员工1 |
示例
正常返回示例
JSON格式
{
"RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****",
"Data": {
"Id": 1234,
"Name": "排班策略测试",
"Description": "测试",
"AlertRobotId": 0,
"ScheduleLayers": [
{
"ContactIds": [
0
],
"StartTime": "2022-10-01\n",
"ShiftLength": 8,
"RotationType": "DAY",
"Restrictions": [
{
"RestrictionType": "daily_restriction",
"StartTimeOfDay": "09:00",
"EndTimeOfDay": "18:00"
}
]
}
],
"RenderedLayerEntries": [
[
{
"Start": "2022-10-01",
"End": "2022-10-30",
"SimpleContact": {
"Id": 123,
"Name": "员工1"
}
}
]
],
"RenderedSubstitudeEntries": [
{
"Start": "2022-10-01",
"End": "2022-10-30",
"SimpleContact": {
"Id": 234,
"Name": "员工2"
}
}
],
"RenderedFinnalEntries": [
{
"Start": "2022-10-01",
"End": "2022-10-30",
"SimpleContact": {
"Id": 123,
"Name": "员工1"
}
}
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。