Method: legacyPlaybooks.legacyGetPendingStep

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

Returns a specific pending playbook step by its associated alert identifier. Use this method to retrieve the details and required inputs for a task currently awaiting analyst action.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacyPlaybooks:legacyGetPendingStep

Path parameters

Parameters
instance

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "caseId": string,
  "alertGroupIdentifier": string,
  "originalWorkflowDefinitionIdentifier": string
}
Fields
caseId

string (int64 format)

Required. CaseId is the identifier of the case.
alertGroupIdentifier

string

Required. AlertGroupIdentifier is the identifier of the alert group.
originalWorkflowDefinitionIdentifier

string

Required. OriginalWorkflowDefinitionIdentifier is the identifier of the original workflow definition.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

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.