Search

Search Automation Executions

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

post/api/v1/automation_executions/search

Invokes the c1.api.automations.v1.AutomationExecutionSearchService.SearchAutomationExecutions method.

Parameters

bodyautomationTemplateIdstringexecutionIdstringexecutionStepStatesunionexpandMaskExpandMaskpageSizenumberpageTokenstringquerystringrefsunionAutomationExecutionSearchParams

Hide ParametersShow Parameters

automationTemplateIdstring

optional

The automationTemplateId field.

executionIdstring

optional

The executionId field.

formatint64

executionStepStatesunion

optional

Array<"AUTOMATION_EXECUTION_STATE_UNSPECIFIED" | "AUTOMATION_EXECUTION_STATE_PENDING" | "AUTOMATION_EXECUTION_STATE_CREATING" | 7 more> | null

The executionStepStates 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"

expandMaskExpandMask

optional

The AutomationExecutionExpandMask message.

Hide ParametersShow Parameters

pathsunion

optional

Array<string> | null

The paths field.

pageSizenumber

optional

The pageSize field.

formatint32

pageTokenstring

optional

The pageToken field.

querystring

optional

The query field.

refsunion

optional

Array<Ref> | null

The refs field.

Hide ParametersShow Parameters

idstring

optional

The id field.

formatint64

Returns

AutomationExecutionSearchResponse

The SearchAutomationExecutionsResponse message.

Hide ParametersShow Parameters

expandedunion

optional

Array<Expanded> | null

The expanded field.

Hide ParametersShow Parameters

@typestring

optional

The type of the serialized message.

listunion

optional

Array<List> | null

The list field.

Hide ParametersShow Parameters

automationExecutionidstringautomationTemplateIdstringcompletedAtstringcontextAutomationContextcreatedAtstringcurrentVersionnumberdeletedAtstringdurationstringisDraftbooleanstateunionupdatedAtstringAutomationExecution

optional

The AutomationExecution message.

automationExecutionTriggerPathstring

optional

The automationExecutionTriggerPath field.

automationPathstring

optional

The automationPath field.

nextPageTokenstring

optional

The nextPageToken field.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.automationExecutions.search();

console.log(response.expanded);

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "automationExecution": {
        "id": "id",
        "automationTemplateId": "automationTemplateId",
        "completedAt": "2019-12-27T18:11:19.117Z",
        "context": {
          "context": {
            "foo": "bar"
          }
        },
        "createdAt": "2019-12-27T18:11:19.117Z",
        "currentVersion": 0,
        "deletedAt": "2019-12-27T18:11:19.117Z",
        "duration": "duration",
        "isDraft": true,
        "state": "AUTOMATION_EXECUTION_STATE_UNSPECIFIED",
        "updatedAt": "2019-12-27T18:11:19.117Z"
      },
      "automationExecutionTriggerPath": "automationExecutionTriggerPath",
      "automationPath": "automationPath"
    }
  ],
  "nextPageToken": "nextPageToken"
}