Type Alias AutomationsAPI

type AutomationsAPI = {
    changeOwnerAutomation: typeof changeOwnerAutomation;
    changeSpaceAutomation: typeof changeSpaceAutomation;
    clearCache: typeof clearCache;
    copyAutomation: typeof copyAutomation;
    createAutomation: typeof createAutomation;
    deleteAutomation: typeof deleteAutomation;
    disableAutomation: typeof disableAutomation;
    enableAutomation: typeof enableAutomation;
    getAutomation: typeof getAutomation;
    getAutomationRun: typeof getAutomationRun;
    getAutomationRunDetails: typeof getAutomationRunDetails;
    getAutomationRuns: typeof getAutomationRuns;
    getAutomationRunWithQuery: typeof getAutomationRunWithQuery;
    getAutomations: typeof getAutomations;
    getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics;
    getAutomationWithQuery: typeof getAutomationWithQuery;
    moveAutomation: typeof moveAutomation;
    queueAutomationRun: typeof queueAutomationRun;
    retryAutomationRun: typeof retryAutomationRun;
    stopAutomationRun: typeof stopAutomationRun;
    updateAutomation: typeof updateAutomation;
}
Index

Properties

changeOwnerAutomation changeSpaceAutomation clearCache copyAutomation createAutomation deleteAutomation disableAutomation enableAutomation getAutomation getAutomationRun getAutomationRunDetails getAutomationRuns getAutomationRunWithQuery getAutomations getAutomationsUsageMetrics getAutomationWithQuery moveAutomation queueAutomationRun retryAutomationRun stopAutomationRun updateAutomation

Properties

changeOwnerAutomation: typeof 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 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 clearCache

Clears the cache for automations api requests.

copyAutomation: typeof copyAutomation

Duplicates an existing automation.

The unique identifier for the automation.

Param: body

an object with the body content

CopyAutomationHttpError

createAutomation: typeof 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

deleteAutomation: typeof 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 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 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

getAutomation: typeof 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 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

getAutomationRunDetails: typeof getAutomationRunDetails

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.

GetAutomationRunDetailsHttpError

getAutomationRuns: typeof 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

getAutomationRunWithQuery: typeof getAutomationRunWithQuery

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.

an object with query parameters

GetAutomationRunWithQueryHttpError

getAutomations: typeof getAutomations

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

an object with query parameters

GetAutomationsHttpError

getAutomationsUsageMetrics: typeof getAutomationsUsageMetrics

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

an object with query parameters

GetAutomationsUsageMetricsHttpError

getAutomationWithQuery: typeof getAutomationWithQuery

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.

an object with query parameters

GetAutomationWithQueryHttpError

moveAutomation: typeof 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

queueAutomationRun: typeof queueAutomationRun

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

QueueAutomationRunHttpError

retryAutomationRun: typeof 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 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 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

Settings

Member Visibility

On This Page

Properties