Preview Schedule

POST/schedule/preview

Request

start

integer

Start time

required

Time automatically aligned to the previous half hour

end

integer

End time

required

Time automatically aligned to the previous half hour, interval with start should not exceed 30 days

layers

array [object {10}]

Rules

required

layer_name

string

Rule name

optional

mode

enum<integer>

Mode (Normal/Temporary)

required

Rules with mode=1 are placed after those with mode=0

Allowed values:

groups

array [object {2}]

On-call group

optional

rotation_duration

integer

On-call cycle

optional

Unit: seconds, minimum granularity 1800

fair_rotation

boolean

Fair rotation switch

optional

handoff_time

integer

Handover time

optional

Handover time in seconds from Monday 00:00 for weekly rotation cycle

layer_start

integer

Start time

required

Minimum granularity half hour

layer_end

integer

End time

optional

Minimum granularity half hour

restrict_mode

enum<integer>

Cycle restriction mode

optional

0 No restriction, 1 Daily granularity, 2 Weekly granularity

Allowed values:

012

restrict_periods

array [object {2}]

optional

{
  "start": 0,
  "end": 0,
  "layers": [
    {
      "layer_name": "string",
      "mode": 0,
      "groups": [
        {
          "group_name": "string",
          "members": [
            {
              "role_id": 0,
              "person_ids": [
                0
              ]
            }
          ]
        }
      ],
      "rotation_duration": 0,
      "fair_rotation": true,
      "handoff_time": 0,
      "layer_start": 0,
      "layer_end": 0,
      "restrict_mode": 0,
      "restrict_periods": [
        {
          "restrict_start": 0,
          "restrict_end": 0
        }
      ]
    }
  ]
}

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

data

object

required

start

integer

required

end

integer

required

schedule_id

integer

required

schedule_name

string

required

team_id

integer

required

layers

array [object {10}]

Rules

required

layer_schedules

array [object {3}]

Rule calculation

required

final_schedule

object

required

Final schedule

error

object

required

code

enum<string>

Error code

required

Allowed values:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

Error description

required

{
  "data": {
    "start": 0,
    "end": 0,
    "schedule_id": 0,
    "schedule_name": "string",
    "team_id": 0
  },
  "error": {}
}

Last modified: 2 个月前