How to use getWorkflowDefinitionXML

Question

I’m trying to get the XML workflow definition. I’m trying ;
workflowDefintionApi.getWorkflowDefinitionXML(it.getId()).

But that call doesn’t seem to work. I am importing
com.collibra.dgc.core.api.component.workflow.WorkflowDefinitionApi.*

I’ve tried hard coding the ID, nothing.
It gives an error that it can’t parse that. If I commend out that line it parses and everything else works, so I’m fairly sure that’s the problem.
getWorkflowDefinitionDiagram also didn’t work. Is there a different way that this needs to be used?

workflowDefinitionApi.findWorkflowDefinitions worked as I expected it to.

arthurburkhardt · Answer

You shouldn’t import the workflowDefinitionApi, it’s automatically available in the workflow engine.
To facilitate development, you should use the api .jar made available by Collibra and setup your dev environment for autocompletion. The best autocomplete trick for eclipse! Get hints to java apis directly. - Product Q&A - the Data Citizens community (collibra.com)

import com.collibra.dgc.core.api.dto.workflow.FindWorkflowDefinitionsRequest

def randomWorkflowDefinition = workflowDefinitionApi.findWorkflowDefinitions(FindWorkflowDefinitionsRequest.builder().build()).results.find()

def wf = workflowDefinitionApi.getWorkflowDefinitionXML(randomWorkflowDefinition.id)
loggerApi.info("This XML has ${wf.text.size()} characters")

1	Grant Rollerson SUNCORP CORPORATE SERVICES PTY LTD
2	Tom Friesen Algonquin College
3	SB S Benson Plus3 IT
4	S stefan_busch
5	Brian Lloyd USA TODAY Co.
6	D daverichard