topic run workflow param uniqueQualifier not documented in Automations

run workflow param uniqueQualifier not documented

henk_stobbe — Mon, 17 Jun 2024 21:00:19 GMT

Hello,

When triggering a workflow by API, you can use an extra parameter :

uniqueQualifier

As this is not documented, who can explain to me where this parameter is used for?

Seems setting it prevents running the workflow?

Furure use?

KR Henk

Re: run workflow param uniqueQualifier not documented

sinisa_zubic — Wed, 19 Jun 2024 16:45:23 GMT

Hi @henk_stobbe

the uniqueQualifier is an optional Id you can assign to a workflow execution. You can't start a workflow with an existing unique qualifier. The retention time for a workflow is 30 days. After that period you can reuse again the same unique qualifier.

I hope this made it now more clear to you.

Best,
Sini

Re: run workflow param uniqueQualifier not documented

ChristopherHejl — Wed, 19 Jun 2024 17:35:08 GMT

To expand on Sinisas answer a bit: The unqiueQualifier is a way to make sure you don't run the same workflow multiple times in case there might be multiple triggers. For example you have some sort of workflow you want to run in response to an application release but this trigger may come from different sources (different builds from different services belonging to the same app) so you might add "My app v1.2.3" as a uniqueQualifier. Now if you start the workflow again with the same qualifier (within 30 days) the Workflow will NOT start again.