Automation
Manage and run workflows with the AutomationEngine API.
npm install @dynatrace-sdk/client-automation
actionExecutionsClient
import { actionExecutionsClient } from '@dynatrace-sdk/client-automation';
getActionExecution
actionExecutionsClient.getActionExecution(config): Promise<ActionExecution>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this action execution. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";
const data =
await actionExecutionsClient.getActionExecution({
id: "...",
});
getActionExecutionLog
actionExecutionsClient.getActionExecutionLog(config): Promise<string>Required scope: automation:workflows:read
Returns the log output of a specific ActionExecution.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this action execution. |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";
const data =
await actionExecutionsClient.getActionExecutionLog({
id: "...",
});
actionsSampleResultClient
import { actionsSampleResultClient } from '@dynatrace-sdk/client-automation';
getActionSampleResult
actionsSampleResultClient.getActionSampleResult(config): Promise<any>Required scope: automation:workflows:read
Parameters
Name | Type |
---|
config.actionIdentifier*required | string |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { actionsSampleResultClient } from "@dynatrace-sdk/client-automation";
const data =
await actionsSampleResultClient.getActionSampleResult({
actionIdentifier: "...",
});
businessCalendarsClient
import { businessCalendarsClient } from '@dynatrace-sdk/client-automation';
createBusinessCalendar
businessCalendarsClient.createBusinessCalendar(config): Promise<BusinessCalendarResponse>Required scope: automation:calendars:write
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | 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
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 | A UUID string identifying this business calendar. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | A UUID string identifying this business calendar. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | A UUID string identifying this business calendar. |
config.version*required | string | |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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.id*required | string | A UUID string identifying this business calendar. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | Number of results to return per page. |
config.offset | number | The initial index from which to return the results. |
config.ordering | string | Which field to use when ordering the results. |
config.search | string | A search term. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.getBusinessCalendars();
patchBusinessCalendar
businessCalendarsClient.patchBusinessCalendar(config): Promise<BusinessCalendarResponse>Required scope: automation:calendars:write
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.patchBusinessCalendar({
id: "...",
body: {},
});
restoreBusinessCalendarHistoryRecord
businessCalendarsClient.restoreBusinessCalendarHistoryRecord(config): Promise<BusinessCalendarResponse>Required scope: automation:calendars:write
Parameters
Name | Type | Description |
---|
config.id*required | string | A UUID string identifying this business calendar. |
config.version*required | string | |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.updateBusinessCalendar({
id: "...",
body: {},
});
eventTriggersClient
import { eventTriggersClient } from '@dynatrace-sdk/client-automation';
previewFilter
eventTriggersClient.previewFilter(config): Promise<EventTriggerPreviewResponse>Required scope: automation:workflows:read
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { eventTriggersClient } from "@dynatrace-sdk/client-automation";
const data = await eventTriggersClient.previewFilter({
body: {
triggerConfiguration: {
type: EventQueryTriggerConfigType.Event,
value: { query: "..." },
},
},
});
executionsClient
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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
void | 204 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
config.id*required | string | Task name |
Returns
Return type | Status code | Description |
---|
void | 200 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
EventLogs | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
Execution | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getExecution({
id: "...",
});
getExecutionActions
executionsClient.getExecutionActions(config): Promise<Array<string>>Required scope: automation:workflows:read
Return list of actions assigned to tasks in a given Execution.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getExecutionActions({
id: "...",
});
getExecutionLog
executionsClient.getExecutionLog(config): Promise<string>Required scope: automation:workflows:read
Gets the execution log
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.limit | number | Number of results to return per page. |
config.offset | number | The initial index from which to return the results. |
config.ordering | string | Which field to use when ordering the results. |
config.parentExecution | string | |
config.parentWorkflow | string | |
config.schedule | Array<string> | Multiple values may be separated by commas. |
config.search | string | A search term. |
config.startedAtGte | string | |
config.startedAtLte | string | |
config.state | Array<string> | Multiple values may be separated by commas. |
config.subworkflowOfTask | string | Filter executions by parentExecution/task . |
config.trigger | string | |
config.triggerType | string | |
config.user | Array<string> | Multiple values may be separated by commas. |
config.workflow | Array<string> | Multiple values may be separated by commas. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getExecutions();
getTaskExecution
executionsClient.getTaskExecution(config): Promise<TaskExecution>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
config.id*required | string | Task name |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecution({
executionId: "...",
id: "...",
});
executionsClient.getTaskExecutionInput(config): Promise<any>Required scope: automation:workflows:read
Returns merged inputs from all ActionExecutions belonging to the TaskExecution.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
config.id*required | string | Task name |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecutionInput({
executionId: "...",
id: "...",
});
getTaskExecutionLog
executionsClient.getTaskExecutionLog(config): Promise<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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
config.id*required | string | Task name |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecutionLog({
executionId: "...",
id: "...",
});
getTaskExecutionResult
executionsClient.getTaskExecutionResult(config): Promise<any>Required scope: automation:workflows:read
Returns merged results from all ActionExecutions belonging to the TaskExecution.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
config.id*required | string | Task name |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecutions({
executionId: "...",
});
getTransitions
executionsClient.getTransitions(config): Promise<TaskTransitions>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.executionId*required | string | |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
void | 204 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.pauseExecution({
id: "...",
});
executionsClient.previewTaskInput(config): Promise<ExpressionPreviewResponse>Required scope: automation:workflows:read
Returns preview expression by given task id from the workflow definition
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.previewTaskInput({
body: {
expression: {},
task: "...",
workflow: {
title: "...",
throttle: { isLimitHit: false },
},
},
});
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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this execution. |
Returns
Return type | Status code | Description |
---|
void | 204 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.resumeExecution({
id: "...",
});
schedulesClient
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
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | From date in ISO format |
config.key*required | string | The country name |
config.to | string | To date in ISO format |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getHolidayCalendar({
key: "...",
});
getTimezones
schedulesClient.getTimezones(config): Promise<Array<string>>Required scope: automation:workflows:read
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getTimezones();
previewSchedule
schedulesClient.previewSchedule(config): Promise<SchedulePreviewResponse>Required scope: automation:workflows:read
Parameters
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.previewSchedule({
body: {
schedule: {
trigger: {
type: CronTriggerType.Cron,
cron: "0 0 * * *",
},
},
},
});
schedulingRulesClient
import { schedulingRulesClient } from '@dynatrace-sdk/client-automation';
createRule
schedulingRulesClient.createRule(config): Promise<Rule>Required scope: automation:rules:write
Parameters
Returns
Return type | Status code | Description |
---|
Rule | 201 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.createRule({
body: { title: "...", ruleType: RuleType.Rrule },
});
deleteRule
schedulingRulesClient.deleteRule(config): Promise<void>Required scope: automation:rules:write
Parameters
Name | Type | Description |
---|
config.id*required | 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
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
Returns
Return type | Status code | Description |
---|
Rule | 201 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | A UUID string identifying this rule. |
Returns
Return type | Status code | Description |
---|
Rule | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | A UUID string identifying this rule. |
config.version*required | string | |
Returns
Return type | Status code | Description |
---|
Rule | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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.id*required | string | A UUID string identifying this rule. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | Number of results to return per page. |
config.offset | number | The initial index from which to return the results. |
config.ordering | string | Which field to use when ordering the results. |
config.search | string | A search term. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | A UUID string identifying this rule. |
Returns
Return type | Status code | Description |
---|
Rule | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.patchRule({
id: "...",
body: {},
});
previewRule
schedulingRulesClient.previewRule(config): Promise<RulePreviewResponse>Required scope: automation:workflows:read
Parameters
Name | Type |
---|
config.body*required | RulePreviewCreate |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.previewRule({
body: {
ruleType: RRulePreviewRuleType.Rrule,
rrule: { freq: Freq.Yearly, datestart: "..." },
},
});
restoreRuleHistoryRecord
schedulingRulesClient.restoreRuleHistoryRecord(config): Promise<Rule>Required scope: automation:rules:write
Parameters
Name | Type | Description |
---|
config.id*required | string | A UUID string identifying this rule. |
config.version*required | string | |
Returns
Return type | Status code | Description |
---|
Rule | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.body*required | RuleUpdate | |
config.id*required | string | A UUID string identifying this rule. |
Returns
Return type | Status code | Description |
---|
Rule | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.updateRule({
id: "...",
body: {},
});
settingsClient
import { settingsClient } from '@dynatrace-sdk/client-automation';
getServiceUsers
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
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getServiceUsers();
getSettings
settingsClient.getSettings(config): Promise<GetSettingsResponse>Required scope: automation:workflows:read
Get system settings
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getSettings();
getUserPermissions
settingsClient.getUserPermissions(config): Promise<Array<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
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getUserPermissions();
getUserSettings
settingsClient.getUserSettings(config): Promise<UserSettings>Required scope: automation:workflows:read
Get user-specific settings
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getUserSettings();
updateAuthorizations
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
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.updateAuthorizations();
versionClient
import { versionClient } from '@dynatrace-sdk/client-automation';
getVersion
versionClient.getVersion(config): Promise<VersionResponse>Required scope: automation:workflows:read
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { versionClient } from "@dynatrace-sdk/client-automation";
const data = await versionClient.getVersion();
workflowsClient
import { workflowsClient } from '@dynatrace-sdk/client-automation';
createWorkflow
workflowsClient.createWorkflow(config): Promise<Workflow>Required scope: automation:workflows:write
Creates a workflow and sets usages
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.body*required | WorkflowCreate | |
Returns
Return type | Status code | Description |
---|
Workflow | 201 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
void | 204 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.deleteWorkflow({
id: "...",
});
duplicateWorkflow
workflowsClient.duplicateWorkflow(config): Promise<Workflow>Required scope: automation:workflows:write
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.body*required | DuplicationRequest | |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
Workflow | 201 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.duplicateWorkflow({
id: "...",
body: {},
});
getWorkflow
workflowsClient.getWorkflow(config): Promise<Workflow>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
Workflow | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.getWorkflow({
id: "...",
});
getWorkflowActions
workflowsClient.getWorkflowActions(config): Promise<Array<string>>Required scope: automation:workflows:read
Return list of actions assigned to tasks in a given Workflow.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
void | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.getWorkflowActions({
id: "...",
});
getWorkflowHistoryRecord
workflowsClient.getWorkflowHistoryRecord(config): Promise<Workflow>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
config.version*required | string | |
Returns
Return type | Status code | Description |
---|
Workflow | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data =
await workflowsClient.getWorkflowHistoryRecords({
id: "...",
});
getWorkflowTask
workflowsClient.getWorkflowTask(config): Promise<Task>Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | |
config.workflowId*required | string | |
Returns
Return type | Status code | Description |
---|
Task | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
Tasks | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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 | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id | string | |
config.lastExecutionStateIn | Array<string> | Multiple values may be separated by commas. |
config.limit | number | Number of results to return per page. |
config.modificationInfoLastModifiedBy | Array<string> | Multiple values may be separated by commas. |
config.offset | number | The initial index from which to return the results. |
config.ordering | string | Which field to use when ordering the results. |
config.owner | string | |
config.ownerType | "GROUP" | "USER" | |
config.search | string | A search term. |
config.throttleIsLimitHit | boolean | |
config.triggerScheduleIsFaulty | boolean | |
config.triggerType | string | |
config.type | string | |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.getWorkflows();
patchWorkflow
workflowsClient.patchWorkflow(config): Promise<Workflow>Required scope: automation:workflows:write
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.body*required | WorkflowUpdate | |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
Workflow | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.resetWorkflowThrottles({
id: "...",
});
restoreWorkflowHistoryRecord
workflowsClient.restoreWorkflowHistoryRecord(config): Promise<void>Required scope: automation:workflows:write
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.id*required | string | A UUID string identifying this workflow. |
config.version*required | string | |
Returns
Return type | Status code | Description |
---|
void | 200 | No response body |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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.
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.body*required | ExecutionInputsRequest | |
config.id*required | string | A UUID string identifying this workflow. |
config.monitor | boolean | Specifies whether the execution data of the SIMPLE workflow type is available for monitoring until the execution is complete. |
Returns
Return type | Status code | Description |
---|
Execution | 201 | Execution successfully created |
Execution | 202 | No execution created - execution with uniqueQualifier provided already exists |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
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
Parameters
Name | Type | Description |
---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.body*required | WorkflowUpdate | |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|
Workflow | 200 | |
Throws
Error Type | Error Message |
---|
ErrorEnvelopeError | |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.updateWorkflow({
id: "...",
body: { throttle: { isLimitHit: false } },
});
Types
ActionExecution
type: Record<string, any>
ActionExecutionLoopItem
type: Record<string, any>
BusinessCalendarCreate
BusinessCalendarResponse
BusinessCalendarUpdate
ChangeHistory
Name | Type |
---|
dateCreated*required | Date |
id*required | number |
user*required | string |
version*required | number |
Country
CountryList
CronTrigger
Name | Type |
---|
cron*required | string |
type*required | "cron" |
DavisEventConfig
Name | Type | Description |
---|
customFilter | string | Additional DQL matcher expression to further filter events to match. |
entityTags | EntityTags | Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]} |
entityTagsMatch | "all" | "any" | Event must match all or any of the entity tags. |
names | Array<DavisEventName> | |
onProblemClose | boolean | Trigger on Davis event open only or also on close. default: false |
typesDEPRECATED | Array<string> | |
DavisEventName
Name | Type | Description |
---|
match*required | "equals" | "contains" | Davis event name must equal or contain the string provided. |
name*required | string | |
DavisEventTriggerConfig
DavisProblemCategories
DavisProblemConfig
Name | Type | Description |
---|
categories*required | DavisProblemCategories | |
customFilter | string | Additional DQL matcher expression to further filter events to match. |
entityTags | EntityTags | Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]} |
entityTagsMatch | "all" | "any" | Event must match all or any of the entity tags. |
onProblemClose | boolean | Trigger on Davis problem open only or also on close. default: false |
DavisProblemTriggerConfig
DuplicationRequest
Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}
type: Record<string, string | string[] | undefined>
Error
ErrorDetails
type: Record<string, any>
ErrorEnvelope
Name | Type |
---|
error*required | Error |
EventLog
Name | Type |
---|
cause | string |
context | Record<string | any> |
event*required | string |
source*required | Source |
state*required | "ERROR" | "IDLE" | "RUNNING" | "SUCCESS" | "DEACTIVATED" | "WAITING" | "PAUSED" | "CANCELLED" | "SKIPPED" | "DISCARDED" |
timestamp*required | Date |
EventLogs
type: Array<EventLog>
EventQuery
Name | Type | Description |
---|
eventType | "events" | "bizevents" | "dt.system.events" | Grail event type. |
query*required | string | DQL matcher expression defining which events to match. |
EventQueryTriggerConfig
Name | Type |
---|
type*required | "event" |
value*required | EventQuery |
EventTrigger
Name | Type |
---|
filterQuery*required | string |
isActive | boolean |
triggerConfiguration | EventTriggerConfig |
uniqueExpression*required | null | string |
EventTriggerPreviewRequest
Name | Type |
---|
triggerConfiguration*required | EventTriggerConfig |
EventTriggerPreviewResponse
EventTriggerRequest
Name | Type |
---|
isActive | boolean |
triggerConfiguration | EventTriggerConfig |
Execution
Name | Type | Description |
---|
actor*required | string | |
endedAt | null | Date | |
eventTrigger | null | string | |
id*required | string | |
input | ExecutionInput | |
params | ExecutionParams | |
parentExecution*required | null | string | |
parentTaskName*required | null | string | Parent task execution's name (subworkflows only) |
providedInput | null | ExecutionProvidedInput | |
result | ExecutionResult | |
rootExecution | null | string | |
rootWorkflow | null | string | |
runtime*required | number | Calculate the runtime of an execution in seconds. If the Execution is not ended, runtime is calculated until now. |
schedule | null | string | |
startedAt | Date | |
state*required | "ERROR" | "RUNNING" | "SUCCESS" | "UNKNOWN" | "PAUSED" | "CANCELLED" | |
stateInfo | null | string | |
title*required | string | |
trigger | null | string | |
triggerType*required | "Manual" | "Schedule" | "Event" | "Workflow" | |
triggerTypeDetail | TriggerTypeDetail | |
user | null | string | |
workflow*required | string | Executed Workflow |
workflowType*required | "STANDARD" | "SIMPLE" | |
workflowVersion*required | null | number | |
type: Record<string, any>
Inputs for workflow executions
Name | Type | Description |
---|
input | ExecutionInputsRequestInput | Inputs (key/value pairs) default:
|
params | ExecutionInputsRequestParams | Metadata (can be nested object) default:
|
uniqueQualifier | string | A qualifier that must not have been used before to trigger the execution |
ExecutionParams
type: Record<string, any>
type: Record<string, any>
ExecutionResult
type: Record<string, any>
ExpressionPreviewResponse
FixedOffsetRule
Name | Type | Description |
---|
offset*required | number | Offset days |
rule*required | string | |
FixedOffsetRulePreviewRequest
GetServiceUsersResponse
type: Record<string, any>
GetSettingsResponse
type: Record<string, any>
GroupingRule
GroupingRulePreviewRequest
Holiday
Name | Type |
---|
date*required | Date |
title*required | string |
HolidayCalendarList
Holidays
type: Array<Holiday>
IntervalTrigger
Name | Type |
---|
betweenEnd | string |
betweenStart | string |
intervalMinutes*required | number |
type*required | "interval" |
ModificationInfo
Name | Type |
---|
createdBy*required | null | string |
createdTime*required | Date |
lastModifiedBy*required | null | string |
lastModifiedTime*required | Date |
PaginatedBusinessCalendarResponseList
PaginatedChangeHistory
PaginatedExecutionList
PaginatedRuleList
Name | Type |
---|
count*required | number |
results*required | Array<Rule> |
PaginatedWorkflowList
type: Record<string, any>
type: Record<string, any>
RRule
Name | Type | Description |
---|
byday | Array<"MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU"> | Define the weekdays where the recurrence will be applied. |
bymonth | Array<number> | The months to apply the recurrence to. |
bymonthday | Array<number> | The month days to apply the recurrence to. |
bysetpos | Array<number> | Each given integer will specify an occurrence number, corresponding to the nth occurrence of the rule inside the frequency period |
byweekno | Array<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 | Array<number> | The year days to apply the recurrence to. |
datestart*required | Date | The recurrence start. |
freq*required | "YEARLY" | "MONTHLY" | "WEEKLY" | "DAILY" | "HOURLY" | "MINUTELY" | "SECONDLY" | |
interval | number | The interval between each freq iteration. default: 1 |
until | Date | Specifying the upper-bound limit of the recurrence. |
wkst | "MO" | "TU" | "WE" | "TH" | "FR" | "SA" | "SU" | The week start day. |
RRulePreviewRequest
RelativeOffsetRule
Name | Type |
---|
direction*required | "next" | "previous" |
sourceRule*required | string |
targetRule*required | string |
RelativeOffsetRulePreviewRequest
Rule
RuleCreate
RulePreviewResponse
Name | Type |
---|
error | string |
nextExecutions | Array<Date> |
valid*required | boolean |
RuleUpdate
Schedule
Name | Type |
---|
filterParameters | null | ScheduleFilterParameters |
inputs | ScheduleInputs |
isActive | boolean |
isFaulty*required | boolean |
nextExecution | null | Date |
rule | null | 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/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "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/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/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 | 10 |
earliestStart | Date | |
earliestStartTime | string | "00:00:00" |
excludeDates | Array<Date> | |
includeDates | Array<Date> | |
until | Date | |
type: Record<string, ScheduleInput | undefined>
SchedulePreviewRequest
SchedulePreviewResponse
Name | Type |
---|
error | string |
nextExecutions | Array<Date> |
valid*required | boolean |
ScheduleRequest
Name | Type |
---|
filterParameters | null | ScheduleFilterParameters |
inputs | ScheduleInputs |
isActive | boolean |
nextExecution | null | Date |
rule | null | 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/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "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/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/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 |
model*required | "Execution" | "TaskExecution" | "ActionExecution" |
str*required | string |
userStr*required | string |
Task
TaskConditionOption
TaskConditionOptionStates
type: Record<string, "SUCCESS" | "ERROR" | "ANY" | "OK" | "NOK" | undefined>
TaskExecution
Name | Type | Description |
---|
action | null | string | |
active*required | boolean | Whether task is active |
conditionResults | TaskExecutionConditionResults | |
conditions*required | TaskExecutionConditions | |
description | null | string | |
endedAt*required | null | Date | |
execution*required | string | Parent execution |
id*required | string | |
input | TaskExecutionInput | |
name*required | string | |
position*required | TaskPosition | |
predecessors*required | Array<string> | |
result*required | any | |
runtime*required | number | Calculate the runtime of an exection in seconds. If the Execution is not ended, runtime is calculated until now. |
startedAt*required | null | Date | |
state*required | "ERROR" | "IDLE" | "RUNNING" | "SUCCESS" | "UNKNOWN" | "WAITING" | "CANCELLED" | "SKIPPED" | "DISCARDED" | |
stateInfo | null | string | |
TaskExecutionConditionResults
type: Record<string, any>
TaskExecutionConditions
type: Record<string, any>
type: Record<string, any>
TaskExecutions
type: Record<string, TaskExecution | undefined>
TaskPosition
TaskRetryOption
Name | Type | Description |
---|
count*required | string | number | Specifies a maximum number of times that a task can be repeated in case it fails on execution. |
delay | string | number | Specifies a delay in seconds between subsequent task retries |
failedLoopIterationsOnly | 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.
TaskTransitions
type: Record<string, TaskTransition | undefined>
Tasks
type: Record<string, Task | undefined>
Throttle
ThrottleLimitEvent
Name | Type |
---|
limit*required | number |
timeLeftInSeconds*required | number |
timestamp*required | Date |
type*required | "workflow" | "event_trigger" |
ThrottleLimitEvents
type: Array<ThrottleLimitEvent>
ThrottleRequest
TimeTrigger
Name | Type |
---|
time*required | string |
type*required | "time" |
Trigger
TriggerManualDetail
TriggerRequest
TriggerSubTypeDetail
Name | Type |
---|
subType | "CUSTOM" | "DAVIS_PROBLEM" | "DAVIS_EVENT" | "FIXED_INTERVAL" | "TIME_OF_DAY" | "CRON" |
TriggerWorkflowDetail
UserSettings
Name | Type |
---|
groups*required | Array<string> |
VersionResponse
Name | Type |
---|
version*required | 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 cannot have an automatic trigger.
WorkflowCreate
Workflow can define multiple tasks and have at most one automatic trigger.
In undeployed state, a workflow cannot have an automatic trigger.
type: Record<string, any>
WorkflowCreateTaskDefaults
type: Record<string, any>
type: Record<string, any>
WorkflowLimit
WorkflowTaskDefaults
type: Record<string, any>
WorkflowThrottlesResetStatus
WorkflowUpdate
Workflow can define multiple tasks and have at most one automatic trigger.
In undeployed state, a workflow cannot have an automatic trigger.
type: Record<string, any>
WorkflowUpdateTaskDefaults
type: Record<string, any>
Enums
ActionExecutionState
Enum keys
Error
| Idle
| Running
| Success
| Suspended
| Unknown
Byday
Enum keys
Fr
| Mo
| Sa
| Su
| Th
| Tu
| We
Byworkday
CronTriggerType
DavisEventNameMatch
Davis event name must equal or contain the string provided.
Enum keys
DavisEventTriggerConfigType
DavisProblemTriggerConfigType
Direction
Else
Event must match all or any of the entity tags.
Enum keys
EventLogState
Enum keys
Cancelled
| Deactivated
| Discarded
| Error
| Idle
| Paused
| Running
| Skipped
| Success
| Waiting
EventQueryTriggerConfigType
EventType
Grail event type.
Enum keys
Bizevents
| DtSystemEvents
| Events
ExecutionState
Enum keys
Cancelled
| Error
| Paused
| Running
| Success
| Unknown
FixedOffsetRulePreviewRuleType
Freq
Enum keys
Daily
| Hourly
| Minutely
| Monthly
| Secondly
| Weekly
| Yearly
GetWorkflowsQueryOwnerType
GroupingRulePreviewRuleType
IntervalTriggerType
Model
Enum keys
ActionExecution
| Execution
| TaskExecution
OwnerType
RRulePreviewRuleType
RelativeOffsetRulePreviewRuleType
RuleType
Enum keys
FixedOffset
| Grouping
| RelativeOffset
| Rrule
TaskExecutionState
Enum keys
Cancelled
| Discarded
| Error
| Idle
| Running
| Skipped
| Success
| Unknown
| Waiting
ThrottleLimitEventType
TimeTriggerType
Timezone
Enum keys
AfricaAbidjan
| AfricaAccra
| AfricaAddisAbaba
| AfricaAlgiers
| AfricaAsmara
| AfricaAsmera
| AfricaBamako
| AfricaBangui
| AfricaBanjul
| AfricaBissau
| AfricaBlantyre
| AfricaBrazzaville
| AfricaBujumbura
| AfricaCairo
| AfricaCasablanca
| AfricaCeuta
| AfricaConakry
| AfricaDakar
| AfricaDarEsSalaam
| AfricaDjibouti
| AfricaDouala
| AfricaElAaiun
| AfricaFreetown
| AfricaGaborone
| AfricaHarare
| AfricaJohannesburg
| AfricaJuba
| AfricaKampala
| AfricaKhartoum
| AfricaKigali
| AfricaKinshasa
| AfricaLagos
| AfricaLibreville
| AfricaLome
| AfricaLuanda
| AfricaLubumbashi
| AfricaLusaka
| AfricaMalabo
| AfricaMaputo
| AfricaMaseru
| AfricaMbabane
| AfricaMogadishu
| AfricaMonrovia
| AfricaNairobi
| AfricaNdjamena
| AfricaNiamey
| AfricaNouakchott
| AfricaOuagadougou
| AfricaPortoNovo
| AfricaSaoTome
| AfricaTimbuktu
| AfricaTripoli
| AfricaTunis
| AfricaWindhoek
| AmericaAdak
| AmericaAnchorage
| AmericaAnguilla
| AmericaAntigua
| AmericaAraguaina
| AmericaArgentinaBuenosAires
| AmericaArgentinaCatamarca
| AmericaArgentinaComodRivadavia
| AmericaArgentinaCordoba
| AmericaArgentinaJujuy
| AmericaArgentinaLaRioja
| AmericaArgentinaMendoza
| AmericaArgentinaRioGallegos
| AmericaArgentinaSalta
| AmericaArgentinaSanJuan
| AmericaArgentinaSanLuis
| AmericaArgentinaTucuman
| AmericaArgentinaUshuaia
| AmericaAruba
| AmericaAsuncion
| AmericaAtikokan
| AmericaAtka
| AmericaBahia
| AmericaBahiaBanderas
| AmericaBarbados
| AmericaBelem
| AmericaBelize
| AmericaBlancSablon
| AmericaBoaVista
| AmericaBogota
| AmericaBoise
| AmericaBuenosAires
| AmericaCambridgeBay
| AmericaCampoGrande
| AmericaCancun
| AmericaCaracas
| AmericaCatamarca
| AmericaCayenne
| AmericaCayman
| AmericaChicago
| AmericaChihuahua
| AmericaCoralHarbour
| AmericaCordoba
| AmericaCostaRica
| AmericaCreston
| AmericaCuiaba
| AmericaCuracao
| AmericaDanmarkshavn
| AmericaDawson
| AmericaDawsonCreek
| AmericaDenver
| AmericaDetroit
| AmericaDominica
| AmericaEdmonton
| AmericaEirunepe
| AmericaElSalvador
| AmericaEnsenada
| AmericaFortNelson
| AmericaFortWayne
| AmericaFortaleza
| AmericaGlaceBay
| AmericaGodthab
| AmericaGooseBay
| AmericaGrandTurk
| AmericaGrenada
| AmericaGuadeloupe
| AmericaGuatemala
| AmericaGuayaquil
| AmericaGuyana
| AmericaHalifax
| AmericaHavana
| AmericaHermosillo
| AmericaIndianaIndianapolis
| AmericaIndianaKnox
| AmericaIndianaMarengo
| AmericaIndianaPetersburg
| AmericaIndianaTellCity
| AmericaIndianaVevay
| AmericaIndianaVincennes
| AmericaIndianaWinamac
| AmericaIndianapolis
| AmericaInuvik
| AmericaIqaluit
| AmericaJamaica
| AmericaJujuy
| AmericaJuneau
| AmericaKentuckyLouisville
| AmericaKentuckyMonticello
| AmericaKnoxIn
| AmericaKralendijk
| AmericaLaPaz
| AmericaLima
| AmericaLosAngeles
| AmericaLouisville
| AmericaLowerPrinces
| AmericaMaceio
| AmericaManagua
| AmericaManaus
| AmericaMarigot
| AmericaMartinique
| AmericaMatamoros
| AmericaMazatlan
| AmericaMendoza
| AmericaMenominee
| AmericaMerida
| AmericaMetlakatla
| AmericaMexicoCity
| AmericaMiquelon
| AmericaMoncton
| AmericaMonterrey
| AmericaMontevideo
| AmericaMontreal
| AmericaMontserrat
| AmericaNassau
| AmericaNewYork
| AmericaNipigon
| AmericaNome
| AmericaNoronha
| AmericaNorthDakotaBeulah
| AmericaNorthDakotaCenter
| AmericaNorthDakotaNewSalem
| AmericaNuuk
| AmericaOjinaga
| AmericaPanama
| AmericaPangnirtung
| AmericaParamaribo
| AmericaPhoenix
| AmericaPortAuPrince
| AmericaPortOfSpain
| AmericaPortoAcre
| AmericaPortoVelho
| AmericaPuertoRico
| AmericaPuntaArenas
| AmericaRainyRiver
| AmericaRankinInlet
| AmericaRecife
| AmericaRegina
| AmericaResolute
| AmericaRioBranco
| AmericaRosario
| AmericaSantaIsabel
| AmericaSantarem
| AmericaSantiago
| AmericaSantoDomingo
| AmericaSaoPaulo
| AmericaScoresbysund
| AmericaShiprock
| AmericaSitka
| AmericaStBarthelemy
| AmericaStJohns
| AmericaStKitts
| AmericaStLucia
| AmericaStThomas
| AmericaStVincent
| AmericaSwiftCurrent
| AmericaTegucigalpa
| AmericaThule
| AmericaThunderBay
| AmericaTijuana
| AmericaToronto
| AmericaTortola
| AmericaVancouver
| AmericaVirgin
| AmericaWhitehorse
| AmericaWinnipeg
| AmericaYakutat
| AmericaYellowknife
| AntarcticaCasey
| AntarcticaDavis
| AntarcticaDumontDUrville
| AntarcticaMacquarie
| AntarcticaMawson
| AntarcticaMcMurdo
| AntarcticaPalmer
| AntarcticaRothera
| AntarcticaSouthPole
| AntarcticaSyowa
| AntarcticaTroll
| AntarcticaVostok
| ArcticLongyearbyen
| AsiaAden
| AsiaAlmaty
| AsiaAmman
| AsiaAnadyr
| AsiaAqtau
| AsiaAqtobe
| AsiaAshgabat
| AsiaAshkhabad
| AsiaAtyrau
| AsiaBaghdad
| AsiaBahrain
| AsiaBaku
| AsiaBangkok
| AsiaBarnaul
| AsiaBeirut
| AsiaBishkek
| AsiaBrunei
| AsiaCalcutta
| AsiaChita
| AsiaChoibalsan
| AsiaChongqing
| AsiaChungking
| AsiaColombo
| AsiaDacca
| AsiaDamascus
| AsiaDhaka
| AsiaDili
| AsiaDubai
| AsiaDushanbe
| AsiaFamagusta
| AsiaGaza
| AsiaHarbin
| AsiaHebron
| AsiaHoChiMinh
| AsiaHongKong
| AsiaHovd
| AsiaIrkutsk
| AsiaIstanbul
| AsiaJakarta
| AsiaJayapura
| AsiaJerusalem
| AsiaKabul
| AsiaKamchatka
| AsiaKarachi
| AsiaKashgar
| AsiaKathmandu
| AsiaKatmandu
| AsiaKhandyga
| AsiaKolkata
| AsiaKrasnoyarsk
| AsiaKualaLumpur
| AsiaKuching
| AsiaKuwait
| AsiaMacao
| AsiaMacau
| AsiaMagadan
| AsiaMakassar
| AsiaManila
| AsiaMuscat
| AsiaNicosia
| AsiaNovokuznetsk
| AsiaNovosibirsk
| AsiaOmsk
| AsiaOral
| AsiaPhnomPenh
| AsiaPontianak
| AsiaPyongyang
| AsiaQatar
| AsiaQostanay
| AsiaQyzylorda
| AsiaRangoon
| AsiaRiyadh
| AsiaSaigon
| AsiaSakhalin
| AsiaSamarkand
| AsiaSeoul
| AsiaShanghai
| AsiaSingapore
| AsiaSrednekolymsk
| AsiaTaipei
| AsiaTashkent
| AsiaTbilisi
| AsiaTehran
| AsiaTelAviv
| AsiaThimbu
| AsiaThimphu
| AsiaTokyo
| AsiaTomsk
| AsiaUjungPandang
| AsiaUlaanbaatar
| AsiaUlanBator
| AsiaUrumqi
| AsiaUstNera
| AsiaVientiane
| AsiaVladivostok
| AsiaYakutsk
| AsiaYangon
| AsiaYekaterinburg
| AsiaYerevan
| AtlanticAzores
| AtlanticBermuda
| AtlanticCanary
| AtlanticCapeVerde
| AtlanticFaeroe
| AtlanticFaroe
| AtlanticJanMayen
| AtlanticMadeira
| AtlanticReykjavik
| AtlanticSouthGeorgia
| AtlanticStHelena
| AtlanticStanley
| AustraliaAct
| AustraliaAdelaide
| AustraliaBrisbane
| AustraliaBrokenHill
| AustraliaCanberra
| AustraliaCurrie
| AustraliaDarwin
| AustraliaEucla
| AustraliaHobart
| AustraliaLhi
| AustraliaLindeman
| AustraliaLordHowe
| AustraliaMelbourne
| AustraliaNorth
| AustraliaNsw
| AustraliaPerth
| AustraliaQueensland
| AustraliaSouth
| AustraliaSydney
| AustraliaTasmania
| AustraliaVictoria
| AustraliaWest
| AustraliaYancowinna
| BrazilAcre
| BrazilDeNoronha
| BrazilEast
| BrazilWest
| CanadaAtlantic
| CanadaCentral
| CanadaEastern
| CanadaMountain
| CanadaNewfoundland
| CanadaPacific
| CanadaSaskatchewan
| CanadaYukon
| Cet
| ChileContinental
| ChileEasterIsland
| Cst6Cdt
| Cuba
| Eet
| Egypt
| Eire
| Est
| Est5Edt
| EtcGmt
| EtcGmt0
| EtcGmt_m0
| EtcGmt_m1
| EtcGmt_m10
| EtcGmt_m11
| EtcGmt_m12
| EtcGmt_m13
| EtcGmt_m14
| EtcGmt_m2
| EtcGmt_m3
| EtcGmt_m4
| EtcGmt_m5
| EtcGmt_m6
| EtcGmt_m7
| EtcGmt_m8
| EtcGmt_m9
| EtcGmt_p0
| EtcGmt_p1
| EtcGmt_p10
| EtcGmt_p11
| EtcGmt_p12
| EtcGmt_p2
| EtcGmt_p3
| EtcGmt_p4
| EtcGmt_p5
| EtcGmt_p6
| EtcGmt_p7
| EtcGmt_p8
| EtcGmt_p9
| EtcGreenwich
| EtcUct
| EtcUniversal
| EtcUtc
| EtcZulu
| EuropeAmsterdam
| EuropeAndorra
| EuropeAstrakhan
| EuropeAthens
| EuropeBelfast
| EuropeBelgrade
| EuropeBerlin
| EuropeBratislava
| EuropeBrussels
| EuropeBucharest
| EuropeBudapest
| EuropeBusingen
| EuropeChisinau
| EuropeCopenhagen
| EuropeDublin
| EuropeGibraltar
| EuropeGuernsey
| EuropeHelsinki
| EuropeIsleOfMan
| EuropeIstanbul
| EuropeJersey
| EuropeKaliningrad
| EuropeKiev
| EuropeKirov
| EuropeLisbon
| EuropeLjubljana
| EuropeLondon
| EuropeLuxembourg
| EuropeMadrid
| EuropeMalta
| EuropeMariehamn
| EuropeMinsk
| EuropeMonaco
| EuropeMoscow
| EuropeNicosia
| EuropeOslo
| EuropeParis
| EuropePodgorica
| EuropePrague
| EuropeRiga
| EuropeRome
| EuropeSamara
| EuropeSanMarino
| EuropeSarajevo
| EuropeSaratov
| EuropeSimferopol
| EuropeSkopje
| EuropeSofia
| EuropeStockholm
| EuropeTallinn
| EuropeTirane
| EuropeTiraspol
| EuropeUlyanovsk
| EuropeUzhgorod
| EuropeVaduz
| EuropeVatican
| EuropeVienna
| EuropeVilnius
| EuropeVolgograd
| EuropeWarsaw
| EuropeZagreb
| EuropeZaporozhye
| EuropeZurich
| Gb
| GbEire
| Gmt
| Gmt0
| Gmt_m0
| Gmt_p0
| Greenwich
| Hongkong
| Hst
| Iceland
| IndianAntananarivo
| IndianChagos
| IndianChristmas
| IndianCocos
| IndianComoro
| IndianKerguelen
| IndianMahe
| IndianMaldives
| IndianMauritius
| IndianMayotte
| IndianReunion
| Iran
| Israel
| Jamaica
| Japan
| Kwajalein
| Libya
| Met
| MexicoBajaNorte
| MexicoBajaSur
| MexicoGeneral
| Mst
| Mst7Mdt
| Navajo
| Nz
| NzChat
| PacificApia
| PacificAuckland
| PacificBougainville
| PacificChatham
| PacificChuuk
| PacificEaster
| PacificEfate
| PacificEnderbury
| PacificFakaofo
| PacificFiji
| PacificFunafuti
| PacificGalapagos
| PacificGambier
| PacificGuadalcanal
| PacificGuam
| PacificHonolulu
| PacificJohnston
| PacificKiritimati
| PacificKosrae
| PacificKwajalein
| PacificMajuro
| PacificMarquesas
| PacificMidway
| PacificNauru
| PacificNiue
| PacificNorfolk
| PacificNoumea
| PacificPagoPago
| PacificPalau
| PacificPitcairn
| PacificPohnpei
| PacificPonape
| PacificPortMoresby
| PacificRarotonga
| PacificSaipan
| PacificSamoa
| PacificTahiti
| PacificTarawa
| PacificTongatapu
| PacificTruk
| PacificWake
| PacificWallis
| PacificYap
| Poland
| Portugal
| Prc
| Pst8Pdt
| Roc
| Rok
| Singapore
| Turkey
| Uct
| Universal
| UsAlaska
| UsAleutian
| UsArizona
| UsCentral
| UsEastIndiana
| UsEastern
| UsHawaii
| UsIndianaStarke
| UsMichigan
| UsMountain
| UsPacific
| UsSamoa
| Utc
| WSu
| Wet
| Zulu
TriggerSubType
Enum keys
Cron
| Custom
| DavisEvent
| DavisProblem
| FixedInterval
| TimeOfDay
TriggerType