ApiWorkflowDefinitionDataModel represents a workflow definition.
JSON representation |
---|
{ "id" : string , "identifier" : string , "version" : string , "name" : string , "creator" : string , "modifiedBy" : string , "priority" : string , "description" : string , "environments" : [ string ] , "categoryName" : string , "categoryId" : integer , "originalPlaybookIdentifier" : string , "creationTimeUnixTimeInMs" : string , "modificationTimeUnixTimeInMs" : string , "trigger" : { object ( |
Fields | |
---|---|
id
|
Required. Id is the unique identifier of the workflow. |
identifier
|
Required. Identifier is the unique identifier of the workflow. |
version
|
Required. Version is the version of the workflow. |
name
|
Required. Name is the name of the workflow. |
creator
|
Required. Creator is the creator of the workflow. |
modifiedBy
|
Required. ModifiedBy is the user who last modified the workflow. |
priority
|
Required. Priority is the priority of the workflow. |
description
|
Optional. Description is the description of the workflow. |
environments[]
|
Optional. Environments is a list of environments the workflow is enabled on. |
categoryName
|
Optional. CategoryName is the name of the category. |
categoryId
|
Optional. CategoryId is the identifier of the category. |
originalPlaybookIdentifier
|
Required. OriginalPlaybookIdentifier is the identifier of the original playbook. |
creationTimeUnixTimeInMs
|
Required. CreationTimeUnixTimeInMs is the creation time of the workflow. Represents DateTime CreationTimeUnixTimeInMs as unix time |
modificationTimeUnixTimeInMs
|
Required. ModificationTimeUnixTimeInMs is the modification time of the workflow. Represents DateTime ModificationTimeUnixTimeInMs as unix time |
trigger
|
Required. Trigger is the trigger of the workflow. |
steps[]
|
Optional. Steps is a list of steps in the workflow. |
stepsRelations[]
|
Optional. StepsRelations is a list of step relations in the workflow. |
templateName
|
Optional. TemplateName is the name of the template. |
playbookType
|
Required. PlaybookType is the type of playbook. |
debugData
|
Optional. DebugData is the debug data for the workflow. |
entityAccessLevel
|
Required. EntityAccessLevel is the access level for entities. |
defaultAccessLevel
|
Required. DefaultAccessLevel is the default access level for the workflow. |
permissions[]
|
Optional. Permissions is a list of permissions for the workflow. |
overviewTemplates[]
|
Optional. LegacyPlaybookOverviewTemplates is a list of overview templates for the workflow. |
creationSource
|
Optional. CreationSource is the source of the workflow. |
isEnabled
|
Optional. IsEnabled indicates if the workflow is enabled. |
isDebugMode
|
Optional. IsDebugMode indicates if debug mode is enabled for the workflow. |
hasRestrictedEnvironments
|
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. |
PermissionAccessLevel
PermissionAccessLevel is the access level of the permission.
Enums | |
---|---|
PERMISSION_ACCESS_LEVEL_UNSPECIFIED
|
The access level is unspecified. |
NO_ACCESS
|
The access level is no access. |
VIEW
|
The access level is view. |
EDIT
|
The access level is edit. |
EXECUTE
|
The access level is execute. |
PlaybookCreationSourceEnum
PlaybookCreationSourceEnum is the source of the playbook.
Enums | |
---|---|
PLAYBOOK_CREATION_SOURCE_UNSPECIFIED
|
The creation source is unspecified. |
USER_OR_API_INITIATED
|
The creation source is playbook designer. |
AI_GENERATED_FROM_ALERT
|
The creation source is playbook viewer. |
AI_GENERATED_FROM_PROMPT
|
The creation source is playbook manager. |