Querys workflow engine and workflow config for the given workflow and returns a
HashRef with informations:
{
workflow => {
type => ...,
id => ...,
state => ...,
label => ...,
description => ...,
last_update => ...,
proc_state => ...,
count_try => ...,
wake_up_at => ...,
reap_at => ...,
archive_at => ...,
context => { ... },
attribute => { ... }, # only if "with_attributes => 1"
},
# only if "with_ui_info => 1":
handles => [ ... ],
activity => { ... },
state => {
button => { ... },
option => [ ... ],
output => [ ... ],
},
}
Parameters
Changes compared to API v1:
- parameter "TYPE" was removed (use API
command get_workflow_base_info instead to get workflow info by type).
- parameter "WORKFLOW" was removed (old
API spec and code did not match and it was only used in two places).
- parameter "ATTRIBUTE" was renamed to
"with_attributes".
- parameter "UIINFO" was removed
(previously unused).