Type Alias AutomationsAPI

type AutomationsAPI = {
    changeOwnerAutomation: typeof automations.changeOwnerAutomation;
    changeSpaceAutomation: typeof automations.changeSpaceAutomation;
    clearCache: typeof automations.clearCache;
    copyAutomation: typeof automations.copyAutomation;
    createAutomation: typeof automations.createAutomation;
    createAutomationRun: typeof createAutomationRun;
    deleteAutomation: typeof automations.deleteAutomation;
    disableAutomation: typeof automations.disableAutomation;
    enableAutomation: typeof automations.enableAutomation;
    exportAutomationRun: typeof exportAutomationRun;
    getAutomation: typeof automations.getAutomation;
    getAutomationRun: typeof automations.getAutomationRun;
    getAutomationRunDebug: typeof getAutomationRunDebug;
    getAutomationRuns: typeof automations.getAutomationRuns;
    getAutomations: typeof automations.getAutomations;
    getAutomationsSettings: typeof getAutomationsSettings;
    getAutomationsUsageMetrics: typeof automations.getAutomationsUsageMetrics;
    moveAutomation: typeof automations.moveAutomation;
    retryAutomationRun: typeof automations.retryAutomationRun;
    stopAutomationRun: typeof automations.stopAutomationRun;
    updateAutomation: typeof automations.updateAutomation;
    updateAutomationsSettings: typeof updateAutomationsSettings;
}
Index

Properties

changeOwnerAutomation changeSpaceAutomation clearCache copyAutomation createAutomation createAutomationRun deleteAutomation disableAutomation enableAutomation exportAutomationRun getAutomation getAutomationRun getAutomationRunDebug getAutomationRuns getAutomations getAutomationsSettings getAutomationsUsageMetrics moveAutomation retryAutomationRun stopAutomationRun updateAutomation updateAutomationsSettings

Properties

changeOwnerAutomation: typeof automations.changeOwnerAutomation

Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: TenantAdmin, AnalyticsAdmin or have at least one of the following scopes: admin.automations, admin.automations:strict.

The unique identifier for the automation.

Param: body

an object with the body content

ChangeOwnerAutomationHttpError

changeSpaceAutomation: typeof automations.changeSpaceAutomation

Changes the space of an automation by specifying a new space.

The unique identifier for the automation.

Param: body

an object with the body content

ChangeSpaceAutomationHttpError

clearCache: typeof automations.clearCache

Clears the cache for automations api requests.

copyAutomation: typeof automations.copyAutomation

Duplicates an existing automation. The requesting user must be the owner of the automation or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

The unique identifier for the automation.

Param: body

an object with the body content

CopyAutomationHttpError

createAutomation: typeof automations.createAutomation

Creates a new automation. The requesting user must be assigned the AutomationCreator role or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

Param: body

an object with the body content

CreateAutomationHttpError

createAutomationRun: typeof createAutomationRun

Creates a run for a specific automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

Param: body

an object with the body content

CreateAutomationRunHttpError

deleteAutomation: typeof automations.deleteAutomation

Deletes an automation. The requesting user must meet at least one of the following conditions:

  • be the owner of the automation
  • be assigned one of the following roles: AnalyticsAdmin, TenantAdmin
  • have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

The unique identifier for the automation.

DeleteAutomationHttpError

disableAutomation: typeof automations.disableAutomation

Disables an automation so that it cannot be run. To disable an automation, the requesting user must meet at least one of the following conditions:

  • be the owner of the automation
  • be assigned one of the following roles: TenantAdmin, AnalyticsAdmin
  • have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

The unique identifier for the automation.

DisableAutomationHttpError

enableAutomation: typeof automations.enableAutomation

Enables an automation so that it can be run. To enable an automation, the requesting user must meet at least one of the following conditions:

  • be the owner of the automation
  • be assigned one of the following roles: AnalyticsAdmin, TenantAdmin
  • have at least one of the following scopes: admin.automations, admin.automations:strict, automations.private, or automations.shared

The unique identifier for the automation.

EnableAutomationHttpError

exportAutomationRun: typeof exportAutomationRun

Retrieves the URL for the debug log of a specific automation run. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

The unique identifier for the run.

ExportAutomationRunHttpError

getAutomation: typeof automations.getAutomation

Retrieves the full definition of an automation. The requesting user must be the owner of the automation and either be assigned one of the roles: AutomationsCreator, TenantAdmin or have at least one of the following scopes (depending on whether the automation is in a private or shared space): automations, automations.private or automations.shared.

The unique identifier for the automation.

GetAutomationHttpError

getAutomationRun: typeof automations.getAutomationRun

Retrieves a specific run for an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

The unique identifier for the run.

GetAutomationRunHttpError

getAutomationRunDebug: typeof getAutomationRunDebug

Retrieves the debug log for a specific run of an automation. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

The unique identifier for the run.

GetAutomationRunDebugHttpError

getAutomationRuns: typeof automations.getAutomationRuns

Retrieves a list of runs for a specific automation. The requesting user must be the owner of the automation, or be assigned the one of roles: TenantAdmin, AnalyticsAdmin. Alternatively, the user must have at least one of the following scopes: admin.automation-runs, automation-runs.private, or automation-runs.shared.

The unique identifier for the automation.

an object with query parameters

GetAutomationRunsHttpError

getAutomations: typeof automations.getAutomations

Retrieves a list of the automations that the requesting user has access to.

an object with query parameters

GetAutomationsHttpError

getAutomationsSettings: typeof getAutomationsSettings

Retrieves the global automation settings for the tenant.

GetAutomationsSettingsHttpError

getAutomationsUsageMetrics: typeof automations.getAutomationsUsageMetrics

Retrieves paginated usage metrics for automations. The requesting user must be assigned the TenantAdmin or AnalyticsAdmin role.

an object with query parameters

GetAutomationsUsageMetricsHttpError

moveAutomation: typeof automations.moveAutomation

Changes the owner of an automation to another user. This action removes the history and change logs of this automation. All linked connections used in the automation are detached and not moved to the new owner. The requesting user must be assigned one of the following roles: TenantAdmin, AnalyticsAdmin or have at least one of the following scopes: admin.automations, admin.automations:strict.

The unique identifier for the automation.

Param: body

an object with the body content

MoveAutomationHttpError

retryAutomationRun: typeof automations.retryAutomationRun

Retries a specific run by creating a new run using the same inputs. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

The unique identifier for the run.

RetryAutomationRunHttpError

stopAutomationRun: typeof automations.stopAutomationRun

Forcefully stops an automation run immediately. Depending on the space the automation belongs to, the requesting user must meet the following requirement:

  • Private space: be the owner of the automation and have the automations.private scope
  • Shared space: be editor or operator in shared space and have automations.shared scope.

The unique identifier for the automation.

The unique identifier for the run.

StopAutomationRunHttpError

updateAutomation: typeof automations.updateAutomation

Updates the full definition of an automation. The requesting user must be the owner of the automation and either be assigned the AutomationCreator role or have at least one of the following scopes: automations, admin.automations, automations.private or automations.shared.

The unique identifier for the automation.

Param: body

an object with the body content

UpdateAutomationHttpError

updateAutomationsSettings: typeof updateAutomationsSettings

Updates the global automation settings for the tenant.

Param: body

an object with the body content

UpdateAutomationsSettingsHttpError

Settings

Member Visibility

On This Page

Properties