@dynatrace-sdk/client-automation
v4.2.0
Published
Automation API allows working with workflows and various trigger options.
Downloads
285
Keywords
Readme
@dynatrace-sdk/client-automation
Automation API allows working with workflows and various trigger options.
Installation
npm install @dynatrace-sdk/client-automation
Getting help
- Visit SDK for Typescript guide in the Dynatrace Developer
- Ask a question in the Dynatrace Community
License
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
API reference
Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.
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. |
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. |
import { actionExecutionsClient } from "@dynatrace-sdk/client-automation";
const data =
await actionExecutionsClient.getActionExecutionLog({
id: "...",
});
actionsSampleResultClient
import { actionsSampleResultClient } from '@dynatrace-sdk/client-automation';
getActionSampleResult
Required scope: automation:workflows:read
Parameters
| Name | Type | | --- | --- | |config.actionIdentifier*required|string|
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|BusinessCalendarRequest|
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. |
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. |
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. |
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| |
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.id*required|string|A UUID string identifying this business calendar. |
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. |
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|PatchedBusinessCalendarRequest| | |config.id*required|string|A UUID string identifying this business calendar. |
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| |
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|BusinessCalendarRequest| | |config.id*required|string|A UUID string identifying this business calendar. |
import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";
const data =
await businessCalendarsClient.updateBusinessCalendar({
id: "...",
body: { title: "..." },
});
eventTriggersClient
import { eventTriggersClient } from '@dynatrace-sdk/client-automation';
previewFilter
Required scope: automation:workflows:read
Parameters
| Name | Type | | --- | --- | |config.body*required|EventTriggerPreviewRequest|
import { eventTriggersClient } from "@dynatrace-sdk/client-automation";
const data = await eventTriggersClient.previewFilter({
body: {},
});
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. |
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 |
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. |
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getAllEventLogs({
id: "...",
});
getExecution
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 execution. |
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. |
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. |
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.getExecutionLog({
id: "...",
});
getExecutions
Required scope: automation:workflows:read
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.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.task|string| | |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. |
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 |
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 |
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 |
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 |
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| |
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| |
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. |
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.pauseExecution({
id: "...",
});
previewTaskInput
Required scope: automation:workflows:read
Returns preview expression by given task id from the workflow definition
Parameters
| Name | Type | | --- | --- | |config.body*required|PreviewTaskInputRequest|
import { executionsClient } from "@dynatrace-sdk/client-automation";
const data = await executionsClient.previewTaskInput({
body: {
task: "...",
workflow: {
title: "...",
throttle: { isLimitHit: false },
},
},
});
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. |
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
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 |
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getHolidayCalendar({
key: "...",
});
getTimezones
Required scope: automation:workflows:read
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.getTimezones();
previewSchedule
Required scope: automation:workflows:read
Parameters
| Name | Type | | --- | --- | |config.body*required|SchedulePreviewRequest|
import { schedulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulesClient.previewSchedule({
body: { schedule: {} },
});
schedulingRulesClient
import { schedulingRulesClient } from '@dynatrace-sdk/client-automation';
createRule
Required scope: automation:rules:write
Parameters
| Name | Type | | --- | --- | |config.body*required|RuleRequest|
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.createRule({
body: { title: "..." },
});
deleteRule
Required scope: automation:rules:write
Parameters
| Name | Type | Description | | --- | --- | --- | |config.id*required|string|A UUID string identifying this rule. |
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. |
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. |
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| |
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.id*required|string|A UUID string identifying this rule. |
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. |
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|PatchedRuleRequest| | |config.id*required|string|A UUID string identifying this rule. |
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.patchRule({
id: "...",
body: {},
});
previewRule
Required scope: automation:workflows:read
Parameters
| Name | Type | | --- | --- | |config.body*required|RulePreviewRequest|
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.previewRule({
body: {},
});
restoreRuleHistoryRecord
Required scope: automation:rules:write
Parameters
| Name | Type | Description | | --- | --- | --- | |config.id*required|string|A UUID string identifying this rule. | |config.version*required|string| |
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|RuleRequest| | |config.id*required|string|A UUID string identifying this rule. |
import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";
const data = await schedulingRulesClient.updateRule({
id: "...",
body: { title: "..." },
});
settingsClient
import { settingsClient } from '@dynatrace-sdk/client-automation';
getServiceUsers
Required scope: automation:workflows:read
Get service users who could be used as workflow actor
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getServiceUsers();
getSettings
Required scope: automation:workflows:read
Get system settings
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getSettings();
getUserPermissions
Required scope: automation:workflows:read
Get current user effective permissions.
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getUserPermissions();
getUserSettings
Required scope: automation:workflows:read
Get user-specific settings
import { settingsClient } from "@dynatrace-sdk/client-automation";
const data = await settingsClient.getUserSettings();
updateAuthorizations
Required scope: automation:workflows:write
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
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|WorkflowRequest| |
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. |
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. |
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. |
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. |
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| |
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.id*required|string|A UUID string identifying this workflow. |
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| |
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. |
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.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|GetWorkflowsQueryOwnerType| USER - USER GROUP - GROUP | |config.search|string|A search term. | |config.throttleIsLimitHit|boolean| | |config.triggerScheduleIsFaulty|boolean| | |config.triggerType|string| | |config.usages|string| |
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|PatchedWorkflowRequest| | |config.id*required|string|A UUID string identifying this workflow. |
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.patchWorkflow({
id: "...",
body: { throttle: { isLimitHit: false } },
});
restoreWorkflowHistoryRecord
Required scope: automation:workflows:write
Parameters
| Name | Type | Description | | --- | --- | --- | |config.adminAccess|boolean|Allow access to all workflows/executions - additionally requires automation:workflows:admin | |config.id*required|string|A UUID string identifying this workflow. | |config.version*required|string| |
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. |
Returns
Execution successfully created | No execution created - execution with uniqueQualifier provided already exists
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.runWorkflow({
id: "...",
body: {},
});
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|WorkflowRequest| | |config.id*required|string|A UUID string identifying this workflow. |
import { workflowsClient } from "@dynatrace-sdk/client-automation";
const data = await workflowsClient.updateWorkflow({
id: "...",
body: { title: "...", throttle: { isLimitHit: false } },
});
Types
ActionExecution
| Name | Type | Description | | --- | --- | --- | |action*required|string| | |actionExecutionId|null | string| | |attempt|number| | |endedAt|null | Date| | |id|string| | |input|ActionExecutionInput| | |loopItem|ActionExecutionLoopItem| | |result|any| | |runtime|null | number| | |startedAt|null | Date| | |state|ActionExecutionState| | |stateInfo|null | string| | |taskExe|null | string|Parent task execution |
ActionExecutionInput
type: Record<string, any>
ActionExecutionLoopItem
type: Record<string, any>
BusinessCalendarRequest
| 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|string| | |modificationInfo*required|ModificationInfo| | |title*required|string| | |validFrom|Date| | |validTo|Date| | |version*require