Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The id of the represented object (entity). | |
| created_by | str | The id of the user that created this resource. | [optional] |
| created_on | int | The timestamp (in UTC time standard) of the creation of this resource. | [optional] |
| last_modified_by | str | The id of the user who modified this resource the last time. | [optional] |
| last_modified_on | int | The timestamp (in UTC time standard) of the last modification of this resource. | [optional] |
| system | bool | Whether this is a system resource or not. | [optional] |
| resource_type | str | The type of this resource, i.e. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance]. | |
| name | str | The name of the resource. | [optional] |
| description | str | The description of the resource. | [optional] |
| process_id | str | The <code>id</code> that uniquely identifies a workflow definition in the application.<p>It is present in the BPMN notation in the ID property of the '<process..' tag. Deploying a BPMN in DGC creates a new version if a process with the same ID already exists. | [optional] |
| start_label | str | The label used for starting this workflow. | [optional] |
| form_required | bool | Whether the start form for this workflow requires user interaction through a form or not. | [optional] |
| enabled | bool | Whether workflow is enabled or not.<p>A workflow has to be enabled for a user to be able to start a workflow. A workflow is enabled if it's status is put on the status 'enabled' | [optional] |
| domain_assignment_rules | list[AssetAssignmentRuleImpl] | The list of domain assignment rules. | [optional] |
| asset_assignment_rules | list[AssetAssignmentRuleImpl] | The list of asset assignment rules. | [optional] |
| business_item_resource_type | str | The type of business item that the workflow can refer to. This could be either Community, Domain, Asset, or global. | [optional] |
| exclusivity | str | The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource. | [optional] |
| guest_user_accessible | bool | Whether this workflow definition is guest user accessible. | [optional] |
| registered_user_accessible | bool | Whether the workflow definition is accessible by any registered user. | [optional] |
| candidate_user_check_enabled | bool | Whether the candidate user check for this workflow is enabled. | [optional] |
| global_create | bool | Whether the workflow is accessible from the global create menu. | [optional] |
| start_events | list[str] | The start events in a list of WorkflowStartEventType enums. | [optional] |
| configuration_variables | dict(str, str) | The map of configuration variable key-value pairs. | [optional] |
| start_roles | list[RoleImpl] | The roles allowed to start the process. | [optional] |
| stop_roles | list[RoleImpl] | The roles allowed to stop processes/tasks. | [optional] |
| reassign_roles | list[RoleImpl] | The roles allowed to reassign tasks. | [optional] |