GetOnCallSchedulesDetail - Application Real-Time Monitoring Service

Queries the information about a scheduling policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Id	long	Yes	The ID of the scheduling policy.	1234
StartTime	string	No	The date from which the shift starts. Format: `yyyy-MM-dd`.	2022-10-01
EndTime	string	No	The date on which the shift ends. Format: `yyyy-MM-dd`.	2022-10-30

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	21E85B16-75A6-429A-9F65-8AAC9A54****
Data	object	The information about the scheduling policy.
Id	long	The ID of the scheduling policy.	1234
Name	string	The name of the scheduling policy.	Scheduling policy test
Description	string	The description of the scheduling policy.	Test
AlertRobotId	long	The URL of the DingTalk chatbot, which is used to receive notifications about shift changes.	https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******
ScheduleLayers	object []	The information about the shift.
ContactIds	array	The ID list of users on duty.
	long	The ID of the user on duty.	[123, 234, 456]
StartTime	string	The date on which the shift change took effect.	2022-10-01
ShiftLength	long	The shift cycle. Unit: hours.	8
RotationType	string	The type of the shift. Valid values: DAY WEEK CUSTOM	DAY
Restrictions	object []	The limit on the time of the shift.
RestrictionType	string	The type of the limit. Valid values: daily_restriction weekly_restriction	daily_restriction
StartTimeOfDay	string	The start time of the shift per day.	09:00
EndTimeOfDay	string	The end time of the shift per day.	18:00
RenderedLayerEntries	array	The scheduled users on duty within a time range.
	object []
Start	string	The date from which the scheduled user was supposed to start shift work.	2022-10-01
End	string	The date on which the scheduled user was supposed to complete shift work.	2022-10-30
SimpleContact	object	The information about the scheduled user.
Id	long	The ID of the scheduled user.	123
Name	string	The name of the scheduled user.	Employee 1
RenderedSubstitudeEntries	object []	The information about the substitutes within a time range.
Start	string	The date from which the substitute was supposed to start shift work.	2022-10-01
End	string	The date on which the substitute was supposed to complete shift work.	2022-10-30
SimpleContact	object	The information about the substitute.
Id	long	The ID of the substitute.	234
Name	string	The name of the substitute.	Employee 2
RenderedFinnalEntries	object []	The information about the final user on duty.
Start	string	The date from which the user started shift work.	2022-10-01
End	string	The date on which the user completed shift work.	2022-10-30
SimpleContact	object	The information about the user on duty.
Id	long	The ID of the user on duty.	123
Name	string	The name of the user on duty.	Employee 1

Examples

Sample success responses

JSONformat

{
  "RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****",
  "Data": {
    "Id": 1234,
    "Name": "Scheduling policy test\n",
    "Description": "Test\n",
    "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": "Employee 1\n"
          }
        }
      ]
    ],
    "RenderedSubstitudeEntries": [
      {
        "Start": "2022-10-01",
        "End": "2022-10-30",
        "SimpleContact": {
          "Id": 234,
          "Name": "Employee 2\n"
        }
      }
    ],
    "RenderedFinnalEntries": [
      {
        "Start": "2022-10-01",
        "End": "2022-10-30",
        "SimpleContact": {
          "Id": 123,
          "Name": "Employee 1\n"
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-07-26	Add Operation	see changesets