Method: legacyPlaybooks.legacyGetWorkflowInstanceSummary

Full name: projects.locations.instances.legacyPlaybooks.legacyGetWorkflowInstanceSummary

legacyPlaybooks.legacyGetWorkflowInstanceSummary returns the summary of an executed playbook for a given case including the alert and playbook Identifiers.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the workflow instance summary for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "caseId": string,
  "alertIdentifier": string,
  "definitionIdentifier": string,
  "nestedStepIdentifier": string,
  "parentWorkflowInstanceId": string,
  "loopsRequestedIterations": [
    {
      object (ApiLoopIterationRequest)
    }
  ],
  "parentWorkflowLoopIteration": integer,
  "shouldFetchSteps": boolean,
  "collapseBlocks": boolean
}
Fields
caseId

string (int64 format)

Required. The case id.
alertIdentifier

string

Optional. The alert identifier.
definitionIdentifier

string

Required. The definition identifier.
nestedStepIdentifier

string

Optional. The nested step identifier.
parentWorkflowInstanceId

string (int64 format)

Optional. The parent workflow instance id.
loopsRequestedIterations[]

object (ApiLoopIterationRequest)

Optional. The loops requested iterations.
parentWorkflowLoopIteration

integer

Optional. The parent workflow loop iteration.
shouldFetchSteps

boolean

Optional. Indicates if the steps should be fetched.
collapseBlocks

boolean

Optional. Indicates if the blocks should be collapsed.

Response body

ApiWorkflowInstanceSummary represents a workflow instance summary.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "usedIntegrations": [
    {
      object (ApiWorkflowInstanceSummaryIntegrationInfo)
    }
  ],
  "completedSteps": [
    {
      object (ApiWorkflowStepInstanceDataModel)
    }
  ],
  "faultedSteps": [
    {
      object (ApiWorkflowStepInstanceDataModel)
    }
  ],
  "userActionRequiredStep": {
    object (ApiWorkflowStepInstanceDataModel)
  },
  "executionTimeInMs": string,
  "totalPendingActionSteps": integer,
  "retryPendingSteps": [
    {
      object (ApiWorkflowStepInstanceDataModel)
    }
  ]
}
Fields
usedIntegrations[]

object (ApiWorkflowInstanceSummaryIntegrationInfo)

Optional. UsedIntegrations is a list of used integrations.
completedSteps[]

object (ApiWorkflowStepInstanceDataModel)

Optional. CompletedSteps is a list of completed steps.
faultedSteps[]

object (ApiWorkflowStepInstanceDataModel)

Optional. FaultedSteps is a list of faulted steps.
userActionRequiredStep

object (ApiWorkflowStepInstanceDataModel)

Optional. UserActionRequiredStep is the step that requires user action.
executionTimeInMs

string (int64 format)

Required. ExecutionTimeInMs is the execution time of the workflow in milliseconds.
totalPendingActionSteps

integer

Required. TotalPendingActionSteps is the total number of steps that are pending for user action.
retryPendingSteps[]

object (ApiWorkflowStepInstanceDataModel)

Optional. RetryPendingSteps is a list of retry pending steps.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.legacyPlaybooks.get

For more information, see the IAM documentation.

ApiWorkflowInstanceSummaryIntegrationInfo

ApiWorkflowInstanceSummaryIntegrationInfo represents a used integration information.

JSON representation 
{
  "identifier": string
}
Fields
identifier

string

Required. Identifier is the identifier of the integration.