Method: legacyPlaybooks.legacyGetWorkflowInstance

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

legacyPlaybooks.legacyExecuteManualStep returns the Instance (done \ pending) that was created for a given case+alert Identifier combo and the wf identifier.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the workflow 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,
  "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

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

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.