Automation Executions

Automation Executions

Automation Executions

Get Automation Execution

client.automationExecutions.retrieve(stringid, RequestOptionsoptions?): automationExecutionAutomationExecutionAutomationExecutionRetrieveResponse

get/api/v1/automation_executions/{id}

List Automation Executions

client.automationExecutions.list(RequestOptionsoptions?): automationExecutionsunionnextPageTokenstringAutomationExecutionListResponse

get/api/v1/automation_executions

Search Automation Executions

client.automationExecutions.search(AutomationExecutionSearchParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringAutomationExecutionSearchResponse

post/api/v1/automation_executions/search

Automation Execution

AutomationExecution

The AutomationExecution message.

ShowShow

idstring

optional

The id field.

formatint64

automationTemplateIdstring

optional

The automationTemplateId field.

completedAtstring

optional

formatdate-time

contextcontextRecord<string, unknown>AutomationContext

optional

The AutomationContext message.

createdAtstring

optional

formatdate-time

currentVersionnumber

optional

The currentVersion field.

formatint32

deletedAtstring

optional

formatdate-time

durationstring

optional

formatduration

isDraftboolean

optional

The isDraft field.

stateunion

optional

"AUTOMATION_EXECUTION_STATE_UNSPECIFIED" | "AUTOMATION_EXECUTION_STATE_PENDING" | "AUTOMATION_EXECUTION_STATE_CREATING" | 7 more

The state field.

Hide ParametersShow Parameters

"AUTOMATION_EXECUTION_STATE_UNSPECIFIED"

"AUTOMATION_EXECUTION_STATE_PENDING"

"AUTOMATION_EXECUTION_STATE_CREATING"

"AUTOMATION_EXECUTION_STATE_GET_STEP"

"AUTOMATION_EXECUTION_STATE_PROCESS_STEP"

"AUTOMATION_EXECUTION_STATE_COMPLETE_STEP"

"AUTOMATION_EXECUTION_STATE_DONE"

"AUTOMATION_EXECUTION_STATE_ERROR"

"AUTOMATION_EXECUTION_STATE_TERMINATE"

"AUTOMATION_EXECUTION_STATE_WAITING"

updatedAtstring

optional

formatdate-time

Automation ExecutionsActions

Terminate Automation

client.automationExecutions.actions.terminate(stringid, ActionTerminateParamsparams?, RequestOptionsoptions?): ActionTerminateResponse

post/api/v1/automation_executions/{id}/actions/terminate