Method: legacyPlaybooks.legacyAddOrUpdatePlaybookCategory

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

Add or update workflow categories.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to add or update the workflow category for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "id": string,
  "name": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "categoryState": enum (ApiCategoryState),
  "type": enum (CategoryType),
  "isDefaultCategory": boolean
}
Fields
id

string (int64 format)

Required. Id is the unique identifier of the category.
name

string

Required. Name is the name of the category.
creationTimeUnixTimeInMs

string (int64 format)

Required. CreationTimeUnixTimeInMs is the creation time of the category. Represents DateTime CreationTimeUnixTimeInMs as unix time
modificationTimeUnixTimeInMs

string (int64 format)

Required. ModificationTimeUnixTimeInMs is the modification time of the category. Represents DateTime ModificationTimeUnixTimeInMs as unix time
categoryState

enum (ApiCategoryState)

Output only. CategoryState is the state of the category.
type

enum (CategoryType)

Required. CategoryType is the type of the category.
isDefaultCategory

boolean

Required. IsDefaultCategory indicates if the category is the default category.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ApiCategoryState

ApiCategoryState represents the state of a category.

Enums
API_CATEGORY_STATE_UNSPECIFIED The category state is unspecified.
EMPTY The category state is empty.
FULL The category state is full.
FULL_FROM_RESTRICTED_ENVIRONMENT The category state is full from a restricted environment.

CategoryType

CategoryType represents the type of a category.

Enums
CATEGORY_TYPE_UNSPECIFIED The category type is unspecified.
REGULAR The category type is regular.
SYSTEM_DEFAULT The category type is system default.
GENERATED_FROM_ALERT_PLAYBOOK The category type is generated from alert playbook.