Group "instance"
Action "launch"
Launch a new workflow instanceInput parameters
- name : required : yes
- user : required : no ; default : Ø
- host : required : no ; default : Ø
- mode : required : no ; default : asynchronous
- timeout : required : no ; default : 0
Command-line Examples
To launch a workflow, use:
evqueue_api --connect tcp://localhost:5000 --user admin --password admin --instance --launch --name my_workflow_name
To launch a workflow *with parameters*, use:
evqueue_wfmanager --connect tcp://localhost:5000 --user admin --password admin --launch my_workflow_name --myparam1name myparam1value --myparam2name myparam2value
Errors
- MISSING_PARAMETER
- INVALID_PARAMETER
- INVALID_INTEGER
- UNKNOWN_OBJECT
- INVALID_WORKFLOW_PARAMETERS
Action "query"
Retrieve information about a workflow instance (executing or terminated)Input parameters
- id : required : yes
Command-line Examples
evqueue_api --connect tcp://localhost:5000 --user admin --password admin --instance --query --id 70
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_INSTANCE
- WRONG_NODE
- INVALID_XML
Action "cancel"
Cancel a running workflow instanceInput parameters
- id : required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_INSTANCE
Action "wait"
Wait for an executing workflow instance to endInput parameters
- id : required : yes
- timeout : required : no ; default : 0
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_INSTANCE
- TIMED_OUT
Action "killtask"
Immediately terminate the specified task of a running workflowInput parameters
- id : required : yes
- pid : required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_INSTANCE
Action "delete"
Removes an instnaceInput parameters
- id : required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_INSTANCE
Action "tag"
Adds a tag on an instanceInput parameters
- id : required : yes
- tag_id : required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_TAG
- UNKNOWN_INSTANCE
- INSTANCE_IS_RUNNING
- INSTANCE_ALREADY_TAGGED
Action "untag"
Removes a tag from an instanceInput parameters
- id : required : yes
- tag_id : required : yes
Errors
- MISSING_PARAMETER
- INVALID_INTEGER
- UNKNOWN_TAG_OR_INSTANCE