Method: legacyPlaybooks.legacyGetWorkflowInstancesCards

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

legacyPlaybooks.legacyGetWorkflowInstancesCards returns the workflow instances cards for a given case+alert Identifier combo.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the workflow instances cards 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
}
Fields
caseId

string (int64 format)

Required. The case id.
alertIdentifier

string

Optional. The alert identifier.

Response body

LegacyPlaybookGetWorkflowInstancesCardsResponse is a response for getting workflow instances cards.

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

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

object (ApiWorkflowInstanceCardDataModel)

Optional. The workflow instances cards.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ApiWorkflowInstanceCardDataModel

ApiWorkflowInstanceCardDataModel represents a workflow instance card.

JSON representation 
{
  "status": enum (WorkflowInstanceStatusValue),
  "name": string,
  "definitionIdentifier": string,
  "description": string,
  "positionInQueue": integer,
  "runCount": string,
  "creationSource": enum (PlaybookCreationSource),
  "originalWorkflowDefinitionIdentifier": string,
  "isDebugMode": boolean
}
Fields
status

enum (WorkflowInstanceStatusValue)

Required. Status is the status of the workflow instance.
name

string

Required. Name is the name of the workflow instance.
definitionIdentifier

string

Required. DefinitionIdentifier is the identifier of the workflow definition.
description

string

Optional. Description is the description of the workflow instance.
positionInQueue

integer

Required. PositionInQueue is the position of the workflow instance in the queue.
runCount

string (int64 format)

Required. RunCount is the number of times the workflow instance has been run.
creationSource

enum (PlaybookCreationSource)

Optional. CreationSource is the source of the workflow.
originalWorkflowDefinitionIdentifier

string

Optional. OriginalWorkflowDefinitionIdentifier is the original identifier of the workflow definition.
isDebugMode

boolean

Optional. IsDebugMode indicates if debug mode is enabled for the workflow instance.

WorkflowInstanceStatusValue

WorkflowInstanceStatusValue is the status of the workflow instance.

Enums
WORKFLOW_INSTANCE_STATUS_VALUE_UNSPECIFIED The status of the workflow instance is unspecified.
IN_PROGRESS The workflow instance is in progress.
COMPLETED The workflow instance is completed.
FAILED The workflow instance is failed.
TERMINATED The workflow instance is terminated.
PENDING_IN_QUEUE The workflow instance is pending in the queue.
PENDING_FOR_USER The workflow instance is pending for the user.

PlaybookCreationSource

PlaybookCreationSource is the source of the playbook.

Enums
PLAYBOOK_CREATION_SOURCE_UNSPECIFIED The creation source of the playbook is not specified or unknown.
USER_OR_API_INITIATED The playbook was created through direct user interaction (e.g., via UI) or programmatically via an API call. This covers all non-AI generation.
AI_GENERATED_FROM_ALERT The playbook was initially generated by AI from specific alert.
AI_GENERATED_FROM_PROMPT The playbook was generated by AI based on a direct user prompt.