Workflow Definitions
The ID of the workflow definition.
The request describing assignment rule to be added.
The ID of the asset type the added rule should refer to.
The ID of the domain the assignment rule should apply for.
The ID of the community the assignment rule should apply for.
The ID of the status the assignment rule should apply for.
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
Asset type assignment rule successfully added.
An assignment rule for workflow definitions which apply to assets. Is used to limit the scope of assets to which given workflow definition applies to.
The id of the represented object (entity).
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The request describing assignment rule to be added.
The ID of the domain type the added rule should refer to.
The ID of the community the assignment rule should apply for.
When true, the workflow can only be started for a domain if its type matches exactly the domain type defined in this rule. Child domain types are excluded.
Domain type assignment rule successfully added.
An assignment rule for workflow definitions which apply to assets. Is used to limit the scope of assets to which given workflow definition applies to.
The id of the represented object (entity).
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
Domain type assignment rule successfully added.
The ID of the workflow definition.
The ID of the assignment rule to be changed.
Parameters for the assignment rule to be changed.
The ID of the asset type the changed rule should refer to.
The ID of the domain the assignment rule should apply for.
The ID of the community the assignment rule should apply for.
The ID of the (Asset Type) status the assignment rule should apply for.
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
The asset type assignment rule has been successfully updated.
An assignment rule for workflow definitions which apply to assets. Is used to limit the scope of assets to which given workflow definition applies to.
The id of the represented object (entity).
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The ID of the assignment rule to be changed.
Parameters for the assignment rule to be changed.
The ID of the domain type the changed rule should refer to.
The ID of the community the assignment rule should apply for.
When true, the workflow can only be started for a domain if its type matches exactly the domain type defined in this rule. Child domain types are excluded.
The domain type assignment rule has been successfully updated.
An assignment rule for workflow definitions which apply to assets. Is used to limit the scope of assets to which given workflow definition applies to.
The id of the represented object (entity).
When true, the workflow can only be started for an asset if its type matches exactly the asset type defined in this rule. Child asset types are excluded.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The workflow definition successfully found.
Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe description of the resource.
Sample descripion of the resource.The id that uniquely identifies a workflow definition in the application.
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.
The label used for starting this workflow.
Whether the start event for this workflow requires user interaction through a form or not.
This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.
Whether the workflow has the start form json model available or not. If true, then the external form definition for this task is needed to render the task.
Whether workflow is enabled or not.
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'
The type of business item that the workflow can refer to.This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable us to introduce new types of resources, we are replacing the WorkflowBusinessItemType enum with a String. For new types of resources that are supported by workflows, businessItemResourceType will be GLOBAL. Please use the businessItemDiscriminator property instead.
The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL
COMMUNITYThe exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.
Whether this workflow definition is guest user accessible.
Whether the workflow definition is accessible by any registered user.
Whether the candidate user check for this workflow is enabled.
Whether the workflow is accessible from the global create menu.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The workflow definition has been successfully removed.
No content
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
No content
The ID of the workflow definition.
Parameters for the workflow definition to be changed.
The name of the workflow definition.
The new description for the workflow definition.
The type of the business item corresponding to the workflow.
Defines the number of times a resource workflow is able to be start.
Whether the workflow should be accessible by the registered user.
Whether the candidate user check for the workflow should be disabled.
Whether the candidate user check for the workflow should be enabled.
Whether the workflow is accessible from the global create menu.
Whether the workflow definition should be enabled.
The start label of the workflow.
The list of IDs identifying the roles allowing to start the workflow.
The list of IDs identifying the roles allowing to stop the workflow.
The list of IDs identifying the roles allowing to reassign the workflow.
The workflow definition has been successfully updated.
Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe description of the resource.
Sample descripion of the resource.The id that uniquely identifies a workflow definition in the application.
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.
The label used for starting this workflow.
Whether the start event for this workflow requires user interaction through a form or not.
This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.
Whether the workflow has the start form json model available or not. If true, then the external form definition for this task is needed to render the task.
Whether workflow is enabled or not.
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'
The type of business item that the workflow can refer to.This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable us to introduce new types of resources, we are replacing the WorkflowBusinessItemType enum with a String. For new types of resources that are supported by workflows, businessItemResourceType will be GLOBAL. Please use the businessItemDiscriminator property instead.
The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL
COMMUNITYThe exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.
Whether this workflow definition is guest user accessible.
Whether the workflow definition is accessible by any registered user.
Whether the candidate user check for this workflow is enabled.
Whether the workflow is accessible from the global create menu.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.
0The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.
0Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped
-1The list of the IDs of business items (assets) for which the workflow definitions should be found.
The list of the IDs of business items (domains) for which the workflow definitions should be found.
The list of the IDs of business items (communities) for which the workflow definitions should be found.
Whether the found workflow definitions should be enabled.
Whether the found workflow definitions should be global.
The ID (could be partial) of workflow definition.
The name (could be partial) of the workflow definition to search for.
The sorting order.
ASCPossible values: The field on which the results are sorted.
NAMEPossible values: The description (could be partial) of the workflow definition to search for.
The result of the guardrails validation of this workflow definition
The paged response with found workflow definitions.
The total number of results.
1000The offset for the results.
10The maximum number of results to be returned.
100Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The file with described workflow definition.
The name of the file.
The workflow definition has been deployed successfully.
Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe description of the resource.
Sample descripion of the resource.The id that uniquely identifies a workflow definition in the application.
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.
The label used for starting this workflow.
Whether the start event for this workflow requires user interaction through a form or not.
This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.
Whether the workflow has the start form json model available or not. If true, then the external form definition for this task is needed to render the task.
Whether workflow is enabled or not.
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'
The type of business item that the workflow can refer to.This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable us to introduce new types of resources, we are replacing the WorkflowBusinessItemType enum with a String. For new types of resources that are supported by workflows, businessItemResourceType will be GLOBAL. Please use the businessItemDiscriminator property instead.
The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL
COMMUNITYThe exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.
Whether this workflow definition is guest user accessible.
Whether the workflow definition is accessible by any registered user.
Whether the candidate user check for this workflow is enabled.
Whether the workflow is accessible from the global create menu.
Bad Request - Request data is malformed or illegal. The request body will contain additional information.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition that should be used for the form data retrieval.
The form type to be returned.
The configuration start form data for workflow definition.
The form key.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
All possible workflow start events with name and description
Describes workflow start event with human-readable name and description.
The event type identifier
The event type name
The event type description
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition that should be used for the form data retrieval.
The form type to be returned.
The start form data for workflow definition.
The form key.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The process ID of the workflow definition.
The workflow definition successfully found.
Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file.
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe description of the resource.
Sample descripion of the resource.The id that uniquely identifies a workflow definition in the application.
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.
The label used for starting this workflow.
Whether the start event for this workflow requires user interaction through a form or not.
This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.
Whether the workflow has the start form json model available or not. If true, then the external form definition for this task is needed to render the task.
Whether workflow is enabled or not.
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'
The type of business item that the workflow can refer to.This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable us to introduce new types of resources, we are replacing the WorkflowBusinessItemType enum with a String. For new types of resources that are supported by workflows, businessItemResourceType will be GLOBAL. Please use the businessItemDiscriminator property instead.
The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL
COMMUNITYThe exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.
Whether this workflow definition is guest user accessible.
Whether the workflow definition is accessible by any registered user.
Whether the candidate user check for this workflow is enabled.
Whether the workflow is accessible from the global create menu.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The workflow definition diagram successfully found.
No content
No diagram has been found.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
No content
The ID of the workflow definition.
The workflow definition XML successfully found.
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
The ID of the workflow definition.
The ID of the assignment rule.
Assignment rule has been removed.
No content
Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
No content
The job for removal workflow definitions has been created.
Represents a job. Job is a single atomic task that is to be performed asynchronously
The id of the represented object (entity).
The id of the user that created this resource.
4d250cc5-e583-4640-9874-b93d82c7a6cbThe timestamp (in UTC time standard) of the creation of this resource.
1475503010320The id of the user who modified this resource the last time.
a073ff90-e7bc-4b35-ba90-c4d475f642feThe timestamp (in UTC time standard) of the last modification of this resource.
1476703764163Whether this is a system resource or not.
The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
The name of the resource.
Test nameThe type of the job.
IMPORTThe ID of the user that initiated this job.
The visibility of the job.
The progress percentage of the job.
50Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted.
The start date of the job.
1488016800The end date of the job.
1488021800The state of the job.
COMPLETEDPossible values: The result of the job.
SUCCESSPossible values: The message of the job.
Import finished in 12s.Unauthorized - Authentication has failed or has not been provided.
Internal Server Error - The server encountered an unexpected condition which prevented it from fulfilling the request. Please report a problem as this situation should not occur.
Last updated
Was this helpful?