Method: legacyPlaybooks.legacyGetWorkflowStepInstance

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

legacyPlaybooks.legacyGetWorkflowStepInstance returns a workflow step instance.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the workflow step instance 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,
  "workflowIdentifier": string,
  "stepIdentifier": string,
  "blockStepId": string,
  "loopIteration": integer,
  "parentWorkflowLoopIteration": integer
}
Fields
caseId

string (int64 format)

Required. The caseId is the identifier of the case.
alertIdentifier

string

Optional. The alert identifier is the identifier of the alert.
workflowIdentifier

string

Required. The workflow identifier is the identifier of the workflow.
stepIdentifier

string

Required. The step identifier is the identifier of the step.
blockStepId

string

Optional. The block step identifier is the identifier of the block step.
loopIteration

integer

Optional. The loop iteration is the current loop iteration.
parentWorkflowLoopIteration

integer

Optional. The parent workflow loop iteration.

Response body

If successful, the response body contains an instance of ApiWorkflowStepInstanceDataModel.

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.