Method: legacyPlaybooks.legacyGetNestedPlaybookParams

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

Returns the input parameter definitions for a specified modular playbook block. Use this method to understand the data requirements for integrating a nested workflow.

HTTP request


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

Path parameters

Parameters
instance

string

Required. The instance to get the nested playbook params for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
workflowIdentifier

string

Required. The nested playbook identifier.

Request body

The request body must be empty.

Response body

ApiNestedPlaybookParamsResponse represents the parameters of a nested playbook.

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

JSON representation 
{
  "inputParameters": [
    string
  ],
  "outputParameters": [
    string
  ],
  "actionResults": [
    string
  ]
}
Fields
inputParameters[]

string

Optional. InputParameters is a list of input parameters.
outputParameters[]

string

Optional. OutputParameters is a list of output parameters.
actionResults[]

string

Optional. ActionResults is a list of action results.

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.