> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/data-governance/workflow-definitions.md).

# Workflow Definitions

## Add asset type assignment rule.

> Adds an asset type assignment rule to the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddAssetTypeAssignmentRuleRequest":{"required":["assetTypeId"],"type":"object","properties":{"assetTypeId":{"type":"string","description":"The ID of the asset type the added rule should refer to.","format":"uuid"},"domainId":{"type":"string","description":"The ID of the domain the assignment rule should apply for.","format":"uuid"},"communityId":{"type":"string","description":"The ID of the community the assignment rule should apply for.","format":"uuid"},"statusId":{"type":"string","description":"The ID of the status the assignment rule should apply for.","format":"uuid"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"The request describing assignment rule to be added."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/assetTypeAssignmentRules":{"post":{"tags":["Workflow Definitions"],"summary":"Add asset type assignment rule.","description":"Adds an asset type assignment rule to the workflow definition with the specified ID.","operationId":"addAssetTypeAssignmentRule","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The request describing assignment rule to be added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAssetTypeAssignmentRuleRequest"}}}},"responses":{"201":{"description":"Asset type assignment rule successfully added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Add domain type assignment rule.

> Adds a domain type assignment rule to the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AddDomainTypeAssignmentRuleRequest":{"required":["domainTypeId"],"type":"object","properties":{"domainTypeId":{"type":"string","description":"The ID of the domain type the added rule should refer to.","format":"uuid"},"communityId":{"type":"string","description":"The ID of the community the assignment rule should apply for.","format":"uuid"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"The request describing assignment rule to be added."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/domainTypeAssignmentRules":{"post":{"tags":["Workflow Definitions"],"summary":"Add domain type assignment rule.","description":"Adds a domain type assignment rule to the workflow definition with the specified ID.","operationId":"addDomainTypeAssignmentRule","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The request describing assignment rule to be added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDomainTypeAssignmentRuleRequest"}}}},"responses":{"201":{"description":"Domain type assignment rule successfully added.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}}}}}}}}}
```

## Change asset type assignment rule.

> Modifies the asset type assignment rule with the specified ID of the workflow definition with the specified ID.\<p>Only properties that are specified in this request and have not \<code>null\</code> values are updated.\<p>All other properties are ignored.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ChangeAssetTypeAssignmentRuleRequest":{"required":["assetTypeId"],"type":"object","properties":{"assetTypeId":{"type":"string","description":"The ID of the asset type the changed rule should refer to.","format":"uuid"},"domainId":{"type":"string","description":"The ID of the domain the assignment rule should apply for.","format":"uuid"},"communityId":{"type":"string","description":"The ID of the community the assignment rule should apply for.","format":"uuid"},"statusId":{"type":"string","description":"The ID of the (Asset Type) status the assignment rule should apply for.","format":"uuid"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"Parameters for the assignment rule to be changed."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/assetTypeAssignmentRules/{ruleId}":{"patch":{"tags":["Workflow Definitions"],"summary":"Change asset type assignment rule.","description":"Modifies the asset type assignment rule with the specified ID of the workflow definition with the specified ID.<p>Only properties that are specified in this request and have not <code>null</code> values are updated.<p>All other properties are ignored.","operationId":"changeAssetTypeAssignmentRule","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ruleId","in":"path","description":"The ID of the assignment rule to be changed.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Parameters for the assignment rule to be changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAssetTypeAssignmentRuleRequest"}}}},"responses":{"200":{"description":"The asset type assignment rule has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Change domain type assignment rule.

> Modifies the domain type assignment rule with the specified ID of the workflow definition with the specified ID.\<p>Only properties that are specified in this request and have not \<code>null\</code> values are updated.\<p>All other properties are ignored.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ChangeDomainTypeAssignmentRuleRequest":{"required":["domainTypeId"],"type":"object","properties":{"domainTypeId":{"type":"string","description":"The ID of the domain type the changed rule should refer to.","format":"uuid"},"communityId":{"type":"string","description":"The ID of the community the assignment rule should apply for.","format":"uuid"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"Parameters for the assignment rule to be changed."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/domainTypeAssignmentRules/{ruleId}":{"patch":{"tags":["Workflow Definitions"],"summary":"Change domain type assignment rule.","description":"Modifies the domain type assignment rule with the specified ID of the workflow definition with the specified ID.<p>Only properties that are specified in this request and have not <code>null</code> values are updated.<p>All other properties are ignored.","operationId":"changeDomainTypeAssignmentRule","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ruleId","in":"path","description":"The ID of the assignment rule to be changed.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Parameters for the assignment rule to be changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeDomainTypeAssignmentRuleRequest"}}}},"responses":{"200":{"description":"The domain type assignment rule has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get workflow definition.

> Returns the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WorkflowDefinitionImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"processId":{"type":"string","description":"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."},"startLabel":{"type":"string","description":"The label used for starting this workflow."},"formRequired":{"type":"boolean","description":"Whether the start event for this workflow requires user interaction through a form or not."},"startFormKeyAvailable":{"type":"boolean","description":"This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.","deprecated":true},"startFormJsonModelAvailable":{"type":"boolean","description":"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."},"enabled":{"type":"boolean","description":"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'"},"domainAssignmentRules":{"type":"array","description":"The list of domain assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"assetAssignmentRules":{"type":"array","description":"The list of asset assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"businessItemResourceType":{"type":"string","description":"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.","deprecated":true,"enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL"]},"businessItemDiscriminator":{"type":"string","description":"The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL"},"exclusivity":{"type":"string","description":"The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean","description":"Whether this workflow definition is guest user accessible."},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow definition is accessible by any registered user."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for this workflow is enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"startEvents":{"type":"array","description":"The start events in a list of WorkflowStartEventType enums.","items":{"type":"string","description":"The start events in a list of WorkflowStartEventType enums.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The map of configuration variable key-value pairs."},"description":"The map of configuration variable key-value pairs."},"startRoles":{"type":"array","description":"The roles allowed to start the process.","items":{"$ref":"#/components/schemas/RoleImpl"}},"stopRoles":{"type":"array","description":"The roles allowed to stop processes/tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}},"reassignRoles":{"type":"array","description":"The roles allowed to reassign tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.<p>A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.<p>Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}":{"get":{"tags":["Workflow Definitions"],"summary":"Get workflow definition.","description":"Returns the workflow definition with the specified ID.","operationId":"getWorkflowDefinition","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The workflow definition successfully found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDefinitionImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Remove workflow definition.

> Removes the workflow definition with the specified ID. The workflow definition will be completely removed from the application, including any history.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}":{"delete":{"tags":["Workflow Definitions"],"summary":"Remove workflow definition.","description":"Removes the workflow definition with the specified ID. The workflow definition will be completely removed from the application, including any history.","operationId":"removeWorkflowDefinition","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The workflow definition has been successfully removed."},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Change workflow definition.

> Modifies the workflow definition with the specified ID.\<p>Only properties that are specified in this request and have not \<code>null\</code> values are updated.\<p>All other properties are ignored.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ChangeWorkflowDefinitionRequest":{"type":"object","properties":{"name":{"maxLength":2000,"minLength":1,"type":"string","description":"The name of the workflow definition."},"description":{"type":"string","description":"The new description for the workflow definition."},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The configuration variables."},"description":"The configuration variables."},"startEvents":{"type":"array","description":"The list of workflow start event types.","items":{"type":"string","description":"The list of workflow start event types.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"businessItemResourceType":{"type":"string","description":"The type of the business item corresponding to the workflow.","enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL","USER"]},"exclusivity":{"type":"string","description":"Defines the number of times a resource workflow is able to be start.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean"},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow should be accessible by the registered user."},"candidateUserCheckDisabled":{"type":"boolean","description":"Whether the candidate user check for the workflow should be disabled."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for the workflow should be enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"enable":{"type":"boolean","description":"Whether the workflow definition should be enabled."},"startLabel":{"type":"string","description":"The start label of the workflow."},"startRoleIds":{"type":"array","description":"The list of IDs identifying the roles allowing to start the workflow.","items":{"type":"string","description":"The list of IDs identifying the roles allowing to start the workflow.","format":"uuid"}},"stopRoleIds":{"type":"array","description":"The list of IDs identifying the roles allowing to stop the workflow.","items":{"type":"string","description":"The list of IDs identifying the roles allowing to stop the workflow.","format":"uuid"}},"reassignRoleIds":{"type":"array","description":"The list of IDs identifying the roles allowing to reassign the workflow.","items":{"type":"string","description":"The list of IDs identifying the roles allowing to reassign the workflow.","format":"uuid"}}},"description":"Parameters for the workflow definition to be changed."},"WorkflowDefinitionImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"processId":{"type":"string","description":"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."},"startLabel":{"type":"string","description":"The label used for starting this workflow."},"formRequired":{"type":"boolean","description":"Whether the start event for this workflow requires user interaction through a form or not."},"startFormKeyAvailable":{"type":"boolean","description":"This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.","deprecated":true},"startFormJsonModelAvailable":{"type":"boolean","description":"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."},"enabled":{"type":"boolean","description":"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'"},"domainAssignmentRules":{"type":"array","description":"The list of domain assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"assetAssignmentRules":{"type":"array","description":"The list of asset assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"businessItemResourceType":{"type":"string","description":"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.","deprecated":true,"enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL"]},"businessItemDiscriminator":{"type":"string","description":"The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL"},"exclusivity":{"type":"string","description":"The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean","description":"Whether this workflow definition is guest user accessible."},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow definition is accessible by any registered user."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for this workflow is enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"startEvents":{"type":"array","description":"The start events in a list of WorkflowStartEventType enums.","items":{"type":"string","description":"The start events in a list of WorkflowStartEventType enums.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The map of configuration variable key-value pairs."},"description":"The map of configuration variable key-value pairs."},"startRoles":{"type":"array","description":"The roles allowed to start the process.","items":{"$ref":"#/components/schemas/RoleImpl"}},"stopRoles":{"type":"array","description":"The roles allowed to stop processes/tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}},"reassignRoles":{"type":"array","description":"The roles allowed to reassign tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.<p>A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.<p>Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}":{"patch":{"tags":["Workflow Definitions"],"summary":"Change workflow definition.","description":"Modifies the workflow definition with the specified ID.<p>Only properties that are specified in this request and have not <code>null</code> values are updated.<p>All other properties are ignored.","operationId":"changeWorkflowDefinition","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"Parameters for the workflow definition to be changed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeWorkflowDefinitionRequest"}}}},"responses":{"200":{"description":"The workflow definition has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDefinitionImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Find workflow definitions.

> Finds the workflow definitions matching the criteria described in the request object. By default, the result contains up to 1000 workflow definitions.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WorkflowDefinitionPagedResponse":{"type":"object","properties":{"total":{"type":"integer","description":"The total number of results.","format":"int64"},"offset":{"type":"integer","description":"The offset for the results.","format":"int64"},"limit":{"type":"integer","description":"The maximum number of results to be returned.","format":"int64"},"results":{"type":"array","description":"The list of results.","items":{"$ref":"#/components/schemas/WorkflowDefinitionImpl"}}}},"WorkflowDefinitionImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"processId":{"type":"string","description":"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."},"startLabel":{"type":"string","description":"The label used for starting this workflow."},"formRequired":{"type":"boolean","description":"Whether the start event for this workflow requires user interaction through a form or not."},"startFormKeyAvailable":{"type":"boolean","description":"This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.","deprecated":true},"startFormJsonModelAvailable":{"type":"boolean","description":"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."},"enabled":{"type":"boolean","description":"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'"},"domainAssignmentRules":{"type":"array","description":"The list of domain assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"assetAssignmentRules":{"type":"array","description":"The list of asset assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"businessItemResourceType":{"type":"string","description":"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.","deprecated":true,"enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL"]},"businessItemDiscriminator":{"type":"string","description":"The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL"},"exclusivity":{"type":"string","description":"The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean","description":"Whether this workflow definition is guest user accessible."},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow definition is accessible by any registered user."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for this workflow is enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"startEvents":{"type":"array","description":"The start events in a list of WorkflowStartEventType enums.","items":{"type":"string","description":"The start events in a list of WorkflowStartEventType enums.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The map of configuration variable key-value pairs."},"description":"The map of configuration variable key-value pairs."},"startRoles":{"type":"array","description":"The roles allowed to start the process.","items":{"$ref":"#/components/schemas/RoleImpl"}},"stopRoles":{"type":"array","description":"The roles allowed to stop processes/tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}},"reassignRoles":{"type":"array","description":"The roles allowed to reassign tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.<p>A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.<p>Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/workflowDefinitions":{"get":{"tags":["Workflow Definitions"],"summary":"Find workflow definitions.","description":"Finds the workflow definitions matching the criteria described in the request object. By default, the result contains up to 1000 workflow definitions.","operationId":"findWorkflowDefinitions","parameters":[{"name":"offset","in":"query","description":"The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","description":"The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.","schema":{"type":"integer","format":"int32","default":0}},{"name":"countLimit","in":"query","description":"Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped","schema":{"type":"integer","format":"int32","default":-1}},{"name":"assetId","in":"query","description":"The list of the IDs of business items (assets) for which the workflow definitions should be found.","schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"domainId","in":"query","description":"The list of the IDs of business items (domains) for which the workflow definitions should be found.","schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"communityId","in":"query","description":"The list of the IDs of business items (communities) for which the workflow definitions should be found.","schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"enabled","in":"query","description":"Whether the found workflow definitions should be enabled.","schema":{"type":"boolean"}},{"name":"global","in":"query","description":"Whether the found workflow definitions should be global.","schema":{"type":"boolean"}},{"name":"definitionIdPhrase","in":"query","description":"The ID (could be partial) of workflow definition.","schema":{"type":"string"}},{"name":"name","in":"query","description":"The name (could be partial) of the workflow definition to search for.","schema":{"type":"string"}},{"name":"sortOrder","in":"query","description":"The sorting order.","schema":{"type":"string","enum":["ASC","DESC"],"default":"ASC"}},{"name":"sortField","in":"query","description":"The field on which the results are sorted.","schema":{"type":"string","enum":["NAME","LAST_MODIFIED_ON","DEPLOYED_ON"],"default":"NAME"}},{"name":"description","in":"query","description":"The description (could be partial) of the workflow definition to search for.","schema":{"type":"string"}},{"name":"guardrailsValidationResult","in":"query","description":"The result of the guardrails validation of this workflow definition","schema":{"type":"string","enum":["VALID","VALID_WITH_EXCEPTIONS","INVALID"]}}],"responses":{"200":{"description":"The paged response with found workflow definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDefinitionPagedResponse"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Deploy workflow definition.

> Deploys workflow definition (the business process and resources) using the specified request.\<p> The input stream can represent a single file(e.g: .bpmn20.xml or .bpmn) or an archive file (e.g: .zip or .bar). It is not allowed to deploy a resource containing more than one process definition.\<p> The file name must have the correct file extension, matching the one of the provided file input stream.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WorkflowDefinitionImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"processId":{"type":"string","description":"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."},"startLabel":{"type":"string","description":"The label used for starting this workflow."},"formRequired":{"type":"boolean","description":"Whether the start event for this workflow requires user interaction through a form or not."},"startFormKeyAvailable":{"type":"boolean","description":"This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.","deprecated":true},"startFormJsonModelAvailable":{"type":"boolean","description":"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."},"enabled":{"type":"boolean","description":"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'"},"domainAssignmentRules":{"type":"array","description":"The list of domain assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"assetAssignmentRules":{"type":"array","description":"The list of asset assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"businessItemResourceType":{"type":"string","description":"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.","deprecated":true,"enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL"]},"businessItemDiscriminator":{"type":"string","description":"The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL"},"exclusivity":{"type":"string","description":"The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean","description":"Whether this workflow definition is guest user accessible."},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow definition is accessible by any registered user."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for this workflow is enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"startEvents":{"type":"array","description":"The start events in a list of WorkflowStartEventType enums.","items":{"type":"string","description":"The start events in a list of WorkflowStartEventType enums.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The map of configuration variable key-value pairs."},"description":"The map of configuration variable key-value pairs."},"startRoles":{"type":"array","description":"The roles allowed to start the process.","items":{"$ref":"#/components/schemas/RoleImpl"}},"stopRoles":{"type":"array","description":"The roles allowed to stop processes/tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}},"reassignRoles":{"type":"array","description":"The roles allowed to reassign tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.<p>A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.<p>Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/workflowDefinitions":{"post":{"tags":["Workflow Definitions"],"summary":"Deploy workflow definition.","description":"Deploys workflow definition (the business process and resources) using the specified request.<p> The input stream can represent a single file(e.g: .bpmn20.xml or .bpmn) or an archive file (e.g: .zip or .bar). It is not allowed to deploy a resource containing more than one process definition.<p> The file name must have the correct file extension, matching the one of the provided file input stream.","operationId":"deployWorkflowDefinition","requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file","fileName"],"type":"object","properties":{"file":{"type":"string","description":"The file with described workflow definition.","format":"binary"},"fileName":{"type":"string","description":"The name of the file."}}}}}},"responses":{"201":{"description":"The workflow definition has been deployed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDefinitionImpl"}}}},"400":{"description":"Bad Request - Request data is malformed or illegal. The request body will contain additional information."},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get configuration start form data.

> Returns the task configuration start form data of the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StartFormDataImpl":{"type":"object","properties":{"formKey":{"type":"string","description":"The form key."},"formProperties":{"type":"array","description":"The list of form properties.","items":{"$ref":"#/components/schemas/FormProperty"}},"processId":{"type":"string"}}},"FormProperty":{"type":"object","properties":{"id":{"type":"string","description":"The id of the property."},"name":{"type":"string","description":"The name of the property."},"type":{"type":"string","description":"The property type."},"value":{"type":"string","description":"The property (default) value."},"writable":{"type":"boolean","description":"Whether the property is writable."},"required":{"type":"boolean","description":"Whether the property is required."},"enumValues":{"type":"array","description":"The property's enum values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"checkButtons":{"type":"array","description":"The property's checkbox buttons.","items":{"$ref":"#/components/schemas/OptionValue"}},"radioButtons":{"type":"array","description":"The property's radio buttons.","items":{"$ref":"#/components/schemas/OptionValue"}},"defaultDropdownValues":{"type":"array","description":"The property's default dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"proposedDropdownValues":{"type":"array","description":"The property's proposed dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"dateTimeType":{"type":"string","description":"The datetime type in case the property is of type datetime."},"multiValue":{"type":"boolean","description":"Whether the property allows multiple values."},"proposedFixed":{"type":"boolean","description":"Whether the property's proposed values are the only set of allowed values to select."},"defaultFromResource":{"type":"boolean","description":"Whether the property's default value is the current resource."},"multiDefaultDropdownValues":{"type":"object","additionalProperties":{"type":"array","description":"The multi default dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"description":"The multi default dropdown values."},"multiProposedDropdownValues":{"type":"object","additionalProperties":{"type":"array","description":"The multi proposed dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"description":"The multi proposed dropdown values."},"assetType":{"$ref":"#/components/schemas/ResourceReference"},"assetTypeIds":{"type":"array","description":"The asset type ids.","items":{"type":"string","description":"The asset type ids.","format":"uuid"}},"communityIds":{"type":"array","description":"Community ids.","items":{"type":"string","description":"Community ids.","format":"uuid"}},"domainIds":{"type":"array","description":"Domain ids.","items":{"type":"string","description":"Domain ids.","format":"uuid"}},"statusIds":{"type":"array","description":"Status ids.","items":{"type":"string","description":"Status ids.","format":"uuid"}},"helpText":{"type":"string","description":"Help text."}},"description":"Represents one field in the form."},"DropdownValue":{"type":"object","properties":{"relationTypeDirection":{"type":"string","description":"The relation type direction. This is only set when the dropdown value represents a relation type.","enum":["TO_SOURCE","TO_TARGET","BOTH","NONE"]},"idAsString":{"type":"string","description":"Returns the id of the dropdown value."},"parents":{"type":"array","description":"The list of parents.","items":{"type":"string"}},"id":{"type":"string","description":"The id of the dropdown value if it is possible to convert it to UUID.","format":"uuid"},"text":{"type":"string","description":"The text."}},"description":"Represents a dropdown value."},"OptionValue":{"type":"object","properties":{"label":{"type":"string","description":"The label of the option."},"value":{"type":"string","description":"The value of the option."}},"description":"Represents option in the form."},"ResourceReference":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."}},"description":"Represents reference to the resource."}}},"paths":{"/workflowDefinitions/workflowDefinition/{workflowDefinitionId}/configurationStartFormData":{"get":{"tags":["Workflow Definitions"],"summary":"Get configuration start form data.","description":"Returns the task configuration start form data of the workflow definition with the specified ID.","operationId":"getConfigurationStartFormData","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition that should be used for the form data retrieval.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"formPropertyType","in":"query","description":"The form type to be returned.","schema":{"type":"string"}}],"responses":{"200":{"description":"The configuration start form data for workflow definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFormDataImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get all possible workflow start events

> Returns all possible workflow start events, including event name and description

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NamedDescribedWorkflowStartEventType":{"type":"object","properties":{"eventType":{"type":"string","description":"The event type identifier","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]},"name":{"type":"string","description":"The event type name"},"description":{"type":"string","description":"The event type description"}},"description":"Describes workflow start event with human-readable name and description."}}},"paths":{"/workflowDefinitions/startEvents":{"get":{"tags":["Workflow Definitions"],"summary":"Get all possible workflow start events","description":"Returns all possible workflow start events, including event name and description","operationId":"getPossibleStartEvents","responses":{"200":{"description":"All possible workflow start events with name and description","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NamedDescribedWorkflowStartEventType"}}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get start form data.

> Returns the task start form data of the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StartFormDataImpl":{"type":"object","properties":{"formKey":{"type":"string","description":"The form key."},"formProperties":{"type":"array","description":"The list of form properties.","items":{"$ref":"#/components/schemas/FormProperty"}},"processId":{"type":"string"}}},"FormProperty":{"type":"object","properties":{"id":{"type":"string","description":"The id of the property."},"name":{"type":"string","description":"The name of the property."},"type":{"type":"string","description":"The property type."},"value":{"type":"string","description":"The property (default) value."},"writable":{"type":"boolean","description":"Whether the property is writable."},"required":{"type":"boolean","description":"Whether the property is required."},"enumValues":{"type":"array","description":"The property's enum values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"checkButtons":{"type":"array","description":"The property's checkbox buttons.","items":{"$ref":"#/components/schemas/OptionValue"}},"radioButtons":{"type":"array","description":"The property's radio buttons.","items":{"$ref":"#/components/schemas/OptionValue"}},"defaultDropdownValues":{"type":"array","description":"The property's default dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"proposedDropdownValues":{"type":"array","description":"The property's proposed dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"dateTimeType":{"type":"string","description":"The datetime type in case the property is of type datetime."},"multiValue":{"type":"boolean","description":"Whether the property allows multiple values."},"proposedFixed":{"type":"boolean","description":"Whether the property's proposed values are the only set of allowed values to select."},"defaultFromResource":{"type":"boolean","description":"Whether the property's default value is the current resource."},"multiDefaultDropdownValues":{"type":"object","additionalProperties":{"type":"array","description":"The multi default dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"description":"The multi default dropdown values."},"multiProposedDropdownValues":{"type":"object","additionalProperties":{"type":"array","description":"The multi proposed dropdown values.","items":{"$ref":"#/components/schemas/DropdownValue"}},"description":"The multi proposed dropdown values."},"assetType":{"$ref":"#/components/schemas/ResourceReference"},"assetTypeIds":{"type":"array","description":"The asset type ids.","items":{"type":"string","description":"The asset type ids.","format":"uuid"}},"communityIds":{"type":"array","description":"Community ids.","items":{"type":"string","description":"Community ids.","format":"uuid"}},"domainIds":{"type":"array","description":"Domain ids.","items":{"type":"string","description":"Domain ids.","format":"uuid"}},"statusIds":{"type":"array","description":"Status ids.","items":{"type":"string","description":"Status ids.","format":"uuid"}},"helpText":{"type":"string","description":"Help text."}},"description":"Represents one field in the form."},"DropdownValue":{"type":"object","properties":{"relationTypeDirection":{"type":"string","description":"The relation type direction. This is only set when the dropdown value represents a relation type.","enum":["TO_SOURCE","TO_TARGET","BOTH","NONE"]},"idAsString":{"type":"string","description":"Returns the id of the dropdown value."},"parents":{"type":"array","description":"The list of parents.","items":{"type":"string"}},"id":{"type":"string","description":"The id of the dropdown value if it is possible to convert it to UUID.","format":"uuid"},"text":{"type":"string","description":"The text."}},"description":"Represents a dropdown value."},"OptionValue":{"type":"object","properties":{"label":{"type":"string","description":"The label of the option."},"value":{"type":"string","description":"The value of the option."}},"description":"Represents option in the form."},"ResourceReference":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."}},"description":"Represents reference to the resource."}}},"paths":{"/workflowDefinitions/workflowDefinition/{workflowDefinitionId}/startFormData":{"get":{"tags":["Workflow Definitions"],"summary":"Get start form data.","description":"Returns the task start form data of the workflow definition with the specified ID.","operationId":"getStartFormData","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition that should be used for the form data retrieval.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"formPropertyType","in":"query","description":"The form type to be returned.","schema":{"type":"string"}}],"responses":{"200":{"description":"The start form data for workflow definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartFormDataImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get workflow definition.

> Returns the workflow definition with the specified process ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"WorkflowDefinitionImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"processId":{"type":"string","description":"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."},"startLabel":{"type":"string","description":"The label used for starting this workflow."},"formRequired":{"type":"boolean","description":"Whether the start event for this workflow requires user interaction through a form or not."},"startFormKeyAvailable":{"type":"boolean","description":"This field will be removed in the future. Please, use 'startFormJsonModelAvailable' to recognize if start form model is available.","deprecated":true},"startFormJsonModelAvailable":{"type":"boolean","description":"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."},"enabled":{"type":"boolean","description":"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'"},"domainAssignmentRules":{"type":"array","description":"The list of domain assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"assetAssignmentRules":{"type":"array","description":"The list of asset assignment rules.","items":{"$ref":"#/components/schemas/AssetAssignmentRuleImpl"}},"businessItemResourceType":{"type":"string","description":"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.","deprecated":true,"enum":["ASSET","DOMAIN","COMMUNITY","GLOBAL"]},"businessItemDiscriminator":{"type":"string","description":"The resource discriminator that the workflow can refer to. The value can be one of : ASSET, DOMAIN, COMMUNITY, USER or GLOBAL"},"exclusivity":{"type":"string","description":"The exclusivity of this workflow. This determines how many times a workflow can be started for a specific resource.","enum":["RESOURCE_EXCLUSIVITY","DEFINITION_EXCLUSIVITY","UNCONSTRAINED"]},"guestUserAccessible":{"type":"boolean","description":"Whether this workflow definition is guest user accessible."},"registeredUserAccessible":{"type":"boolean","description":"Whether the workflow definition is accessible by any registered user."},"candidateUserCheckEnabled":{"type":"boolean","description":"Whether the candidate user check for this workflow is enabled."},"globalCreate":{"type":"boolean","description":"Whether the workflow is accessible from the global create menu."},"startEvents":{"type":"array","description":"The start events in a list of WorkflowStartEventType enums.","items":{"type":"string","description":"The start events in a list of WorkflowStartEventType enums.","enum":["ASSET_ADDED","ASSET_REMOVED","ASSET_STATUS_CHANGED","ASSET_DOMAIN_CHANGED","ASSET_TYPE_CHANGED","ASSET_ATTRIBUTE_CHANGED","ASSET_NAME_CHANGED","ASSET_DISPLAY_NAME_CHANGED","ASSET_ATTRIBUTE_ADDED","ASSET_ATTRIBUTE_REMOVED","DOMAIN_ADDED","DOMAIN_REMOVED","ROLE_GRANTED","ROLE_REVOKED","WORKFLOW_STARTED","WORKFLOW_CANCELED","WORKLFLOW_ESCALATION","WORKFLOW_TASK_COMPLETED","USER_ADDED","USER_REMOVED","USER_DISABLED","COMMENT_ADDED","COMMENT_REMOVED","COMMENT_CHANGED","RELATION_ADDED_AND_ASSET_IS_SOURCE","RELATION_REMOVED_AND_ASSET_WAS_SOURCE","RELATION_ADDED_AND_ASSET_IS_TARGET","RELATION_REMOVED_AND_ASSET_WAS_TARGET","TAG_ASSIGN_CHANGED","CLASSIFICATION_MATCH_ACCEPTED","CLASSIFICATION_MATCH_REJECTED","CLASSIFICATION_MATCH_ADDED","CLASSIFICATION_MATCH_REMOVED","CLASSIFICATION_MATCH_UPDATED","DATABASE_REGISTRATION_COMPLETED","DATABASE_REGISTRATION_FAILED","ASSESSMENT_COMPLETED","DATA_QUALITY_JOB_COMPLETED"]}},"configurationVariables":{"type":"object","additionalProperties":{"type":"string","description":"The map of configuration variable key-value pairs."},"description":"The map of configuration variable key-value pairs."},"startRoles":{"type":"array","description":"The roles allowed to start the process.","items":{"$ref":"#/components/schemas/RoleImpl"}},"stopRoles":{"type":"array","description":"The roles allowed to stop processes/tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}},"reassignRoles":{"type":"array","description":"The roles allowed to reassign tasks.","items":{"$ref":"#/components/schemas/RoleImpl"}}},"description":"Definition of a workflow. It contains the workflow logic, code, configuration and is usually represented by a diagram or a .bpmn file."},"AssetAssignmentRuleImpl":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"assetType":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"domain":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"community":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"status":{"$ref":"#/components/schemas/NamedResourceReferenceImpl"},"exactResourceTypeMatch":{"type":"boolean","description":"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."}},"description":"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."},"NamedResourceReferenceImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the referenced resource.","format":"uuid"},"resourceType":{"type":"string","description":"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 us to introduce new types of resources, we are replacing the ResourceType enum with a String. For new types of resources that didn't exist before this change, resourceType will be BaseDataType. Please use the resourceDiscriminator property instead. Refer to the object containing the ResourceReference for possible values.","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"resourceDiscriminator":{"type":"string","description":"The resource discriminator, which indicates the type of the referenced resource, e.g. \"Community\", \"Asset\", ... Check the documentation of the class using the resource reference for detailed documentation regarding the possible resource discriminator values."},"name":{"type":"string","description":"The name of the referenced resource."}},"description":"Represents reference to the resource, including its name."},"RoleImpl":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"description":{"type":"string","description":"The description of the resource."},"global":{"type":"boolean","description":"Whether the role is global."},"disabled":{"type":"boolean","description":"Whether the role is disabled."},"permissionList":{"type":"array","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest","items":{"type":"string","description":"The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest"}},"permissions":{"type":"array","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"items":{"type":"string","description":"The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.","deprecated":true,"enum":["EDGE","EDGE_SITE_CONNECT","EDGE_SITE_MANAGE","EDGE_SITE_ADMINISTER","EDGE_INTEGRATION_CAPABILITY_MANAGE","EDGE_VIEW_CONNECTIONS_AND_CAPABILITIES","EDGE_VIEW_LOGS","ASSET_GRID_ADMINISTRATION","ATTACHMENT_ADD","ATTACHMENT_CHANGE","ATTACHMENT_REMOVE","COMMENT_ADD","COMMENT_CHANGE","COMMENT_REMOVE","RATING_ADD","RATING_CHANGE","RATING_REMOVE","COMMUNITY_ADD","COMMUNITY_CHANGE","COMMUNITY_REMOVE","COMMUNITY_CONFIGURE_EXTERNAL_SYSTEM","COMMUNITY_RESPONSIBILITY_ADD","COMMUNITY_RESPONSIBILITY_CHANGE","COMMUNITY_RESPONSIBILITY_REMOVE","DOMAIN_ADD","DOMAIN_CHANGE","DOMAIN_REMOVE","DOMAIN_RESPONSIBILITY_ADD","DOMAIN_RESPONSIBILITY_CHANGE","DOMAIN_RESPONSIBILITY_REMOVE","WORKFLOW_MANAGE","WORKFLOW_DESIGNER_ACCESS","ASSET_ADD","ASSET_CHANGE","ASSET_REMOVE","ASSET_STATUS_CHANGE","ASSET_TYPE_CHANGE","ASSET_TAG_CHANGE","ASSET_ATTRIBUTE_ADD","ASSET_ATTRIBUTE_CHANGE","ASSET_ATTRIBUTE_REMOVE","ASSET_RESPONSIBILITY_ADD","ASSET_RESPONSIBILITY_CHANGE","ASSET_RESPONSIBILITY_REMOVE","VIEW_PERMISSIONS_CHANGE","BUSINESS_SEMANTICS_GLOSSARY","REFERENCE_DATA_MANAGER","DATA_STEWARDSHIP_MANAGER","SYSTEM_ADMINISTRATION","USER_ADMINISTRATION","WORKFLOW_ADMINISTRATION","DATA_HELPDESK","POLICY_MANAGER","DATA_DICTIONARY","CATALOG","WORKFLOW_MANAGE_ALL","WORKFLOW_MESSAGE_EVENTS_USE","VIEW_PERMISSIONS_VIEW_ALL","VIEW_MANAGE","VIEW_SHARE","VIEW_MANAGE_ALL","ADVANCED_DATA_TYPE_ADD","ADVANCED_DATA_TYPE_EDIT","ADVANCED_DATA_TYPE_REMOVE","TAGS_VIEW","TAGS_MANAGE","VALIDATION_EXECUTION","ACCESS_DATA","VIEW_SAMPLES","RELATION_TYPE_ADD","RELATION_TYPE_REMOVE","RELATION_TYPE_CHANGE","REGISTER_PROFILING_INFORMATION","REPORTING_DOWNLOAD_INSIGHTS_DATA","REPORTING_VIEW_INSIGHTS_REPORTS","INSIGHTS_VIEW","INSIGHTS_SUMMARY","TECHNICAL_LINEAGE","LOGS_VIEW","RESOURCE_MANAGE_ALL","CONFIGURATION_VIEW","CONFIGURATION_EDIT","BACKSTORE_VIEW","BACKSTORE_EDIT","ASSESSMENTS","METADATA_LAKE","PROTECT","PROTECT_EDIT","PROTECT_ADMINISTRATION","PRIVACY"]}}},"description":"Represents a role.<p>A role is a grouping of rights and responsibilities (permissions) that is assigned to individual users or user groups.<p>Collibra DGC distinguishes between global roles and resource roles."}}},"paths":{"/workflowDefinitions/process/{processId}":{"get":{"tags":["Workflow Definitions"],"summary":"Get workflow definition.","description":"Returns the workflow definition with the specified process ID.","operationId":"getWorkflowDefinitionByProcessId","parameters":[{"name":"processId","in":"path","description":"The process ID of the workflow definition.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The workflow definition successfully found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDefinitionImpl"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get process diagram.

> Returns the process diagram of the workflow definition with the specified ID. The diagram input stream returned can be null as deployed workflow definitions without graphical notation included do not have a diagram.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/diagram":{"get":{"tags":["Workflow Definitions"],"summary":"Get process diagram.","description":"Returns the process diagram of the workflow definition with the specified ID. The diagram input stream returned can be null as deployed workflow definitions without graphical notation included do not have a diagram.","operationId":"getWorkflowDefinitionDiagram","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The workflow definition diagram successfully found."},"204":{"description":"No diagram has been found."},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Get XML of workflow definition.

> Returns the XML source of the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/xml":{"get":{"tags":["Workflow Definitions"],"summary":"Get XML of workflow definition.","description":"Returns the XML source of the workflow definition with the specified ID.","operationId":"getWorkflowDefinitionXML","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The workflow definition XML successfully found.","content":{"application/xml":{}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Remove assignment rule.

> Removes the assignment rule with the specified ID from the workflow definition with the specified ID.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/workflowDefinitions/{workflowDefinitionId}/assignmentRules/{ruleId}":{"delete":{"tags":["Workflow Definitions"],"summary":"Remove assignment rule.","description":"Removes the assignment rule with the specified ID from the workflow definition with the specified ID.","operationId":"removeAssignmentRule","parameters":[{"name":"workflowDefinitionId","in":"path","description":"The ID of the workflow definition.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"ruleId","in":"path","description":"The ID of the assignment rule.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Assignment rule has been removed."},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```

## Remove multiple workflow definitions.

> Removes multiple workflow definitions asynchronously. The workflow definition(s) will be completely removed from the application, including any history.

```json
{"openapi":"3.0.3","info":{"title":"Collibra Data Governance Center Core API","version":"2.0"},"servers":[{"url":"/rest/2.0","variables":{}}],"security":[{"basicAuth":[]},{"jwtAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"jwtAuth":{"type":"http","description":"Collibra REST API authentication using JSON Web Token.","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Job":{"required":["id","resourceType"],"type":"object","properties":{"id":{"type":"string","description":"The id of the represented object (entity).","format":"uuid"},"createdBy":{"type":"string","description":"The id of the user that created this resource.","format":"uuid"},"createdOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the creation of this resource.","format":"int64"},"lastModifiedBy":{"type":"string","description":"The id of the user who modified this resource the last time.","format":"uuid"},"lastModifiedOn":{"type":"integer","description":"The timestamp (in UTC time standard) of the last modification of this resource.","format":"int64"},"system":{"type":"boolean","description":"Whether this is a system resource or not."},"resourceType":{"type":"string","description":"The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n","deprecated":true,"enum":["View","Asset","Community","Domain","AssetType","DomainType","Status","User","ClassificationMatch","UserGroup","Attribute","StringAttribute","ScriptAttribute","BooleanAttribute","DateAttribute","NumericAttribute","SingleValueListAttribute","MultiValueListAttribute","Comment","Attachment","Responsibility","Workflow","Job","Relation","RelationType","ComplexRelation","ComplexRelationType","ArticulationRule","Assignment","Scope","RelationTrace","ValidationRule","DataQualityRule","DataQualityMetric","Address","InstantMessagingAccount","Email","PhoneNumber","Website","Activity","FormProperty","WorkflowTask","ActivityChange","WorkflowInstance","Role","AttributeType","BooleanAttributeType","DateAttributeType","DateTimeAttributeType","MultiValueListAttributeType","NumericAttributeType","ScriptAttributeType","SingleValueListAttributeType","StringAttributeType","ViewSharingRule","ViewAssignmentRule","JdbcDriverFile","JdbcDriver","JdbcIngestionProperties","CsvIngestionProperties","ExcelIngestionProperties","ConnectionStringParameter","AssignedCharacteristicType","Notification","Tag","ComplexRelationLegType","ComplexRelationAttributeType","ComplexRelationLeg","BaseDataType","AdvancedDataType","DiagramPicture","DiagramPictureSharingRule","DiagramPictureAssignmentRule","Rating","Classification","PhysicalDataConnector","Context"]},"name":{"type":"string","description":"The name of the resource."},"type":{"type":"string","description":"The type of the job."},"userId":{"type":"string","description":"The ID of the user that initiated this job.","format":"uuid"},"visibility":{"type":"integer","description":"The visibility of the job.","format":"int32"},"progressPercentage":{"type":"number","description":"The progress percentage of the job.","format":"double"},"cancelable":{"type":"boolean","description":"Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."},"startDate":{"type":"integer","description":"The start date of the job.","format":"int64"},"endDate":{"type":"integer","description":"The end date of the job.","format":"int64"},"state":{"type":"string","description":"The state of the job.","enum":["WAITING","RUNNING","CANCELING","COMPLETED","CANCELED","ERROR"]},"result":{"type":"string","description":"The result of the job.","enum":["NOT_SET","SUCCESS","COMPLETED_WITH_ERROR","FAILURE","ABORTED"]},"message":{"type":"string","description":"The message of the job."}},"description":"Represents a job. Job is a single atomic task that is to be performed asynchronously"}}},"paths":{"/workflowDefinitions/removalJobs":{"post":{"tags":["Workflow Definitions"],"summary":"Remove multiple workflow definitions.","description":"Removes multiple workflow definitions asynchronously. The workflow definition(s) will be completely removed from the application, including any history.","operationId":"removeWorkflowDefinitionsInJob","requestBody":{"description":"The list of IDs of the workflow definitions to remove.","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"responses":{"200":{"description":"The job for removal workflow definitions has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"401":{"description":"Unauthorized - Authentication has failed or has not been provided."},"500":{"description":"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."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.collibra.com/api/references/data-governance/workflow-definitions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.