# @dynatrace-sdk/client-automation [![npm](https://img.shields.io/badge/npm-v7.0.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-automation/v/7.0.1) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) Manage and run workflows with the AutomationEngine API. ## Installation ```bash npm install @dynatrace-sdk/client-automation ``` ## Getting help - Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/) - Ask a question in the [Dynatrace Community](https://community.dynatrace.com/) ## License This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information. # API reference Full API reference for the latest version of the SDK is also available at the [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-automation/). ## actionExecutionsClient ```js import { actionExecutionsClient } from '@dynatrace-sdk/client-automation'; ``` ### getActionExecution

actionExecutionsClient.getActionExecution(config): Promise<ActionExecution>

**Required scope:** automation:workflows:read

Code example

```ts import { actionExecutionsClient } from "@dynatrace-sdk/client-automation"; const data = await actionExecutionsClient.getActionExecution({ id: "...", }); ```

### getActionExecutionLog

actionExecutionsClient.getActionExecutionLog(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>

**Required scope:** automation:workflows:read Returns the log output of a specific ActionExecution.

Code example

```ts import { actionExecutionsClient } from "@dynatrace-sdk/client-automation"; const data = await actionExecutionsClient.getActionExecutionLog({ id: "...", }); ```

## actionsSampleResultClient ```js import { actionsSampleResultClient } from '@dynatrace-sdk/client-automation'; ``` ### ~~getActionSampleResult~~ > ⚠️ **Deprecated**

actionsSampleResultClient.getActionSampleResult(config): Promise<[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | | --- | --- | |config.actionIdentifier^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| #### Returns | Return type | Status code | Description | |---|---|---| |void|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { actionsSampleResultClient } from "@dynatrace-sdk/client-automation"; const data = await actionsSampleResultClient.getActionSampleResult({ actionIdentifier: "...", }); ```

## businessCalendarsClient ```js import { businessCalendarsClient } from '@dynatrace-sdk/client-automation'; ``` ### createBusinessCalendar

businessCalendarsClient.createBusinessCalendar(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:write

#### Parameters | Name | Type | | --- | --- | |config.body^*required|BusinessCalendarCreate| #### Returns | Return type | Status code | Description | |---|---|---| |[BusinessCalendarResponse](#businesscalendarresponse)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.createBusinessCalendar({ body: { title: "..." }, }); ```

### deleteBusinessCalendar

businessCalendarsClient.deleteBusinessCalendar(config): Promise<void>

**Required scope:** automation:calendars:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | #### Returns | Return type | Status code | Description | |---|---|---| |void|204|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.deleteBusinessCalendar({ id: "...", }); ```

### duplicateBusinessCalendar

businessCalendarsClient.duplicateBusinessCalendar(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.body^*required|DuplicationRequest| | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | #### Returns | Return type | Status code | Description | |---|---|---| |[BusinessCalendarResponse](#businesscalendarresponse)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.duplicateBusinessCalendar({ id: "...", body: {}, }); ```

### getBusinessCalendar

businessCalendarsClient.getBusinessCalendar(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | #### Returns | Return type | Status code | Description | |---|---|---| |[BusinessCalendarResponse](#businesscalendarresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.getBusinessCalendar({ id: "...", }); ```

### getBusinessCalendarHistoryRecord

businessCalendarsClient.getBusinessCalendarHistoryRecord(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | |config.version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^\[\\d]+$| #### Returns | Return type | Status code | Description | |---|---|---| |[BusinessCalendarResponse](#businesscalendarresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.getBusinessCalendarHistoryRecord( { id: "...", version: "..." }, ); ```

### getBusinessCalendarHistoryRecords

businessCalendarsClient.getBusinessCalendarHistoryRecords(config): Promise<PaginatedChangeHistory>

**Required scope:** automation:calendars:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.all|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|When false, the latest historical record is not returned. | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedChangeHistory](#paginatedchangehistory)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.getBusinessCalendarHistoryRecords( { id: "..." }, ); ```

### getBusinessCalendars

businessCalendarsClient.getBusinessCalendars(config): Promise<PaginatedBusinessCalendarResponseList>

**Required scope:** automation:calendars:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.offset|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.search|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedBusinessCalendarResponseList](#paginatedbusinesscalendarresponselist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.getBusinessCalendars(); ```

### patchBusinessCalendar

businessCalendarsClient.patchBusinessCalendar(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.body^*required|BusinessCalendarUpdate| | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | #### Returns | Return type | Status code | Description | |---|---|---| |[BusinessCalendarResponse](#businesscalendarresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.patchBusinessCalendar({ id: "...", body: {}, }); ```

### restoreBusinessCalendarHistoryRecord

businessCalendarsClient.restoreBusinessCalendarHistoryRecord(config): Promise<void>

**Required scope:** automation:calendars:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this business calendar. | |config.version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^\[\\d]+$| #### Returns | Return type | Status code | Description | |---|---|---| |void|200|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.restoreBusinessCalendarHistoryRecord( { id: "...", version: "..." }, ); ```

### updateBusinessCalendar

businessCalendarsClient.updateBusinessCalendar(config): Promise<BusinessCalendarResponse>

**Required scope:** automation:calendars:write

Code example

```ts import { businessCalendarsClient } from "@dynatrace-sdk/client-automation"; const data = await businessCalendarsClient.updateBusinessCalendar({ id: "...", body: {}, }); ```

## eventTriggersClient ```js import { eventTriggersClient } from '@dynatrace-sdk/client-automation'; ``` ### ~~previewFilter~~ > ⚠️ **Deprecated**

eventTriggersClient.previewFilter(config): Promise<EventTriggerPreviewResponse>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | | --- | --- | |config.body^*required|EventTriggerPreviewRequest| #### Returns | Return type | Status code | Description | |---|---|---| |[EventTriggerPreviewResponse](#eventtriggerpreviewresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { eventTriggersClient } from "@dynatrace-sdk/client-automation"; const data = await eventTriggersClient.previewFilter({ body: { triggerConfiguration: { type: "event", value: { query: "..." }, }, }, }); ```

## executionsClient ```js import { executionsClient } from '@dynatrace-sdk/client-automation'; ``` ### cancelExecution

executionsClient.cancelExecution(config): Promise<void>

**Required scope:** automation:workflows:run Tries to cancel an Execution. Can only be done, if the Execution is in an active state.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.cancelExecution({ id: "...", }); ```

### cancelTaskExecution

executionsClient.cancelTaskExecution(config): Promise<void>

**Required scope:** automation:workflows:run Cancels task execution. Canceling action executions cause the task to be cancelled, which causes the workflow to be canceled.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.cancelTaskExecution({ executionId: "...", id: "...", }); ```

### getAllEventLogs

executionsClient.getAllEventLogs(config): Promise<EventLogs>

**Required scope:** automation:workflows:read Get all event logs

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getAllEventLogs({ id: "...", }); ```

### getExecution

executionsClient.getExecution(config): Promise<Execution>

**Required scope:** automation:workflows:read Get execution

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getExecution({ id: "...", }); ```

### getExecutionActions

executionsClient.getExecutionActions(config): Promise<Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>>

**Required scope:** automation:workflows:read Return list of actions assigned to tasks in a given Execution.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getExecutionActions({ id: "...", }); ```

### getExecutionLog

executionsClient.getExecutionLog(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>

**Required scope:** automation:workflows:read Gets the execution log

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getExecutionLog({ id: "...", }); ```

### getExecutions

executionsClient.getExecutions(config): Promise<PaginatedExecutionList>

**Required scope:** automation:workflows:read Get list of executions (executions of draft and simple workflows aren't included in the response).

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow access to all workflows/executions - additionally requires automation:workflows:admin | |config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.offset|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.parentExecution|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.parentWorkflow|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.schedule|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | |config.search|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | |config.startedAtGte|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.startedAtLte|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.state|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | |config.subworkflowOfTask|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Filter executions by parentExecution/task. | |config.trigger|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.triggerType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.user|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | |config.workflow|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedExecutionList](#paginatedexecutionlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getExecutions(); ```

### getTaskExecution

executionsClient.getTaskExecution(config): Promise<TaskExecution>

**Required scope:** automation:workflows:read

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTaskExecution({ executionId: "...", id: "...", }); ```

### getTaskExecutionInput

executionsClient.getTaskExecutionInput(config): Promise<[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>

**Required scope:** automation:workflows:read Returns merged inputs from all ActionExecutions belonging to the TaskExecution.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTaskExecutionInput({ executionId: "...", id: "...", }); ```

### getTaskExecutionLog

executionsClient.getTaskExecutionLog(config): Promise<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>

**Required scope:** automation:workflows:read Returns the log output of a specific task. This can be large as its the STDOUT of the Action as defined by the user.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTaskExecutionLog({ executionId: "...", id: "...", }); ```

### getTaskExecutionResult

executionsClient.getTaskExecutionResult(config): Promise<[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>

**Required scope:** automation:workflows:read Returns merged results from all ActionExecutions belonging to the TaskExecution.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTaskExecutionResult({ executionId: "...", id: "...", }); ```

### getTaskExecutions

executionsClient.getTaskExecutions(config): Promise<TaskExecutions>

**Required scope:** automation:workflows:read

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTaskExecutions({ executionId: "...", }); ```

### getTransitions

executionsClient.getTransitions(config): Promise<TaskTransitions>

**Required scope:** automation:workflows:read

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.getTransitions({ executionId: "...", }); ```

### pauseExecution

executionsClient.pauseExecution(config): Promise<void>

**Required scope:** automation:workflows:run Pauses an Execution. Can only be done, if the Execution is in an active state.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.pauseExecution({ id: "...", }); ```

### resumeExecution

executionsClient.resumeExecution(config): Promise<void>

**Required scope:** automation:workflows:run Resumes an Execution. Can only be done, if the Execution is in an inactive state.

Code example

```ts import { executionsClient } from "@dynatrace-sdk/client-automation"; const data = await executionsClient.resumeExecution({ id: "...", }); ```

## schedulesClient ```js import { schedulesClient } from '@dynatrace-sdk/client-automation'; ``` ### getCountries

schedulesClient.getCountries(config): Promise<CountryList>

**Required scope:** automation:workflows:read Returns the list of countries that can be used to look up the holiday calendar

#### Returns | Return type | Status code | Description | |---|---|---| |[CountryList](#countrylist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulesClient.getCountries(); ```

### getHolidayCalendar

schedulesClient.getHolidayCalendar(config): Promise<HolidayCalendarList>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.from|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|From date in ISO format | |config.key^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The country name | |config.to|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|To date in ISO format | #### Returns | Return type | Status code | Description | |---|---|---| |[HolidayCalendarList](#holidaycalendarlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulesClient.getHolidayCalendar({ key: "...", }); ```

### getTimezones

schedulesClient.getTimezones(config): Promise<Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>>

**Required scope:** automation:workflows:read

#### Returns | Return type | Status code | Description | |---|---|---| |void|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulesClient.getTimezones(); ```

### ~~previewSchedule~~ > ⚠️ **Deprecated**

schedulesClient.previewSchedule(config): Promise<SchedulePreviewResponse>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | | --- | --- | |config.body^*required|SchedulePreviewRequest| #### Returns | Return type | Status code | Description | |---|---|---| |[SchedulePreviewResponse](#schedulepreviewresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulesClient.previewSchedule({ body: { schedule: { trigger: { type: "cron", cron: "0 0 * * *" }, }, }, }); ```

## schedulingRulesClient ```js import { schedulingRulesClient } from '@dynatrace-sdk/client-automation'; ``` ### createRule

schedulingRulesClient.createRule(config): Promise<Rule>

**Required scope:** automation:rules:write

#### Parameters | Name | Type | | --- | --- | |config.body^*required|RuleCreate| #### Returns | Return type | Status code | Description | |---|---|---| |[Rule](#rule)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.createRule({ body: { title: "...", ruleType: "rrule" }, }); ```

### deleteRule

schedulingRulesClient.deleteRule(config): Promise<void>

**Required scope:** automation:rules:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | #### Returns | Return type | Status code | Description | |---|---|---| |void|204|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.deleteRule({ id: "...", }); ```

### duplicateRule

schedulingRulesClient.duplicateRule(config): Promise<Rule>

**Required scope:** automation:rules:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.body^*required|DuplicationRequest| | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | #### Returns | Return type | Status code | Description | |---|---|---| |[Rule](#rule)|201|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.duplicateRule({ id: "...", body: {}, }); ```

### getRule

schedulingRulesClient.getRule(config): Promise<Rule>

**Required scope:** automation:rules:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | #### Returns | Return type | Status code | Description | |---|---|---| |[Rule](#rule)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.getRule({ id: "...", }); ```

### getRuleHistoryRecord

schedulingRulesClient.getRuleHistoryRecord(config): Promise<Rule>

**Required scope:** automation:rules:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | |config.version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^\[\\d]+$| #### Returns | Return type | Status code | Description | |---|---|---| |[Rule](#rule)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.getRuleHistoryRecord({ id: "...", version: "...", }); ```

### getRuleHistoryRecords

schedulingRulesClient.getRuleHistoryRecords(config): Promise<PaginatedChangeHistory>

**Required scope:** automation:rules:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.all|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|When false, the latest historical record is not returned. | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedChangeHistory](#paginatedchangehistory)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.getRuleHistoryRecords({ id: "...", }); ```

### getRules

schedulingRulesClient.getRules(config): Promise<PaginatedRuleList>

**Required scope:** automation:rules:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.offset|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.search|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedRuleList](#paginatedrulelist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.getRules(); ```

### patchRule

schedulingRulesClient.patchRule(config): Promise<Rule>

**Required scope:** automation:rules:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.body^*required|RuleUpdate| | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | #### Returns | Return type | Status code | Description | |---|---|---| |[Rule](#rule)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.patchRule({ id: "...", body: {}, }); ```

### ~~previewRule~~ > ⚠️ **Deprecated**

schedulingRulesClient.previewRule(config): Promise<RulePreviewResponse>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | | --- | --- | |config.body^*required|RulePreviewCreate| #### Returns | Return type | Status code | Description | |---|---|---| |[RulePreviewResponse](#rulepreviewresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.previewRule({ body: { ruleType: "rrule", rrule: { freq: "YEARLY", datestart: "..." }, }, }); ```

### restoreRuleHistoryRecord

schedulingRulesClient.restoreRuleHistoryRecord(config): Promise<void>

**Required scope:** automation:rules:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A UUID string identifying this rule. | |config.version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^\[\\d]+$| #### Returns | Return type | Status code | Description | |---|---|---| |void|200|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.restoreRuleHistoryRecord({ id: "...", version: "...", }); ```

### updateRule

schedulingRulesClient.updateRule(config): Promise<Rule>

**Required scope:** automation:rules:write

Code example

```ts import { schedulingRulesClient } from "@dynatrace-sdk/client-automation"; const data = await schedulingRulesClient.updateRule({ id: "...", body: {}, }); ```

## settingsClient ```js import { settingsClient } from '@dynatrace-sdk/client-automation'; ``` ### ~~getServiceUsers~~ > ⚠️ **Deprecated**

settingsClient.getServiceUsers(config): Promise<GetServiceUsersResponse>

**Required scope:** automation:workflows:read Get service users who could be used as workflow actor (deprecated).

#### Returns | Return type | Status code | Description | |---|---|---| |void|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { settingsClient } from "@dynatrace-sdk/client-automation"; const data = await settingsClient.getServiceUsers(); ```

### ~~getSettings~~ > ⚠️ **Deprecated**

settingsClient.getSettings(config): Promise<GetSettingsResponse>

**Required scope:** automation:workflows:read Get system settings

#### Returns | Return type | Status code | Description | |---|---|---| |[GetSettingsResponse](#getsettingsresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { settingsClient } from "@dynatrace-sdk/client-automation"; const data = await settingsClient.getSettings(); ```

### ~~getUserPermissions~~ > ⚠️ **Deprecated**

settingsClient.getUserPermissions(config): Promise<Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>>

**Required scope:** automation:workflows:read Get current user effective permissions.

#### Returns | Return type | Status code | Description | |---|---|---| |void|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { settingsClient } from "@dynatrace-sdk/client-automation"; const data = await settingsClient.getUserPermissions(); ```

### ~~getUserSettings~~ > ⚠️ **Deprecated**

settingsClient.getUserSettings(config): Promise<UserSettings>

**Required scope:** automation:workflows:read Get user-specific settings

#### Returns | Return type | Status code | Description | |---|---|---| |[UserSettings](#usersettings)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { settingsClient } from "@dynatrace-sdk/client-automation"; const data = await settingsClient.getUserSettings(); ```

### ~~updateAuthorizations~~ > ⚠️ **Deprecated**

settingsClient.updateAuthorizations(config): Promise<void>

**Required scope:** automation:workflows:read

#### Returns | Return type | Status code | Description | |---|---|---| |void|202|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { settingsClient } from "@dynatrace-sdk/client-automation"; const data = await settingsClient.updateAuthorizations(); ```

## versionClient ```js import { versionClient } from '@dynatrace-sdk/client-automation'; ``` ### getVersion

versionClient.getVersion(config): Promise<VersionResponse>

**Required scope:** automation:workflows:read

#### Returns | Return type | Status code | Description | |---|---|---| |[VersionResponse](#versionresponse)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { versionClient } from "@dynatrace-sdk/client-automation"; const data = await versionClient.getVersion(); ```

## webhookHandlersClient ```js import { webhookHandlersClient } from '@dynatrace-sdk/client-automation'; ``` ### deleteWebhookHandler

webhookHandlersClient.deleteWebhookHandler(config): Promise<void>

**Required scope:** automation:webhookhandlers:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.connectionId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the connection this webhook handler belongs to | #### Returns | Return type | Status code | Description | |---|---|---| |void|204|No response body| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { webhookHandlersClient } from "@dynatrace-sdk/client-automation"; const data = await webhookHandlersClient.deleteWebhookHandler({ connectionId: "...", }); ```

### getWebhookHandler

webhookHandlersClient.getWebhookHandler(config): Promise<WebhookHandler>

**Required scope:** automation:webhookhandlers:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.connectionId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the connection this webhook handler belongs to | #### Returns | Return type | Status code | Description | |---|---|---| |[WebhookHandler](#webhookhandler)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { webhookHandlersClient } from "@dynatrace-sdk/client-automation"; const data = await webhookHandlersClient.getWebhookHandler({ connectionId: "...", }); ```

### getWebhookHandlers

webhookHandlersClient.getWebhookHandlers(config): Promise<Array<WebhookHandlerList>>

**Required scope:** automation:webhookhandlers:read

#### Returns | Return type | Status code | Description | |---|---|---| |[WebhookHandlerList](#webhookhandlerlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { webhookHandlersClient } from "@dynatrace-sdk/client-automation"; const data = await webhookHandlersClient.getWebhookHandlers(); ```

### writeWebhookHandler

webhookHandlersClient.writeWebhookHandler(config): Promise<WebhookHandler>

**Required scope:** automation:webhookhandlers:write

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.body^*required|WebhookHandler| | |config.connectionId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the connection this webhook handler belongs to | #### Returns | Return type | Status code | Description | |---|---|---| |[WebhookHandler](#webhookhandler)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { webhookHandlersClient } from "@dynatrace-sdk/client-automation"; const data = await webhookHandlersClient.writeWebhookHandler({ connectionId: "...", body: { connectionId: "...", webhookUrl: "...", active: false, validationMethod: "slack", eventSignatureHeader: "...", }, }); ```

## workflowsClient ```js import { workflowsClient } from '@dynatrace-sdk/client-automation'; ``` ### createWorkflow

workflowsClient.createWorkflow(config): Promise<Workflow>

**Required scope:** automation:workflows:write Creates a workflow and sets usages

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.createWorkflow({ body: { title: "...", throttle: { isLimitHit: false } }, }); ```

### deleteWorkflow

workflowsClient.deleteWorkflow(config): Promise<void>

**Required scope:** automation:workflows:write

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.deleteWorkflow({ id: "...", }); ```

### duplicateWorkflow

workflowsClient.duplicateWorkflow(config): Promise<Workflow>

**Required scope:** automation:workflows:write

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.duplicateWorkflow({ id: "...", body: {}, }); ```

### exportWorkflow

workflowsClient.exportWorkflow(config): Promise<WorkflowExport>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.exportWorkflow({ id: "...", }); ```

### exportWorkflowHistoryRecord

workflowsClient.exportWorkflowHistoryRecord(config): Promise<Workflow>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.exportWorkflowHistoryRecord({ id: "...", version: "...", }); ```

### exportWorkflowHistoryRecordTemplate

workflowsClient.exportWorkflowHistoryRecordTemplate(config): Promise<WorkflowTemplate>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.exportWorkflowHistoryRecordTemplate( { id: "...", version: "..." }, ); ```

### exportWorkflowTemplate

workflowsClient.exportWorkflowTemplate(config): Promise<WorkflowTemplate>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.exportWorkflowTemplate({ id: "...", }); ```

### getWorkflow

workflowsClient.getWorkflow(config): Promise<Workflow>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflow({ id: "...", }); ```

### getWorkflowActions

workflowsClient.getWorkflowActions(config): Promise<Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>>

**Required scope:** automation:workflows:read Return list of actions assigned to tasks in a given Workflow.

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflowActions({ id: "...", }); ```

### getWorkflowHistoryRecord

workflowsClient.getWorkflowHistoryRecord(config): Promise<Workflow>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflowHistoryRecord( { id: "...", version: "..." }, ); ```

### getWorkflowHistoryRecords

workflowsClient.getWorkflowHistoryRecords(config): Promise<PaginatedChangeHistory>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflowHistoryRecords({ id: "...", }); ```

### getWorkflowTask

workflowsClient.getWorkflowTask(config): Promise<Task>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflowTask({ id: "...", workflowId: "...", }); ```

### getWorkflowTasks

workflowsClient.getWorkflowTasks(config): Promise<Tasks>

**Required scope:** automation:workflows:read

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflowTasks({ id: "...", }); ```

### getWorkflows

workflowsClient.getWorkflows(config): Promise<PaginatedWorkflowList>

**Required scope:** automation:workflows:read

#### Parameters | Name | Type | Description | | --- | --- | --- | |config.adminAccess|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Allow access to all workflows/executions - additionally requires automation:workflows:admin | |config.id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.isDeployed|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |config.lastExecutionStateIn|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | |config.limit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Number of results to return per page. | |config.modificationInfoLastModifiedBy|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Multiple values may be separated by commas. | |config.offset|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The initial index from which to return the results. | |config.ordering|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Which field to use when ordering the results. | |config.owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.ownerType|"GROUP" | "USER"| | |config.search|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A search term. | |config.throttleIsLimitHit|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |config.triggerScheduleIsFaulty|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |config.triggerType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.unacknowledgedSkippedScheduleAtGte|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |config.unacknowledgedSkippedScheduleAtLte|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | #### Returns | Return type | Status code | Description | |---|---|---| |[PaginatedWorkflowList](#paginatedworkflowlist)|200|| #### Throws | Error Type | Error Message | |---|---| |ErrorEnvelopeError||

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.getWorkflows(); ```

### patchWorkflow

workflowsClient.patchWorkflow(config): Promise<Workflow>

**Required scope:** automation:workflows:write

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.patchWorkflow({ id: "...", body: { throttle: { isLimitHit: false } }, }); ```

### resetWorkflowThrottles

workflowsClient.resetWorkflowThrottles(config): Promise<WorkflowThrottlesResetStatus>

**Required scope:** automation:workflows:write

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.resetWorkflowThrottles({ id: "...", }); ```

### restoreWorkflowHistoryRecord

workflowsClient.restoreWorkflowHistoryRecord(config): Promise<void>

**Required scope:** automation:workflows:write Restores the workflow to the specified history version which is deployed afterward.

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.restoreWorkflowHistoryRecord({ id: "...", version: "...", }); ```

### runWorkflow

workflowsClient.runWorkflow(config): Promise<Execution>

**Required scope:** automation:workflows:run Creates an Execution for the Workflow.

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.runWorkflow({ id: "...", body: { input: {}, params: {} }, }); ```

### updateWorkflow

workflowsClient.updateWorkflow(config): Promise<Workflow>

**Required scope:** automation:workflows:write

Code example

```ts import { workflowsClient } from "@dynatrace-sdk/client-automation"; const data = await workflowsClient.updateWorkflow({ id: "...", body: { throttle: { isLimitHit: false } }, }); ```

## Types ### ActionExecution | Name | Type | Description | | --- | --- | --- | |action^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |actionExecutionId|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |attempt|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |endedAt|null | Date| | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|ActionExecutionInput| | |loopItem|ActionExecutionLoopItem| | |result|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| | |runtime|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |startedAt|null | Date| | |state|"ERROR" | "IDLE" | "RUNNING" | "SUSPENDED" | "SUCCESS" | "UNKNOWN"| | |stateInfo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |taskExe^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Parent task execution | ### ActionExecutionInput **type**: Record<string, any> ### ActionExecutionLoopItem **type**: Record<string, any> ### BasedOnTemplate | Name | Type | | --- | --- | |originAppId|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |title|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |trackingId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |version|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### BusinessCalendarCreate | Name | Type | | --- | --- | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |holidays|Holidays| |id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |validFrom|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |validTo|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |weekdays|Weekdays| |weekstart|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### BusinessCalendarResponse | Name | Type | Description | | --- | --- | --- | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |holidays|Holidays| | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |modificationInfo^*required|ModificationInfo| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |validFrom|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |validTo|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |version^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |weekdays^*required|WeekdaysValues|The weekdays values | |weekdaysNames^*required|WeekdaysNames|The weekdays names | |weekstart|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | ### BusinessCalendarUpdate | Name | Type | | --- | --- | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |holidays|Holidays| |title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |validFrom|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |validTo|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |weekdays|Weekdays| |weekstart|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### ChangeHistory | Name | Type | | --- | --- | |dateCreated^*required|Date| |id^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |user^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |version^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### Country | Name | Type | | --- | --- | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### CountryList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<Country>| ### CronTrigger | Name | Type | | --- | --- | |cron^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |type^*required|"cron"| ### DavisEventConfig | Name | Type | Description | | --- | --- | --- | |customFilter|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional DQL matcher expression to further filter events to match. default: ""| |entityTags|null | EntityTags| | |entityTagsMatch|"all" | "any"| | |maintenanceWindowTriggerBehavior|"always" | "inside" | "outside"| default: "always"| |names|null | Array<DavisEventName>| | |onProblemClose|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Trigger on Davis event open only or also on close. default: false| |~~types~~^{**DEPRECATED**}|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | ### DavisEventName | Name | Type | Description | | --- | --- | --- | |match^*required|"equals" | "contains"|Davis event name must equal or contain the string provided. | |name^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### DavisEventTriggerConfig | Name | Type | | --- | --- | |type^*required|"davis-event"| |value^*required|DavisEventConfig| ### DavisProblemCategories | Name | Type | Default | | --- | --- | --- | |availability|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |custom|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |error|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |info|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |monitoringUnavailable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |resource|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| |slowdown|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| false| ### DavisProblemConfig | Name | Type | Description | | --- | --- | --- | |analysisReady|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Run only after first root cause analysis run completed. default: false| |categories^*required|DavisProblemCategories| | |customFilter|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional DQL matcher expression to further filter events to match. default: ""| |entityTags|null | EntityTags| | |entityTagsMatch|"all" | "any"| | |onProblemClose|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Trigger on Davis problem open only or also on close. default: false| ### DavisProblemTriggerConfig | Name | Type | | --- | --- | |type^*required|"davis-problem"| |value^*required|DavisProblemConfig| ### DuplicationRequest | Name | Type | | --- | --- | |title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### EntityTags Entity tags to match by key and (optional) values. For example \{"foo": [], "bar": ["a", "b", "c"]} **type**: Record<string, string | string[]> ### EnvironmentObject | Name | Type | | --- | --- | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |limits^*required|ExecutionLimits| |workflowsCount^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |workflowsLimit|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### Error | Name | Type | | --- | --- | |code^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |details|ErrorDetails| |message^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### ErrorDetails | Name | Type | | --- | --- | |errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### ErrorEnvelope | Name | Type | | --- | --- | |error^*required|Error| ### EventLog | Name | Type | | --- | --- | |cause|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |context|null | EventLogContext| |event^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |source^*required|Source| |state^*required|"ERROR" | "IDLE" | "RUNNING" | "SUCCESS" | "DEACTIVATED" | "WAITING" | "PAUSED" | "CANCELLED" | "SKIPPED" | "DISCARDED"| |timestamp^*required|Date| ### EventLogContext **type**: Record<string, any> ### EventLogs **type**: Array<EventLog> ### EventQuery | Name | Type | Description | | --- | --- | --- | |eventType|"events" | "bizevents" | "dt.system.events" | "security.events"|Grail event type. | |query^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|DQL matcher expression defining which events to match. | ### EventQueryTriggerConfig | Name | Type | | --- | --- | |type^*required|"event"| |value^*required|EventQuery| ### EventTrigger | Name | Type | | --- | --- | |filterQuery^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |triggerConfiguration|EventTriggerConfig| |uniqueExpression^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### EventTriggerExport | Name | Type | | --- | --- | |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |triggerConfiguration|EventTriggerConfig| ### EventTriggerPreviewRequest | Name | Type | | --- | --- | |triggerConfiguration^*required|EventTriggerConfig| ### EventTriggerPreviewResponse | Name | Type | | --- | --- | |filterQuery^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |triggerConfiguration^*required|EventTriggerConfig| ### EventTriggerRequest | Name | Type | | --- | --- | |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |triggerConfiguration|EventTriggerConfig| ### Execution | Name | Type | Description | | --- | --- | --- | |actor^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |endedAt|null | Date| | |eventTrigger|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|ExecutionInput| | |isDraft|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |params|ExecutionParams| | |parentExecution^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |parentTaskName^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Parent task execution's name (subworkflows only) | |providedInput|null | ExecutionProvidedInput| | |result|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| | |rootExecution|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |rootWorkflow|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |runtime^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

Calculate the runtime of an execution in seconds. If the execution is not ended, runtime is calculated until now.

| |schedule|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |startedAt|Date| | |state^*required|"ERROR" | "RUNNING" | "SUCCESS" | "UNKNOWN" | "PAUSED" | "CANCELLED"| | |stateInfo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |triggerType^*required|"Manual" | "Schedule" | "Event" | "Workflow"| | |triggerTypeDetail|TriggerTypeDetail| | |user|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |workflow^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Executed Workflow | |workflowType^*required|"STANDARD" | "SIMPLE"| | |workflowVersion^*required|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | ### ExecutionInput **type**: Record<string, any> ### ExecutionInputsRequest Inputs for workflow executions | Name | Type | Description | | --- | --- | --- | |input|ExecutionInputsRequestInput|Inputs (key/value pairs) default: {}| |params|ExecutionInputsRequestParams|Metadata (can be nested object) default: {}| |uniqueQualifier|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A qualifier that must not have been used before to trigger the execution | ### ExecutionInputsRequestInput Inputs (key/value pairs) **type**: Record<string, any> ### ExecutionInputsRequestParams Metadata (can be nested object) **type**: Record<string, any> ### ExecutionLimits | Name | Type | | --- | --- | |hourlyEventTriggerSimple^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |hourlyEventTriggerStandard^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |hourlyExecutionDefaultSimple^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |hourlyExecutionDefaultStandard^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |hourlyExecutionUpperBoundSimple^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |hourlyExecutionUpperBoundStandard^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### ExecutionParams **type**: Record<string, any> ### ExecutionProvidedInput **type**: Record<string, any> ### FixedOffsetRule | Name | Type | Description | | --- | --- | --- | |offset^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Offset days | |rule^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### FixedOffsetRulePreviewRequest | Name | Type | Description | | --- | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |count|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 10| |dateFrom|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Start date for the preview range (yyyy-mm-dd). Defaults to UTC today. | |dateTo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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. | |fixedOffsetRule^*required|FixedOffsetRule| | |id|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ruleType^*required|"fixed_offset"| | ### GetServiceUsersResponse **type**: Record<string, any> ### GetSettingsResponse | Name | Type | | --- | --- | |environment^*required|EnvironmentObject| |features^*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |groupId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |policyId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |scopes^*required|GetSettingsResponseScopes| ### GetSettingsResponseScopes **type**: Record<string, string> ### GroupingRule | Name | Type | | --- | --- | |combine|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |intersect|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |subtract|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| ### GroupingRulePreviewRequest | Name | Type | Description | | --- | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |count|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 10| |dateFrom|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Start date for the preview range (yyyy-mm-dd). Defaults to UTC today. | |dateTo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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. | |groupingRule^*required|GroupingRule| | |id|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ruleType^*required|"grouping"| | ### Holiday | Name | Type | | --- | --- | |date^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### HolidayCalendarList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<Holiday>| ### Holidays **type**: Array<Holiday> ### IntervalTrigger | Name | Type | Description | | --- | --- | --- | |betweenEnd|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^(\[0-1]\\d|2\[0-3]):\[0-5]\\d$| |betweenStart|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^(\[0-1]\\d|2\[0-3]):\[0-5]\\d$| |intervalMinutes^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |type^*required|"interval"| | ### ModificationInfo | Name | Type | | --- | --- | |createdBy^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |createdTime^*required|Date| |lastModifiedBy^*required|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |lastModifiedTime^*required|Date| ### OnceTrigger | Name | Type | Description | | --- | --- | --- | |at^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Datetime in ISO 8601 format without timezone information.
Pattern: ^\[0-9]{4}-\[0-9]{2}-\[0-9]{2}T\[0-9]{2}:\[0-9]{2}:\[0-9]{2}$| |type^*required|"once"| | ### PaginatedBusinessCalendarResponseList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<BusinessCalendarResponse>| ### PaginatedChangeHistory | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<ChangeHistory>| ### PaginatedExecutionList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<Execution>| ### PaginatedRuleList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<Rule>| ### PaginatedWorkflowList | Name | Type | | --- | --- | |count^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |results^*required|Array<WorkflowList>| ### RRule | Name | Type | Description | | --- | --- | --- | |byday|Array<"MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU">|Define the weekdays where the recurrence will be applied. | |bymonth|null | Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The months to apply the recurrence to. | |bymonthday|null | Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The month days to apply the recurrence to. | |bysetpos|null | Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|Each given integer will specify an occurrence number, corresponding to the nth occurrence of the rule inside the frequency period | |byweekno|null | Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The week numbers to apply the recurrence to. | |byworkday|"WORKING" | "HOLIDAYS" | "OFF"|The type of days on which the recurrence will be applied. | |byyearday|null | Array<[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)>|The year days to apply the recurrence to. | |datestart^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The recurrence start. | |freq^*required|"YEARLY" | "MONTHLY" | "WEEKLY" | "DAILY" | "HOURLY" | "MINUTELY" | "SECONDLY"| | |interval|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The interval between each freq iteration. default: 1| |until|null | Date|Specifying the upper-bound limit of the recurrence. | |wkst|"MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU"|The week start day. | ### RRulePreviewRequest | Name | Type | Description | | --- | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |count|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 10| |dateFrom|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Start date for the preview range (yyyy-mm-dd). Defaults to UTC today. | |dateTo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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. | |id|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |rrule^*required|RRule| | |ruleType^*required|"rrule"| | ### RelativeOffsetRule | Name | Type | | --- | --- | |direction^*required|"next" | "previous"| |sourceRule^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |targetRule^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### RelativeOffsetRulePreviewRequest | Name | Type | Description | | --- | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |count|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 10| |dateFrom|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Start date for the preview range (yyyy-mm-dd). Defaults to UTC today. | |dateTo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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. | |id|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |relativeOffsetRule^*required|RelativeOffsetRule| | |ruleType^*required|"relative_offset"| | ### Rule | Name | Type | | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |fixedOffsetRule|null | FixedOffsetRule| |groupingRule|null | GroupingRule| |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |modificationInfo^*required|ModificationInfo| |relativeOffsetRule|null | RelativeOffsetRule| |rrule|null | RRule| |ruleType^*required|"fixed_offset" | "grouping" | "rrule" | "relative_offset"| |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |version^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### RuleCreate | Name | Type | | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |fixedOffsetRule|null | FixedOffsetRule| |groupingRule|null | GroupingRule| |id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |relativeOffsetRule|null | RelativeOffsetRule| |rrule|null | RRule| |ruleType^*required|"fixed_offset" | "grouping" | "rrule" | "relative_offset"| |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### RulePreviewResponse | Name | Type | | --- | --- | |error|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |nextExecutions|null | Array<Date>| |valid^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| ### RuleUpdate | Name | Type | | --- | --- | |businessCalendar|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |fixedOffsetRule|null | FixedOffsetRule| |groupingRule|null | GroupingRule| |relativeOffsetRule|null | RelativeOffsetRule| |rrule|null | RRule| |ruleType|"fixed_offset" | "grouping" | "rrule" | "relative_offset"| |title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### Schedule | Name | Type | | --- | --- | |filterParameters|null | ScheduleFilterParameters| |inputs|ScheduleInputs| |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |isFaulty^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |nextExecution|null | Date| |rule|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |timezone|"Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"| |trigger^*required|ScheduleTrigger| ### ScheduleExport | Name | Type | | --- | --- | |filterParameters|null | ScheduleFilterParameters| |inputs|ScheduleInputs| |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |rule|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |timezone|"Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"| |trigger^*required|ScheduleTrigger| ### ScheduleFilterParameters | Name | Type | Default | | --- | --- | --- | |count|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| 10| |earliestStart|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |earliestStartTime|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| "00:00:00"| |excludeDates|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | |includeDates|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | |until|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### ScheduleInput | Name | Type | | --- | --- | |type^*required|"static"| |value^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### ScheduleInputs **type**: Record<string, ScheduleInput> ### SchedulePreviewRequest | Name | Type | | --- | --- | |schedule^*required|ScheduleRequest| ### SchedulePreviewResponse | Name | Type | | --- | --- | |error|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |nextExecutions|null | Array<Date>| |valid^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| ### ScheduleRequest | Name | Type | | --- | --- | |filterParameters|null | ScheduleFilterParameters| |isActive|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |rule|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |timezone|"Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"| |trigger^*required|ScheduleTrigger| ### Source | Name | Type | | --- | --- | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |model^*required|"Execution" | "TaskExecution" | "ActionExecution"| |str^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |userStr^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### Task | Name | Type | Description | | --- | --- | --- | |action^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^.+:.+$| |active|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Specifies whether a task should be skipped as a no operation or not. default: true| |concurrency|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |conditions|null | TaskConditionOption| | |customSampleResult|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| | |description|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|null | TaskInput| | |name|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |position|null | TaskPosition| | |predecessors|null | Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | |retry|null | TaskRetryOption| | |timeout|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specifies a default task timeout. 60 \* 60 (60min) is used when not set. default: 3600| |waitBefore|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specifies a default task wait before in seconds. 0 is used when not set. default: 0| |withItems|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### TaskConditionOption | Name | Type | | --- | --- | |custom|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |else|"SKIP" | "STOP"| |states|null | TaskConditionOptionStates| ### TaskConditionOptionStates **type**: Record<string, "SUCCESS" | "ERROR" | "ANY" | "OK" | "NOK"> ### TaskExecution | Name | Type | Description | | --- | --- | --- | |action|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |active^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether task is active | |conditionResults|TaskExecutionConditionResults| | |conditions^*required|TaskExecutionConditions| | |description|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |endedAt^*required|null | Date| | |errorReason|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |execution^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Parent execution | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|TaskExecutionInput| | |isApproval|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Whether this task is an approval request | |name^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |position^*required|TaskPosition| | |predecessors^*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| | |result^*required|[any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)| | |runtime^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|

Calculate the runtime of a task execution in seconds. If the task execution is not ended, runtime is calculated until now.

| |startedAt^*required|null | Date| | |state^*required|"ERROR" | "IDLE" | "RUNNING" | "SUCCESS" | "UNKNOWN" | "WAITING" | "CANCELLED" | "SKIPPED" | "DISCARDED" | "AWAITING_APPROVAL" | "POST_PROCESSING"| | |stateInfo|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | ### TaskExecutionConditionResults **type**: Record<string, any> ### TaskExecutionConditions **type**: Record<string, any> ### TaskExecutionInput **type**: Record<string, any> ### TaskExecutions **type**: Record<string, TaskExecution> ### TaskInput **type**: Record<string, any> ### TaskPosition | Name | Type | | --- | --- | |x^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |y^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| ### TaskRetryOption | Name | Type | Description | | --- | --- | --- | |count^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specifies a maximum number of times that a task can be repeated in case it fails on execution. | |delay|[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Specifies a delay in seconds between subsequent task retries | |failedLoopIterationsOnly|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Specifies whether retrying the failed iterations or the whole loop. Default: True. default: true| ### TaskTransition The TaskTransitionSerializer inlines the related workflow object and list of variables. Runtime is added as a property and calculated using the started_at and ended_at timestamps. | Name | Type | | --- | --- | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |taskNameFrom^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |taskNameTo^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### TaskTransitions **type**: Record<string, TaskTransition> ### Tasks **type**: Record<string, Task> ### Throttle | Name | Type | | --- | --- | |isLimitHit^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |limitEvents^*required|ThrottleLimitEvents| ### ThrottleLimitEvent | Name | Type | | --- | --- | |limit^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |timeLeftInSeconds^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |timestamp^*required|Date| |type^*required|"workflow" | "event_trigger"| ### ThrottleLimitEvents **type**: Array<ThrottleLimitEvent> ### ThrottleRequest | Name | Type | | --- | --- | |isLimitHit^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| ### TimeTrigger | Name | Type | Description | | --- | --- | --- | |time^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| Pattern: ^(\[0-1]\\d|2\[0-3]):\[0-5]\\d$| |type^*required|"time"| | ### Trigger | Name | Type | | --- | --- | |eventTrigger|null | EventTrigger| |schedule|null | Schedule| ### TriggerExport | Name | Type | | --- | --- | |eventTrigger|null | EventTriggerExport| |schedule|null | ScheduleExport| ### TriggerManualDetail | Name | Type | | --- | --- | |userId|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### TriggerRequest | Name | Type | | --- | --- | |eventTrigger|null | EventTriggerRequest| |schedule|null | ScheduleRequest| ### TriggerSubTypeDetail | Name | Type | | --- | --- | |subType|"CUSTOM" | "DAVIS_PROBLEM" | "DAVIS_EVENT" | "FIXED_INTERVAL" | "TIME_OF_DAY" | "CRON" | "ONCE"| ### TriggerWorkflowDetail | Name | Type | | --- | --- | |workflowTitle|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### UserSettings | Name | Type | | --- | --- | |groups^*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| ### VersionResponse | Name | Type | | --- | --- | |version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WebhookHandler | Name | Type | | --- | --- | |active^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |connectionId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |eventSignatureHeader^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |hmacSignatureEncoding|"hex" | "base64"| |hmacSignaturePrefix|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |slackSigningSecret|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |staticSecret|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |validationMethod^*required|"static" | "slack" | "hmac-sha256"| |webhookUrl^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WebhookHandlerList | Name | Type | | --- | --- | |active^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |connectionId^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |webhookUrl^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WeekdaysNames **type**: Array<"MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU"> ### WeekdaysValues **type**: Array<1 | 2 | 3 | 4 | 5 | 6 | 7> ### Workflow Workflow can define multiple tasks and have at most one automatic trigger. In undeployed state, a workflow is not billed and its automatic trigger won't be running. | Name | Type | Description | | --- | --- | --- | |actor|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |guide|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 1000| |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|WorkflowInput| | |isDeployed|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |isPrivate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |lastExecution^*required|null | Execution| | |modificationInfo^*required|ModificationInfo| | |owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ownerType|"GROUP" | "USER"| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |taskDefaults|WorkflowTaskDefaults| | |tasks|Tasks| | |throttle|Throttle| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|Trigger| | |triggerType^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |type|"STANDARD" | "SIMPLE"|Workflow type. | |unacknowledgedSkippedScheduleAt|null | Date| | |version^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |workflowLimit^*required|WorkflowLimit| | ### WorkflowCreate Workflow can define multiple tasks and have at most one automatic trigger. In undeployed state, a workflow is not billed and its automatic trigger won't be running. | Name | Type | Description | | --- | --- | --- | |actor|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |basedOnTemplate|null | BasedOnTemplate| | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |guide|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 1000| |id|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|WorkflowCreateInput| | |isDeployed|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |isPrivate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ownerType|"GROUP" | "USER"| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |taskDefaults|WorkflowCreateTaskDefaults| | |tasks|Tasks| | |throttle|ThrottleRequest| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|TriggerRequest| | |type|"STANDARD" | "SIMPLE"|Workflow type. | |unacknowledgedSkippedScheduleAt|null | Date| | ### WorkflowCreateInput **type**: Record<string, any> ### WorkflowCreateTaskDefaults **type**: Record<string, any> ### WorkflowDefinitionTemplate | Name | Type | Description | | --- | --- | --- | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |guide|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 1000| |input|WorkflowDefinitionTemplateInput| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |tasks|Tasks| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|TriggerExport| | |type|"STANDARD" | "SIMPLE"|Workflow type. | ### WorkflowDefinitionTemplateInput **type**: Record<string, any> ### WorkflowExport | Name | Type | Description | | --- | --- | --- | |actor|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |guide|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 1000| |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|WorkflowExportInput| | |isPrivate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ownerType|"GROUP" | "USER"| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |tasks|Tasks| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|TriggerExport| | |type|"STANDARD" | "SIMPLE"|Workflow type. | ### WorkflowExportInput **type**: Record<string, any> ### WorkflowInput **type**: Record<string, any> ### WorkflowLimit | Name | Type | | --- | --- | |isActive^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| |throttle|ThrottleLimitEvent| ### WorkflowList | Name | Type | Description | | --- | --- | --- | |actor|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |input|WorkflowListInput| | |isDeployed|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |isPrivate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| | |lastExecution^*required|null | Execution| | |modificationInfo^*required|ModificationInfo| | |owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ownerType|"GROUP" | "USER"| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |taskDefaults|WorkflowListTaskDefaults| | |tasks|Tasks| | |throttle|Throttle| | |title^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|Trigger| | |triggerType^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |type|"STANDARD" | "SIMPLE"|Workflow type. | |unacknowledgedSkippedScheduleAt|null | Date| | |version^*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |workflowLimit^*required|WorkflowLimit| | ### WorkflowListInput **type**: Record<string, any> ### WorkflowListTaskDefaults **type**: Record<string, any> ### WorkflowTaskDefaults **type**: Record<string, any> ### WorkflowTemplate | Name | Type | | --- | --- | |metadata^*required|WorkflowTemplateMetadata| |workflow^*required|WorkflowDefinitionTemplate| ### WorkflowTemplateApp | Name | Type | | --- | --- | |id^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WorkflowTemplateDependencies | Name | Type | | --- | --- | |apps^*required|Array<WorkflowTemplateApp>| ### WorkflowTemplateInput | Name | Type | | --- | --- | |schema^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |targets^*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>| |type^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WorkflowTemplateMetadata | Name | Type | | --- | --- | |dependencies^*required|WorkflowTemplateDependencies| |inputs^*required|Array<WorkflowTemplateInput>| |version^*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| ### WorkflowThrottlesResetStatus | Name | Type | | --- | --- | |success^*required|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| ### WorkflowUpdate Workflow can define multiple tasks and have at most one automatic trigger. In undeployed state, a workflow is not billed and its automatic trigger won't be running. | Name | Type | Description | | --- | --- | --- | |actor|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |description|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |guide|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |hourlyExecutionLimit|null | [number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| default: 1000| |input|WorkflowUpdateInput| | |isDeployed|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |isPrivate|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| default: true| |owner|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |ownerType|"GROUP" | "USER"| | |result|null | [string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |schemaVersion|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| | |taskDefaults|WorkflowUpdateTaskDefaults| | |tasks|Tasks| | |throttle|ThrottleRequest| | |title|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| | |trigger|TriggerRequest| | |type|"STANDARD" | "SIMPLE"|Workflow type. | |unacknowledgedSkippedScheduleAt|null | Date| | ### WorkflowUpdateInput **type**: Record<string, any> ### WorkflowUpdateTaskDefaults **type**: Record<string, any> ### EventTriggerConfig **type**: <a href="#eventquerytriggerconfig">EventQueryTriggerConfig</a> | <a href="#davisproblemtriggerconfig" target="_blank" rel="noopener noreferrer">DavisProblemTriggerConfig</a> | <a href="#daviseventtriggerconfig">DavisEventTriggerConfig</a> ### RulePreviewCreate **type**: <a href="#rrulepreviewrequest" target="_blank" rel="noopener noreferrer">RRulePreviewRequest</a> | <a href="#groupingrulepreviewrequest">GroupingRulePreviewRequest</a> | <a href="#fixedoffsetrulepreviewrequest" target="_blank" rel="noopener noreferrer">FixedOffsetRulePreviewRequest</a> | <a href="#relativeoffsetrulepreviewrequest">RelativeOffsetRulePreviewRequest</a> ### ScheduleTrigger **type**: <a href="#crontrigger" target="_blank" rel="noopener noreferrer">CronTrigger</a> | <a href="#timetrigger">TimeTrigger</a> | <a href="#intervaltrigger" target="_blank" rel="noopener noreferrer">IntervalTrigger</a> | <a href="#oncetrigger">OnceTrigger</a> ### TriggerTypeDetail **type**: <a href="#triggersubtypedetail" target="_blank" rel="noopener noreferrer">TriggerSubTypeDetail</a> | <a href="#triggerworkflowdetail">TriggerWorkflowDetail</a> | <a href="#triggermanualdetail" target="_blank" rel="noopener noreferrer">TriggerManualDetail</a> ### Weekdays **type**: <a href="#weekdaysnames">WeekdaysNames</a> | <a href="#weekdaysvalues" target="_blank" rel="noopener noreferrer">WeekdaysValues</a> ## Enums ### ~~ActionExecutionState~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~Byday~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Fr` | `Mo` | `Sa` | `Su` | `Th` | `Tu` | `We`

### ~~Byworkday~~ > ⚠️ **Deprecated** > Use literal values.

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

`Holidays` | `Off` | `Working`

### ~~CronTriggerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Cron`

### ~~DavisEventNameMatch~~ > ⚠️ **Deprecated** > Use literal values.

Davis event name must equal or contain the string provided. #### Enum keys

`Contains` | `Equals`

### ~~DavisEventTriggerConfigType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`DavisEvent`

### ~~DavisProblemTriggerConfigType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`DavisProblem`

### ~~Direction~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Next` | `Previous`

### ~~Else~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Skip` | `Stop`

### ~~EntityTagsMatch~~ > ⚠️ **Deprecated** > Use literal values.

Event must match all or any of the entity tags. #### Enum keys

`All` | `Any`

### ~~EventLogState~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~EventQueryTriggerConfigType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Event`

### ~~EventType~~ > ⚠️ **Deprecated** > Use literal values.

Grail event type. #### Enum keys

`Bizevents` | `DtSystemEvents` | `Events` | `SecurityEvents`

### ~~ExecutionState~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~FixedOffsetRulePreviewRuleType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`FixedOffset`

### ~~Freq~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~GetWorkflowsQueryOwnerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Group` | `User`

### ~~GroupingRulePreviewRuleType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Grouping`

### ~~HmacSignatureEncoding~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Base64` | `Hex`

### ~~IntervalTriggerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Interval`

### ~~MaintenanceWindowTriggerBehaviorType~~ > ⚠️ **Deprecated** > Use literal values.

Specifies when to trigger based on maintenance window status. #### Enum keys

`Always` | `Inside` | `Outside`

### ~~Model~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`ActionExecution` | `Execution` | `TaskExecution`

### ~~OnceTriggerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Once`

### ~~OwnerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Group` | `User`

### ~~RRulePreviewRuleType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Rrule`

### ~~RelativeOffsetRulePreviewRuleType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`RelativeOffset`

### ~~RuleType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`FixedOffset` | `Grouping` | `RelativeOffset` | `Rrule`

### ~~ScheduleInputType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Static`

### ~~TaskExecutionState~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~ThrottleLimitEventType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`EventTrigger` | `Workflow`

### ~~TimeTriggerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Time`

### ~~Timezone~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~TriggerSubType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~TriggerType~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Event` | `Manual` | `Schedule` | `Workflow`

### ~~ValidationMethod~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`HmacSha256` | `Slack` | `Static`

### ~~WeekdaysNamesItem~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

`Fr` | `Mo` | `Sa` | `Su` | `Th` | `Tu` | `We`

### ~~WeekdaysValuesItem~~ > ⚠️ **Deprecated** > Use literal values.

#### Enum keys

### ~~Wkst~~ > ⚠️ **Deprecated** > Use literal values.

The week start day. #### Enum keys

`Fr` | `Mo` | `Sa` | `Su` | `Th` | `Tu` | `We`

### ~~WorkflowType~~ > ⚠️ **Deprecated** > Use literal values.

Represents a Workflow type. #### Enum keys

`Simple` | `Standard`