Try it free

Preview a scheduling rule

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Deprecated

Preview a scheduling rule in Dynatrace with the AutomationEngine API to validate how the rule evaluates before you save or use it.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/automation/v1/scheduling-rules/preview

Overview

You send the scheduling rule data in the request body to preview how Dynatrace evaluates it. The operation returns a 200 response with the preview result, helping you check the rule before you apply it.

Authentication

To execute this request, you need a platform token or OAuth access token with automation:workflows:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyRRulePreviewRequest | GroupingRulePreviewRequest | FixedOffsetRulePreviewRequest | RelativeOffsetRulePreviewRequest-bodyRequired

Request body objects

The RRulePreviewRequest object

ElementTypeDescriptionRequired
idstring-Optional
countinteger-Optional
businessCalendarstring-Optional
dateFromstring

Start date for the preview range (yyyy-mm-dd). Defaults to UTC today.

Optional
dateTostring

End date for the preview range (yyyy-mm-dd). If provided, returns all executions in the range and count is ignored. Must not exceed 182 days from date_from.

Optional
ruleTypeRRulePreviewRuleType-
The element can hold these values
  • rrule
Required
rruleRRule-Required

The RRulePreviewRuleType object

The RRule object

ElementTypeDescriptionRequired
freqFreq-
The element can hold these values
  • YEARLY
  • MONTHLY
  • WEEKLY
  • DAILY
  • HOURLY
  • MINUTELY
  • SECONDLY
Required
datestartstring

The recurrence start.

Required
intervalinteger

The interval between each freq iteration.

Optional
wkstWkst

The week start day.

Optional
untilstring

Specifying the upper-bound limit of the recurrence.

Optional
bysetposinteger[]

Each given integer will specify an occurrence number, corresponding to the nth occurrence of the rule inside the frequency period

Optional
bymonthinteger[]

The months to apply the recurrence to.

Optional
bymonthdayinteger[]

The month days to apply the recurrence to.

Optional
byyeardayinteger[]

The year days to apply the recurrence to.

Optional
byweeknointeger[]

The week numbers to apply the recurrence to.

Optional
bydayByday[]

Define the weekdays where the recurrence will be applied.

Optional
byworkdayByworkday

The type of days on which the recurrence will be applied.

Optional

The Freq object

The Wkst object

The week start day.

The Byday object

The Byworkday object

The type of days on which the recurrence will be applied.

The GroupingRulePreviewRequest object

ElementTypeDescriptionRequired
idstring-Optional
countinteger-Optional
businessCalendarstring-Optional
dateFromstring

Start date for the preview range (yyyy-mm-dd). Defaults to UTC today.

Optional
dateTostring

End date for the preview range (yyyy-mm-dd). If provided, returns all executions in the range and count is ignored. Must not exceed 182 days from date_from.

Optional
ruleTypeGroupingRulePreviewRuleType-
The element can hold these values
  • grouping
Required
groupingRuleGroupingRule-Required

The GroupingRulePreviewRuleType object

The GroupingRule object

ElementTypeDescriptionRequired
combinestring[]-Optional
intersectstring[]-Optional
subtractstring[]-Optional

The FixedOffsetRulePreviewRequest object

ElementTypeDescriptionRequired
idstring-Optional
countinteger-Optional
businessCalendarstring-Optional
dateFromstring

Start date for the preview range (yyyy-mm-dd). Defaults to UTC today.

Optional
dateTostring

End date for the preview range (yyyy-mm-dd). If provided, returns all executions in the range and count is ignored. Must not exceed 182 days from date_from.

Optional
ruleTypeFixedOffsetRulePreviewRuleType-
The element can hold these values
  • fixed_offset
Required
fixedOffsetRuleFixedOffsetRule-Required

The FixedOffsetRulePreviewRuleType object

The FixedOffsetRule object

ElementTypeDescriptionRequired
rulestring-Required
offsetnumber

Offset days

Required

The RelativeOffsetRulePreviewRequest object

ElementTypeDescriptionRequired
idstring-Optional
countinteger-Optional
businessCalendarstring-Optional
dateFromstring

Start date for the preview range (yyyy-mm-dd). Defaults to UTC today.

Optional
dateTostring

End date for the preview range (yyyy-mm-dd). If provided, returns all executions in the range and count is ignored. Must not exceed 182 days from date_from.

Optional
ruleTypeRelativeOffsetRulePreviewRuleType-
The element can hold these values
  • relative_offset
Required
relativeOffsetRuleRelativeOffsetRule-Required

The RelativeOffsetRulePreviewRuleType object

The RelativeOffsetRule object

ElementTypeDescriptionRequired
directionDirection-
The element can hold these values
  • next
  • previous
Required
sourceRulestring-Required
targetRulestring-Required

The Direction object

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "id": "string",
  "count": 10,
  "businessCalendar": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "ruleType": "rrule",
  "rrule": {
    "freq": "YEARLY",
    "datestart": "string",
    "interval": 1,
    "wkst": "MO",
    "until": "string",
    "bysetpos": [
      1
    ],
    "bymonth": [
      1
    ],
    "bymonthday": [
      1
    ],
    "byyearday": [
      1
    ],
    "byweekno": [
      1
    ],
    "byday": [
      "MO"
    ],
    "byworkday": "WORKING"
  }
}

Response

Response codes

CodeTypeDescription
200RulePreviewResponse-
4XXErrorEnvelope-

Response body objects

The RulePreviewResponse object

ElementTypeDescription
nextExecutionsstring[]-
validboolean-
errorstring-

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
messagestring-
codeinteger-
detailsErrorDetails-

The ErrorDetails object

ElementTypeDescription
errorCodestring-
errorRefstring-

Response body JSON models

{
  "nextExecutions": [
    "string"
  ],
  "valid": true,
  "error": "string"
}
{
  "error": {
    "message": "string",
    "code": 1,
    "details": {
      "errorCode": "string",
      "errorRef": "string"
    }
  }
}
Related tags
Platform APIDynatrace Platform