ApiWorkflowMenuCardDefinitionDataModel

JSON representation
PlaybookType

ApiWorkflowMenuCardDefinitionDataModel represents a workflow menu card definition.

JSON representation

JSON representation
{ "id": string, "identifier": string, "originalWorkflowIdentifier": string, "name": string, "creator": string, "creatorFullName": string, "priority": integer, "categoryId": integer, "categoryName": string, "environments": [ string ], "creationTime": string, "creationTimeUnixTimeInMs": string, "modificationTimeUnixTimeInMs": string, "playbookType": enum (`PlaybookType`), "isEnabled": boolean, "isDebugMode": boolean, "hasRestrictedEnvironments": boolean }

{
  "id": string,
  "identifier": string,
  "originalWorkflowIdentifier": string,
  "name": string,
  "creator": string,
  "creatorFullName": string,
  "priority": integer,
  "categoryId": integer,
  "categoryName": string,
  "environments": [
    string
  ],
  "creationTime": string,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "playbookType": enum (PlaybookType),
  "isEnabled": boolean,
  "isDebugMode": boolean,
  "hasRestrictedEnvironments": boolean
}

Fields
`id`	`string (int64 format)` Required. Id is the unique identifier.
`identifier`	`string` Required. The identifier of the workflow menu card.
`originalWorkflowIdentifier`	`string` Required. OriginalWorkflowIdentifier is the identifier of the original workflow.
`name`	`string` Required. Name is the name of the workflow.
`creator`	`string` Required. Creator is the creator of the workflow.
`creatorFullName`	`string` Required. The full name of the creator of the workflow.
`priority`	`integer` Required. Priority is the priority of the workflow.
`categoryId`	`integer` Optional. CategoryId is the identifier of the category.
`categoryName`	`string` Optional. CategoryName is the name of the category.
`environments[]`	`string` Optional. Environments is a list of environments the workflow is enabled on.
`creationTime`	`string (Timestamp format)` Optional. CreationTime is the original workflow creation time. Represents DateTime CreationTime as unix time Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`.
`creationTimeUnixTimeInMs`	`string (int64 format)` Required. CreationTimeUnixTimeInMs is the current workflow record creation time. Represents DateTime CreationTimeUnixTimeInMs as unix time
`modificationTimeUnixTimeInMs`	`string (int64 format)` Required. ModificationTimeUnixTimeInMs is the modification time of the workflow. Represents DateTime ModificationTimeUnixTimeInMs as unix time
`playbookType`	`enum (PlaybookType)` Required. PlaybookType is the type of playbook.
`isEnabled`	`boolean` Optional. IsEnabled indicates if the workflow is enabled.
`isDebugMode`	`boolean` Optional. IsDebugMode indicates if debug mode is enabled for the workflow.
`hasRestrictedEnvironments`	`boolean` Optional. HasRestrictedEnvironments indicates if the workflow has restricted environments.

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.