List scheduling rules in Dynatrace Automation API with optional search, ordering, limit, and offset parameters for browsing rule records.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/automation/v1/scheduling-rules |
You can use limit, offset, ordering, and search to control which rules appear and how they are returned. The response returns a page of scheduling rules.
To execute this request, you need a platform token or OAuth access token with automation:rules:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| limit | integer | Number of results to return per page. | query | Optional |
| offset | integer | The initial index from which to return the results. | query | Optional |
| ordering | string | Which field to use when ordering the results. | query | Optional |
| search | string | A search term. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Paginated | - |
| 4XX | Error | - |
PaginatedRuleList object| Element | Type | Description |
|---|---|---|
| count | integer | - |
| results | Rule[] | - |
Rule object| Element | Type | Description |
|---|---|---|
| id | string | - |
| version | integer | - |
| title | string | - |
| ruleType | Rule | -The element can hold these values
|
| rrule | R | - |
| groupingRule | Grouping | - |
| fixedOffsetRule | Fixed | - |
| relativeOffsetRule | Relative | - |
| businessCalendar | string | - |
| description | string | - |
| modificationInfo | Modification | - |
RuleType objectRRule object| Element | Type | Description |
|---|---|---|
| freq | Freq | -The element can hold these values
|
| datestart | string | The recurrence start. |
| interval | integer | The interval between each freq iteration. |
| wkst | Wkst | The week start day. |
| until | string | Specifying the upper-bound limit of the recurrence. |
| bysetpos | integer[] | Each given integer will specify an occurrence number, corresponding to the nth occurrence of the rule inside the frequency period |
| bymonth | integer[] | The months to apply the recurrence to. |
| bymonthday | integer[] | The month days to apply the recurrence to. |
| byyearday | integer[] | The year days to apply the recurrence to. |
| byweekno | integer[] | The week numbers to apply the recurrence to. |
| byday | Byday[] | Define the weekdays where the recurrence will be applied. |
| byworkday | Byworkday | The type of days on which the recurrence will be applied. |
Freq objectWkst objectThe week start day.
Byday objectByworkday objectThe type of days on which the recurrence will be applied.
GroupingRule object| Element | Type | Description |
|---|---|---|
| combine | string[] | - |
| intersect | string[] | - |
| subtract | string[] | - |
FixedOffsetRule object| Element | Type | Description |
|---|---|---|
| rule | string | - |
| offset | number | Offset days |
RelativeOffsetRule object| Element | Type | Description |
|---|---|---|
| direction | Direction | -The element can hold these values
|
| sourceRule | string | - |
| targetRule | string | - |
Direction objectModificationInfo object| Element | Type | Description |
|---|---|---|
| createdBy | string | - |
| createdTime | string | - |
| lastModifiedBy | string | - |
| lastModifiedTime | string | - |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| message | string | - |
| code | integer | - |
| details | Error | - |
ErrorDetails object| Element | Type | Description |
|---|---|---|
| errorCode | string | - |
| errorRef | string | - |
{"count": 123,"results": [{"id": "string","version": 1,"title": "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"},"groupingRule": {"combine": ["string"],"intersect": ["string"],"subtract": ["string"]},"fixedOffsetRule": {"rule": "string","offset": 1},"relativeOffsetRule": {"direction": "next","sourceRule": "string","targetRule": "string"},"businessCalendar": "string","description": "string","modificationInfo": {"createdBy": "string","createdTime": "string","lastModifiedBy": "string","lastModifiedTime": "string"}}]}
{"error": {"message": "string","code": 1,"details": {"errorCode": "string","errorRef": "string"}}}