@dynatrace-sdk/client-automation v4.8.0

@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

Returns

Throws

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

Returns

Throws

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

Returns

Throws

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

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.createBusinessCalendar({
    body: { title: "..." },
  });

deleteBusinessCalendar

Required scope: automation:calendars:write

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.deleteBusinessCalendar({
    id: "...",
  });

duplicateBusinessCalendar

Required scope: automation:calendars:write

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.duplicateBusinessCalendar({
    id: "...",
    body: {},
  });

getBusinessCalendar

Required scope: automation:calendars:read

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendar({
    id: "...",
  });

getBusinessCalendarHistoryRecord

Required scope: automation:calendars:read

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendarHistoryRecord(
    { id: "...", version: "..." },
  );

getBusinessCalendarHistoryRecords

Required scope: automation:calendars:read

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendarHistoryRecords(
    { id: "..." },
  );

getBusinessCalendars

Required scope: automation:calendars:read

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.getBusinessCalendars();

patchBusinessCalendar

Required scope: automation:calendars:write

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.patchBusinessCalendar({
    id: "...",
    body: {},
  });

restoreBusinessCalendarHistoryRecord

Required scope: automation:calendars:write

Parameters

Returns

Throws

import { businessCalendarsClient } from "@dynatrace-sdk/client-automation";

const data =
  await businessCalendarsClient.restoreBusinessCalendarHistoryRecord(
    { id: "...", version: "..." },
  );

updateBusinessCalendar

Required scope: automation:calendars:write

Parameters

Returns

Throws

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

Returns

Throws

import { eventTriggersClient } from "@dynatrace-sdk/client-automation";

const data = await eventTriggersClient.previewFilter({
  body: {
    triggerConfiguration: {
      type: EventQueryTriggerConfigType.Event,
      value: { query: "..." },
    },
  },
});

executionsClient

import { executionsClient } from '@dynatrace-sdk/client-automation';

cancelExecution

Required scope: automation:workflows:run

Tries to cancel an Execution. Can only be done, if the Execution is in an active state.

Parameters

Returns

Throws

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

Returns

Throws

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

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getAllEventLogs({
  id: "...",
});

getExecution

Required scope: automation:workflows:read

Parameters

Returns

Throws

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

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutionActions({
  id: "...",
});

getExecutionLog

Required scope: automation:workflows:read

Gets the execution log

Parameters

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutionLog({
  id: "...",
});

getExecutions

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getExecutions();

getTaskExecution

Required scope: automation:workflows:read

Parameters

Returns

Throws

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

Returns

Throws

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

Returns

Throws

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

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutionResult({
  executionId: "...",
  id: "...",
});

getTaskExecutions

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.getTaskExecutions({
  executionId: "...",
});

getTransitions

Required scope: automation:workflows:read

Parameters

Returns

Throws

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

Returns

Throws

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

Returns

Throws

import { executionsClient } from "@dynatrace-sdk/client-automation";

const data = await executionsClient.previewTaskInput({
  body: {
    expression: {},
    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

Returns

Throws

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

Throws

import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getCountries();

getHolidayCalendar

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getHolidayCalendar({
  key: "...",
});

getTimezones

Required scope: automation:workflows:read

Returns

Throws

import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.getTimezones();

previewSchedule

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { schedulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulesClient.previewSchedule({
  body: {
    schedule: {
      trigger: {
        type: CronTriggerType.Cron,
        cron: "0 0 * * *",
      },
    },
  },
});

schedulingRulesClient

import { schedulingRulesClient } from '@dynatrace-sdk/client-automation';

createRule

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.createRule({
  body: {
    title: "...",
    ruleType: RuleRequestRuleType.Rrule,
  },
});

deleteRule

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.deleteRule({
  id: "...",
});

duplicateRule

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.duplicateRule({
  id: "...",
  body: {},
});

getRule

Required scope: automation:rules:read

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.getRule({
  id: "...",
});

getRuleHistoryRecord

Required scope: automation:rules:read

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.getRuleHistoryRecord({
    id: "...",
    version: "...",
  });

getRuleHistoryRecords

Required scope: automation:rules:read

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.getRuleHistoryRecords({
    id: "...",
  });

getRules

Required scope: automation:rules:read

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.getRules();

patchRule

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.patchRule({
  id: "...",
  body: {},
});

previewRule

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.previewRule({
  body: {
    ruleType: RRulePreviewRequestRuleType.Rrule,
    rrule: { freq: RRuleFreq.Yearly, datestart: "..." },
  },
});

restoreRuleHistoryRecord

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data =
  await schedulingRulesClient.restoreRuleHistoryRecord({
    id: "...",
    version: "...",
  });

updateRule

Required scope: automation:rules:write

Parameters

Returns

Throws

import { schedulingRulesClient } from "@dynatrace-sdk/client-automation";

const data = await schedulingRulesClient.updateRule({
  id: "...",
  body: {
    title: "...",
    ruleType: RuleRequestRuleType.Rrule,
  },
});

settingsClient

import { settingsClient } from '@dynatrace-sdk/client-automation';

getServiceUsers

Required scope: automation:workflows:read

Get service users who could be used as workflow actor (deprecated).

Returns

Throws

import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getServiceUsers();

getSettings

Required scope: automation:workflows:read

Get system settings

Returns

Throws

import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getSettings();

getUserPermissions

Required scope: automation:workflows:read

Get current user effective permissions.

Returns

Throws

import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getUserPermissions();

getUserSettings

Required scope: automation:workflows:read

Get user-specific settings

Returns

Throws

import { settingsClient } from "@dynatrace-sdk/client-automation";

const data = await settingsClient.getUserSettings();

updateAuthorizations

Required scope: automation:workflows:write

Returns

Throws

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

Throws

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

Returns

Throws

import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.createWorkflow({
  body: { title: "...", throttle: { isLimitHit: false } },
});

deleteWorkflow

Required scope: automation:workflows:write

Parameters

Returns

Throws

import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.deleteWorkflow({
  id: "...",
});

duplicateWorkflow

Required scope: automation:workflows:write

Parameters

Returns

Throws

import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.duplicateWorkflow({
  id: "...",
  body: {},
});

getWorkflow

Required scope: automation:workflows:read

Parameters

Returns

Throws

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

Returns

Throws

import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.getWorkflowActions({
  id: "...",
});

getWorkflowHistoryRecord

Required scope: automation:workflows:read

Parameters

Returns

Throws

import { workflowsClient } from "@dynatrace-sdk/client-automation";

const data = await workflowsClient.getWorkflowHistoryRecord(
  { id: "...", version: "..." },
);

getWorkflowHistoryRecords

Required scope: automation:workflows:read

Parameters

Returns

Throws