Method: legacyPlaybooks.legacyGetWorkflowMenuCards

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

Returns a list of playbook definitions, filtered by the requested playbook types. Use this method to browse and select from the set of current automation workflows.

HTTP request


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

Path parameters

Parameters
instance

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "legacyPayload": [
    enum (PlaybookType)
  ]
}
Fields
legacyPayload[]

enum (PlaybookType)

Required. Playbook types to filter the workflow menu cards by.

Response body

LegacyPlaybookGetWorkflowMenuCardsResponse is a response for getting the workflow menu cards.

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

JSON representation 
{
  "payload": [
    {
      object (ApiWorkflowMenuCardDefinitionDataModel)
    }
  ]
}
Fields
payload[]

object (ApiWorkflowMenuCardDefinitionDataModel)

Optional. The workflow menu cards. add workflow menu cards description

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.

PlaybookType

Playbook types to filter the workflow menu cards by.

Enums
PLAYBOOK_TYPE_UNSPECIFIED Unspecified playbook type.
REGULAR Regular playbook type.
NESTED Nested playbook type.