All Products
Search
Document Center

Application Real-Time Monitoring Service:GetOnCallSchedulesDetail

Last Updated:Nov 05, 2024

Queries the information about a scheduling policy.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:GetOnCallSchedulesDetailnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdlongYes

The ID of the scheduling policy.

1234
StartTimestringNo

The date from which the shift starts. Format: yyyy-MM-dd.

2022-10-01
EndTimestringNo

The date on which the shift ends. Format: yyyy-MM-dd.

2022-10-30

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

21E85B16-75A6-429A-9F65-8AAC9A54****
Dataobject

The information about the scheduling policy.

Idlong

The ID of the scheduling policy.

1234
Namestring

The name of the scheduling policy.

Scheduling policy test
Descriptionstring

The description of the scheduling policy.

Test
AlertRobotIdlong

The URL of the DingTalk chatbot, which is used to receive notifications about shift changes.

https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******
ScheduleLayersarray<object>

The information about the shift.

scheduleLayersobject
ContactIdsarray

The ID list of users on duty.

contactIdslong

The ID of the user on duty.

[123, 234, 456]
StartTimestring

The date on which the shift change took effect.

2022-10-01
ShiftLengthlong

The shift cycle. Unit: hours.

8
RotationTypestring

The type of the shift. Valid values:

  • DAY
  • WEEK
  • CUSTOM
DAY
Restrictionsarray<object>

The limit on the time of the shift.

restrictionsobject
RestrictionTypestring

The type of the limit. Valid values:

  • daily_restriction
  • weekly_restriction
daily_restriction
StartTimeOfDaystring

The start time of the shift per day.

09:00
EndTimeOfDaystring

The end time of the shift per day.

18:00
RenderedLayerEntriesarray

The scheduled users on duty within a time range.

renderedLayerEntriesarray<object>
renderedLayerEntriesobject
Startstring

The date from which the scheduled user was supposed to start shift work.

2022-10-01
Endstring

The date on which the scheduled user was supposed to complete shift work.

2022-10-30
SimpleContactobject

The information about the scheduled user.

Idlong

The ID of the scheduled user.

123
Namestring

The name of the scheduled user.

Employee 1
RenderedSubstitudeEntriesarray<object>

The information about the substitutes within a time range.

renderedSubstitudeEntriesobject
Startstring

The date from which the substitute was supposed to start shift work.

2022-10-01
Endstring

The date on which the substitute was supposed to complete shift work.

2022-10-30
SimpleContactobject

The information about the substitute.

Idlong

The ID of the substitute.

234
Namestring

The name of the substitute.

Employee 2
RenderedFinnalEntriesarray<object>

The information about the final user on duty.

renderedFinnalEntriesobject
Startstring

The date from which the user started shift work.

2022-10-01
Endstring

The date on which the user completed shift work.

2022-10-30
SimpleContactobject

The information about the user on duty.

Idlong

The ID of the user on duty.

123
Namestring

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 timeSummary of changesOperation
2022-07-26Add OperationView Change Details