Automation
Manage and run workflows with the AutomationEngine API.
npm install @dynatrace-sdk/client-automation
actionExecutionsClient
import { actionExecutionsClient } from '@dynatrace-sdk/client-automation';
getActionExecution
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
Return type | Status code | Description |
---|---|---|
ActionExecution | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";
const data =
await actionExecutionsClient.getActionExecution({
id: "...",
});
getActionExecutionLog
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
⚠️ Deprecated
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
Required scope: automation:calendars:write
Parameters
Name | Type |
---|---|
config.body*required | BusinessCalendarCreate |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 201 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.createBusinessCalendar({
body: { title: "..." },
});
deleteBusinessCalendar
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
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
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 201 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.duplicateBusinessCalendar({
id: "...",
body: {},
});
getBusinessCalendar
Required scope: automation:calendars:read
Parameters
Name | Type | Description |
---|---|---|
config.id*required | string | A UUID string identifying this business calendar. |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.getBusinessCalendar({
id: "...",
});
getBusinessCalendarHistoryRecord
Required scope: automation:calendars:read
Parameters
Name | Type | Description |
---|---|---|
config.id*required | string | A UUID string identifying this business calendar. |
config.version*required | string | Pattern: ^[\d]+$ |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.getBusinessCalendarHistoryRecord(
{ id: "...", version: "..." },
);
getBusinessCalendarHistoryRecords
Required scope: automation:calendars:read
Parameters
Name | Type | Description |
---|---|---|
config.all | boolean | When false, the latest historical record is not returned. |
config.id*required | string | A UUID string identifying this business calendar. |
Returns
Return type | Status code | Description |
---|---|---|
PaginatedChangeHistory | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.getBusinessCalendarHistoryRecords(
{ id: "..." },
);
getBusinessCalendars
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
Return type | Status code | Description |
---|---|---|
PaginatedBusinessCalendarResponseList | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.getBusinessCalendars();
patchBusinessCalendar
Required scope: automation:calendars:write
Parameters
Name | Type | Description |
---|---|---|
config.body*required | BusinessCalendarUpdate | |
config.id*required | string | A UUID string identifying this business calendar. |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.patchBusinessCalendar({
id: "...",
body: {},
});
restoreBusinessCalendarHistoryRecord
Required scope: automation:calendars:write
Parameters
Name | Type | Description |
---|---|---|
config.id*required | string | A UUID string identifying this business calendar. |
config.version*required | string | Pattern: ^[\d]+$ |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.restoreBusinessCalendarHistoryRecord(
{ id: "...", version: "..." },
);
updateBusinessCalendar
Required scope: automation:calendars:write
Parameters
Name | Type | Description |
---|---|---|
config.body*required | BusinessCalendarUpdate | |
config.id*required | string | A UUID string identifying this business calendar. |
Returns
Return type | Status code | Description |
---|---|---|
BusinessCalendarResponse | 200 |
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
⚠️ Deprecated
Required scope: automation:workflows:read
Parameters
Name | Type |
---|---|
config.body*required | EventTriggerPreviewRequest |
Returns
Return type | Status code | Description |
---|---|---|
EventTriggerPreviewResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { eventTriggersClient } from "@dynatrace-sdk/client-automation";
const data = await eventTriggersClient.previewFilter({
body: {
triggerConfiguration: {
type: "event",
value: { query: "..." },
},
},
});
executionsClient
import { executionsClient } from '@dynatrace-sdk/client-automation';
cancelExecution
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
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
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
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
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
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
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
Return type | Status code | Description |
---|---|---|
PaginatedExecutionList | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getExecutions();
getTaskExecution
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
Return type | Status code | Description |
---|---|---|
TaskExecution | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecution({
executionId: "...",
id: "...",
});
getTaskExecutionInput
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
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
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
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
Return type | Status code | Description |
---|---|---|
TaskExecutions | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTaskExecutions({
executionId: "...",
});
getTransitions
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
Return type | Status code | Description |
---|---|---|
TaskTransitions | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getTransitions({
executionId: "...",
});
pauseExecution
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: "...",
});
resumeExecution
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
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 | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getCountries();
getHolidayCalendar
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
Return type | Status code | Description |
---|---|---|
HolidayCalendarList | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getHolidayCalendar({
key: "...",
});
getTimezones
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
⚠️ Deprecated
Required scope: automation:workflows:read
Parameters
Name | Type |
---|---|
config.body*required | SchedulePreviewRequest |
Returns
Return type | Status code | Description |
---|---|---|
SchedulePreviewResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.previewSchedule({
body: {
schedule: {
trigger: { type: "cron", cron: "0 0 * * *" },
},
},
});
schedulingRulesClient
import { schedulingRulesClient } from '@dynatrace-sdk/client-automation';
createRule
Required scope: automation:rules:write
Parameters
Name | Type |
---|---|
config.body*required | RuleCreate |
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: "rrule" },
});
deleteRule
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
Required scope: automation:rules:write
Parameters
Name | Type | Description |
---|---|---|
config.body*required | DuplicationRequest | |
config.id*required | string | A UUID string identifying this rule. |
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
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
Required scope: automation:rules:read
Parameters
Name | Type | Description |
---|---|---|
config.id*required | string | A UUID string identifying this rule. |
config.version*required | string | Pattern: ^[\d]+$ |
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
Required scope: automation:rules:read
Parameters
Name | Type | Description |
---|---|---|
config.all | boolean | When false, the latest historical record is not returned. |
config.id*required | string | A UUID string identifying this rule. |
Returns
Return type | Status code | Description |
---|---|---|
PaginatedChangeHistory | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data =
await schedulingRulesClient.getRuleHistoryRecords({
id: "...",
});
getRules
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
Return type | Status code | Description |
---|---|---|
PaginatedRuleList | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.getRules();
patchRule
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
⚠️ Deprecated
Required scope: automation:workflows:read
Parameters
Name | Type |
---|---|
config.body*required | RulePreviewCreate |
Returns
Return type | Status code | Description |
---|---|---|
RulePreviewResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.previewRule({
body: {
ruleType: "rrule",
rrule: { freq: "YEARLY", datestart: "..." },
},
});
restoreRuleHistoryRecord
Required scope: automation:rules:write
Parameters
Name | Type | Description |
---|---|---|
config.id*required | string | A UUID string identifying this rule. |
config.version*required | string | Pattern: ^[\d]+$ |
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
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
⚠️ Deprecated
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
⚠️ Deprecated
Required scope: automation:workflows:read
Get system settings
Returns
Return type | Status code | Description |
---|---|---|
GetSettingsResponse | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getSettings();
getUserPermissions
⚠️ Deprecated
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
⚠️ Deprecated
Required scope: automation:workflows:read
Get user-specific settings
Returns
Return type | Status code | Description |
---|---|---|
UserSettings | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getUserSettings();
updateAuthorizations
⚠️ Deprecated
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
Required scope: automation:workflows:read
Returns
Return type | Status code | Description |
---|---|---|
VersionResponse | 200 |
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
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
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
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
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
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
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 | Pattern: ^[\d]+$ |
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
Required scope: automation:workflows:read
Parameters
Name | Type | Description |
---|---|---|
config.adminAccess | boolean | Allow access to all workflows/executions - additionally requires automation:workflows:admin |
config.all | boolean | When false, the latest historical record is not returned. |
config.id*required | string | A UUID string identifying this workflow. |
Returns
Return type | Status code | Description |
---|---|---|
PaginatedChangeHistory | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data =
await workflowsClient.getWorkflowHistoryRecords({
id: "...",
});
getWorkflowTask
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
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
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.isDeployed | boolean | |
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 | |
config.unacknowledgedSkippedScheduleAtGte | string | |
config.unacknowledgedSkippedScheduleAtLte | string |
Returns
Return type | Status code | Description |
---|---|---|
PaginatedWorkflowList | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.getWorkflows();
patchWorkflow
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
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 |
---|---|---|
WorkflowThrottlesResetStatus | 200 |
Throws
Error Type | Error Message |
---|---|
ErrorEnvelopeError |
Code example
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.resetWorkflowThrottles({
id: "...",
});
restoreWorkflowHistoryRecord
Required scope: automation:workflows:write
Restores the workflow to the specified history version which is deployed afterward.
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 | Pattern: ^[\d]+$ |
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
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
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
Name | Type | Description |
---|---|---|
action*required | string | |
actionExecutionId | null | string | |
attempt | number | |
endedAt | null | Date | |
id*required | string | |
input | ActionExecutionInput | |
loopItem | ActionExecutionLoopItem | |
result | any | |
runtime | null | number | |
startedAt | null | Date | |
state | "ERROR" | "IDLE" | "RUNNING" | "SUSPENDED" | "SUCCESS" | "UNKNOWN" | |
stateInfo | null | string | |
taskExe*required | string | Parent task execution |
ActionExecutionInput
type: Record<string, any>
ActionExecutionLoopItem
type: Record<string, any>
BusinessCalendarCreate
Name | Type |
---|---|
description | string |
holidays | Holidays |
id | string |
title*required | string |
validFrom | Date |
validTo | Date |
weekdays | Weekdays |
weekstart | number |
BusinessCalendarResponse
Name | Type | Description |
---|---|---|
description | string | |
holidays | Holidays | |
id*required | string | |
modificationInfo*required | ModificationInfo | |
title*required | string | |
validFrom | Date | |
validTo | Date | |
version*required | number | |
weekdays*required | WeekdaysValues | The weekdays values |
weekdaysNames*required | WeekdaysNames | The weekdays names |
weekstart | number |
BusinessCalendarUpdate
Name | Type |
---|---|
description | string |
holidays | Holidays |
title | string |
validFrom | Date |
validTo | Date |
weekdays | Weekdays |
weekstart | number |
ChangeHistory
Name | Type |
---|---|
dateCreated*required | Date |
id*required | number |
user*required | string |
version*required | number |
Country
Name | Type |
---|---|
id*required | string |
title*required | string |
CountryList
Name | Type |
---|---|
count*required | number |
results*required | Array<Country> |
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 |
Array<string> |
DavisEventName
Name | Type | Description |
---|---|---|
match*required | "equals" | "contains" | Davis event name must equal or contain the string provided. |
name*required | string |
DavisEventTriggerConfig
Name | Type |
---|---|
type*required | "davis-event" |
value*required | DavisEventConfig |
DavisProblemCategories
Name | Type | Default |
---|---|---|
availability | boolean | false |
custom | boolean | false |
error | boolean | false |
info | boolean | false |
monitoringUnavailable | boolean | false |
resource | boolean | false |
slowdown | boolean | false |
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
Name | Type |
---|---|
type*required | "davis-problem" |
value*required | DavisProblemConfig |
DuplicationRequest
Name | Type |
---|---|
title | string |
EntityTags
Entity tags to match by key and (optional) values. For example {"foo": [], "bar": ["a", "b", "c"]}
type: Record<string, string | string[] | undefined>
EnvironmentObject
Name | Type |
---|---|
id*required | string |
limits*required | ExecutionLimits |
workflowsCount*required | number |
workflowsLimit | number |
Error
Name | Type | Description |
---|---|---|
code*required | number | |
details | ErrorDetails | Error response details according to API Guidelines |
message*required | string |
ErrorDetails
Error response details according to API Guidelines
Name | Type |
---|---|
errorCode | string |
errorRef | string |
ErrorEnvelope
Name | Type |
---|---|
error*required | Error |
EventLog
Name | Type |
---|---|
cause | string |
context | EventLogContext |
event*required | 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 | 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
Name | Type |
---|---|
filterQuery*required | string |
triggerConfiguration*required | DavisEventTriggerConfig | DavisProblemTriggerConfig | EventQueryTriggerConfig |
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 | |
isDraft | boolean | |
params | ExecutionParams | |
parentExecution*required | null | string | |
parentTaskName*required | null | string | Parent task execution's name (subworkflows only) |
providedInput | null | ExecutionProvidedInput | |
result | any | |
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 |
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 | 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 |
hourlyEventTriggerStandard*required | number |
hourlyExecutionDefaultSimple*required | number |
hourlyExecutionDefaultStandard*required | number |
hourlyExecutionUpperBoundSimple*required | number |
hourlyExecutionUpperBoundStandard*required | number |
ExecutionParams
type: Record<string, any>
ExecutionProvidedInput
type: Record<string, any>
FixedOffsetRule
Name | Type | Description |
---|---|---|
offset*required | number | Offset days |
rule*required | string |
FixedOffsetRulePreviewRequest
Name | Type | Default |
---|---|---|
businessCalendar | string | |
count | number | 10 |
fixedOffsetRule*required | FixedOffsetRule | |
id | string | |
ruleType*required | "fixed_offset" |
GetServiceUsersResponse
type: Record<string, any>
GetSettingsResponse
Name | Type |
---|---|
environment*required | EnvironmentObject |
features*required | Array<string> |
groupId*required | string |
policyId*required | string |
scopes*required | GetSettingsResponseScopes |
GetSettingsResponseScopes
type: Record<string, string | undefined>
GroupingRule
Name | Type |
---|---|
combine | Array<string> |
intersect | Array<string> |
subtract | Array<string> |
GroupingRulePreviewRequest
Name | Type | Default |
---|---|---|
businessCalendar | string | |
count | number | 10 |
groupingRule*required | GroupingRule | |
id | string | |
ruleType*required | "grouping" |
Holiday
Name | Type |
---|---|
date*required | Date |
title*required | string |
HolidayCalendarList
Name | Type |
---|---|
count*required | number |
results*required | Array<Holiday> |
Holidays
type: Array<Holiday>
IntervalTrigger
Name | Type | Description |
---|---|---|
betweenEnd | string | Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$ |
betweenStart | string | Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$ |
intervalMinutes*required | number | |
type*required | "interval" |
ModificationInfo
Name | Type |
---|---|
createdBy*required | null | string |
createdTime*required | Date |
lastModifiedBy*required | null | string |
lastModifiedTime*required | Date |
PaginatedBusinessCalendarResponseList
Name | Type |
---|---|
count*required | number |
results*required | Array<BusinessCalendarResponse> |
PaginatedChangeHistory
Name | Type |
---|---|
count*required | number |
results*required | Array<ChangeHistory> |
PaginatedExecutionList
Name | Type |
---|---|
count*required | number |
results*required | Array<Execution> |
PaginatedRuleList
Name | Type |
---|---|
count*required | number |
results*required | Array<Rule> |
PaginatedWorkflowList
Name | Type |
---|---|
count*required | number |
results*required | Array<Workflow> |
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
Name | Type | Default |
---|---|---|
businessCalendar | string | |
count | number | 10 |
id | string | |
rrule*required | RRule | |
ruleType*required | "rrule" |
RelativeOffsetRule
Name | Type |
---|---|
direction*required | "next" | "previous" |
sourceRule*required | string |
targetRule*required | string |
RelativeOffsetRulePreviewRequest
Name | Type | Default |
---|---|---|
businessCalendar | string | |
count | number | 10 |
id | string | |
relativeOffsetRule*required | RelativeOffsetRule | |
ruleType*required | "relative_offset" |
Rule
Name | Type |
---|---|
businessCalendar | null | string |
description | string |
fixedOffsetRule | null | FixedOffsetRule |
groupingRule | null | GroupingRule |
id*required | string |
modificationInfo*required | ModificationInfo |
relativeOffsetRule | null | RelativeOffsetRule |
rrule | null | RRule |
ruleType*required | "fixed_offset" | "grouping" | "rrule" | "relative_offset" |
title*required | string |
version*required | number |
RuleCreate
Name | Type |
---|---|
businessCalendar | null | string |
description | string |
fixedOffsetRule | null | FixedOffsetRule |
groupingRule | null | GroupingRule |
id | string |
relativeOffsetRule | null | RelativeOffsetRule |
rrule | null | RRule |
ruleType*required | "fixed_offset" | "grouping" | "rrule" | "relative_offset" |
title*required | string |
RulePreviewResponse
Name | Type |
---|---|
error | string |
nextExecutions | Array<Date> |
valid*required | boolean |
RuleUpdate
Name | Type |
---|---|
businessCalendar | null | string |
description | string |
fixedOffsetRule | null | FixedOffsetRule |
groupingRule | null | GroupingRule |
relativeOffsetRule | null | RelativeOffsetRule |
rrule | null | RRule |
ruleType | "fixed_offset" | "grouping" | "rrule" | "relative_offset" |
title | string |
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/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 | 10 |
earliestStart | Date | |
earliestStartTime | string | "00:00:00" |
excludeDates | Array<Date> | |
includeDates | Array<Date> | |
until | Date |
ScheduleInput
Name | Type |
---|---|
type*required | "static" |
value*required | string | number |
ScheduleInputs
type: Record<string, ScheduleInput | undefined>
SchedulePreviewRequest
Name | Type |
---|---|
schedule*required | ScheduleRequest |
SchedulePreviewResponse
Name | Type |
---|---|
error | string |
nextExecutions | Array<Date> |
valid*required | boolean |
ScheduleRequest
Name | Type |
---|---|
filterParameters | null | ScheduleFilterParameters |
isActive | boolean |
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/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 |
model*required | "Execution" | "TaskExecution" | "ActionExecution" |
str*required | string |
userStr*required | string |
Task
Name | Type | Description |
---|---|---|
action*required | string | Pattern: ^.+:.+$ |
active | string | boolean | Specifies whether a task should be skipped as a no operation or not. default: true |
concurrency | string | number | |
conditions | TaskConditionOption | |
customSampleResult | any | |
description | string | |
input | TaskInput | |
name | string | |
position | TaskPosition | |
predecessors | Array<string> | |
retry | TaskRetryOption | |
timeout | string | number | Specifies a default task timeout. 60 * 60 (60min) is used when not set. default: 3600 |
waitBefore | string | number | Specifies a default task wait before in seconds. 0 is used when not set. default: 0 |
withItems | string |
TaskConditionOption
Name | Type |
---|---|
custom | string |
else | "SKIP" | "STOP" |
states | TaskConditionOptionStates |
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>
TaskExecutionInput
type: Record<string, any>
TaskExecutions
type: Record<string, TaskExecution | undefined>
TaskInput
type: Record<string, any>
TaskPosition
Name | Type |
---|---|
x*required | number |
y*required | number |
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.
Name | Type |
---|---|
id*required | string |
taskNameFrom*required | string |
taskNameTo*required | string |
TaskTransitions
type: Record<string, TaskTransition | undefined>
Tasks
type: Record<string, Task | undefined>
Throttle
Name | Type |
---|---|
isLimitHit*required | boolean |
limitEvents*required | ThrottleLimitEvents |
ThrottleLimitEvent
Name | Type |
---|---|
limit*required | number |
timeLeftInSeconds*required | number |
timestamp*required | Date |
type*required | "workflow" | "event_trigger" |
ThrottleLimitEvents
type: Array<ThrottleLimitEvent>
ThrottleRequest
Name | Type |
---|---|
isLimitHit*required | boolean |
TimeTrigger
Name | Type | Description |
---|---|---|
time*required | string | Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$ |
type*required | "time" |
Trigger
Name | Type |
---|---|
eventTrigger | null | EventTrigger |
schedule | null | Schedule |
TriggerManualDetail
Name | Type |
---|---|
userId | 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" |
TriggerWorkflowDetail
Name | Type |
---|---|
workflowTitle | string |
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 is not billed and its automatic trigger won't be running.
Name | Type | Description |
---|---|---|
actor | null | string | |
description | string | |
hourlyExecutionLimit | null | number | default: 1000 |
id*required | string | |
input | WorkflowInput | |
isDeployed | boolean | default: true |
isPrivate | boolean | default: true |
lastExecution*required | null | Execution | |
modificationInfo*required | ModificationInfo | |
owner | string | |
ownerType | "GROUP" | "USER" | |
result | null | string | |
schemaVersion | number | |
taskDefaults | WorkflowTaskDefaults | |
tasks | Tasks | |
throttle | Throttle | |
title*required | string | |
trigger | Trigger | |
triggerType*required | string | |
type | "STANDARD" | "SIMPLE" | Workflow type. |
unacknowledgedSkippedScheduleAt | null | Date | |
version*required | 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 | |
description | string | |
hourlyExecutionLimit | null | number | default: 1000 |
id | string | |
input | WorkflowCreateInput | |
isDeployed | boolean | default: true |
isPrivate | boolean | default: true |
owner | string | |
ownerType | "GROUP" | "USER" | |
result | null | string | |
schemaVersion | number | |
taskDefaults | WorkflowCreateTaskDefaults | |
tasks | Tasks | |
throttle | ThrottleRequest | |
title*required | string | |
trigger | TriggerRequest | |
type | "STANDARD" | "SIMPLE" | Workflow type. |
unacknowledgedSkippedScheduleAt | null | Date |
WorkflowCreateInput
type: Record<string, any>
WorkflowCreateTaskDefaults
type: Record<string, any>
WorkflowInput
type: Record<string, any>
WorkflowLimit
Name | Type |
---|---|
isActive*required | boolean |
throttle | ThrottleLimitEvent |
WorkflowTaskDefaults
type: Record<string, any>
WorkflowThrottlesResetStatus
Name | Type |
---|---|
success*required | 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 | |
description | string | |
hourlyExecutionLimit | null | number | |
input | WorkflowUpdateInput | |
isDeployed | boolean | default: true |
isPrivate | boolean | default: true |
owner | string | |
ownerType | "GROUP" | "USER" | |
result | null | string | |
schemaVersion | number | |
taskDefaults | WorkflowUpdateTaskDefaults | |
tasks | Tasks | |
throttle | ThrottleRequest | |
title | string | |
trigger | TriggerRequest | |
type | "STANDARD" | "SIMPLE" | Workflow type. |
unacknowledgedSkippedScheduleAt | null | Date |
WorkflowUpdateInput
type: Record<string, any>
WorkflowUpdateTaskDefaults
type: Record<string, any>
Enums
ActionExecutionState
⚠️ Deprecated Use literal values.
Enum keys
Error
| Idle
| Running
| Success
| Suspended
| Unknown
Byday
⚠️ Deprecated Use literal values.
Enum keys
Fr
| Mo
| Sa
| Su
| Th
| Tu
| We
Byworkday
⚠️ Deprecated Use literal values.
Enum keys
Holidays
| Off
| Working
CronTriggerType
⚠️ Deprecated Use literal values.
Enum keys
Cron
DavisEventNameMatch
⚠️ Deprecated Use literal values.
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.
EventLogState
⚠️ Deprecated Use literal values.
Enum keys
Cancelled
| Deactivated
| Discarded
| Error
| Idle
| Paused
| Running
| Skipped
| Success
| Waiting
EventQueryTriggerConfigType
⚠️ Deprecated Use literal values.
Enum keys
Event
EventType
⚠️ Deprecated Use literal values.
ExecutionState
⚠️ Deprecated Use literal values.
Enum keys
Cancelled
| Error
| Paused
| Running
| Success
| Unknown
FixedOffsetRulePreviewRuleType
⚠️ Deprecated Use literal values.
Enum keys
FixedOffset
Freq
⚠️ Deprecated Use literal values.
Enum keys
Daily
| Hourly
| Minutely
| Monthly
| Secondly
| Weekly
| Yearly
GetWorkflowsQueryOwnerType
⚠️ Deprecated Use literal values.
Enum keys
Group
| User
GroupingRulePreviewRuleType
⚠️ Deprecated Use literal values.
Enum keys
Grouping
IntervalTriggerType
⚠️ Deprecated Use literal values.
Enum keys
Interval
Model
⚠️ Deprecated Use literal values.
Enum keys
ActionExecution
| Execution
| TaskExecution
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
Cancelled
| Discarded
| Error
| Idle
| Running
| Skipped
| Success
| Unknown
| Waiting
ThrottleLimitEventType
⚠️ Deprecated Use literal values.
Enum keys
EventTrigger
| Workflow
TimeTriggerType
⚠️ Deprecated Use literal values.
Enum keys
Time
Timezone
⚠️ Deprecated Use literal values.
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
| AmericaCiudadJuarez
| AmericaCoralHarbour
| AmericaCordoba
| AmericaCostaRica
| AmericaCoyhaique
| 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
| EuropeKyiv
| 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
| PacificKanton
| 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
⚠️ Deprecated Use literal values.
Enum keys
Cron
| Custom
| DavisEvent
| DavisProblem
| FixedInterval
| TimeOfDay
TriggerType
⚠️ Deprecated Use literal values.
Enum keys
Event
| Manual
| Schedule
| Workflow
WeekdaysNamesItem
⚠️ Deprecated Use literal values.
Enum keys
Fr
| Mo
| Sa
| Su
| Th
| Tu
| We
WeekdaysValuesItem
⚠️ Deprecated Use literal values.
Enum keys
WeekdaysValues_1
| WeekdaysValues_2
| WeekdaysValues_3
| WeekdaysValues_4
| WeekdaysValues_5
| WeekdaysValues_6
| WeekdaysValues_7
Wkst
⚠️ Deprecated Use literal values.
Enum keys
Fr
| Mo
| Sa
| Su
| Th
| Tu
| We
WorkflowType
⚠️ Deprecated Use literal values.
Enum keys
Simple
| Standard