Method: legacyCases.generateUseCases

Full name: projects.locations.instances.legacyCases.generateUseCases

Triggers the generation of one or more simulated cases based on predefined templates or custom definitions. Generated cases appear in the case queue for testing purposes.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}/legacyCases:generateUseCases

Path parameters

Parameters
name

string

Required. The resource name of the LegacyCase to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/LegacyCases

Request body

The request body contains data with the following structure:

JSON representation
{
  "environment": string,
  "customCases": [
    string
  ],
  "kinds": [
    enum (DemoDataComponent)
  ]
}
Fields
environment

string

Required. Environment is the environment in which the cases will be generated.

customCases[]

string

Required. CustomCases is a list of custom case names to be generated.

kinds[]

enum (DemoDataComponent)

Required. Kinds is a list of DemoDataComponentEnum values.

Response body

Response message for legacyCases.generateUseCases.

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

JSON representation
{
  "payload": string
}
Fields
payload

string

Output only. The generated case names.

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 name resource:

  • chronicle.legacyCases.createSimulated

For more information, see the IAM documentation.