--- title: "Action examples - jira getIssueList" canonical: "https://support.appfire.com/space/ACLI/60564041/Action%20examples%20-%20jira%20getIssueList" format: markdown --- > Macro (aura-html) | Action | getIssueList | | --- | --- | | Description | Issue lists can be filtered by jql and other conditions. Since this example accesses the server without administration access, some information (like schemes) is not available. | | Parameters | jql, columns, outputType | | Command | ``` acli bobswift -a getIssueList --jql "project=ACLI order by created desc" --limit 10 --outputType table --columns "key,type,status,priority,summary,description,resolution,created,updated,resolution date,fix versions" --dateFormat yyyy-MM-dd ``` | ``` 10 issues. List restricted to 10 items ┌──────────┬─────────────┬────────┬──────────┬────────────────────────────────────────┬────────────────────────────────────────┬────────────┬────────────┬────────────┬─────────────────┬──────────────┐ │ Key │ Type │ Status │ Priority │ Summary │ Description │ Resolution │ Created │ Updated │ Resolution Date │ Fix Versions │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-797 │ Improvement │ Closed │ Major │ Help support to get an action list │ Client help has always beens available │ Fixed │ 2019-10-02 │ 2019-10-03 │ 2019-10-02 │ 9.0.0 │ │ │ │ │ │ with or without filtering │ with something like: *acli jira │ │ │ │ │ │ │ │ │ │ │ │ --help* - That includes all parameters │ │ │ │ │ │ │ │ │ │ │ │ and actions With this support the │ │ │ │ │ │ │ │ │ │ │ │ following addition help is available: │ │ │ │ │ │ │ │ │ │ │ │ # To get a list of valid actions for a │ │ │ │ │ │ │ │ │ │ │ │ client: *acli --action ?* # │ │ │ │ │ │ │ │ │ │ │ │ To subset the list by a prefix like: │ │ │ │ │ │ │ │ │ │ │ │ *acli --action get?* # To │ │ │ │ │ │ │ │ │ │ │ │ subset the list using generic │ │ │ │ │ │ │ │ │ │ │ │ selection: *acli --action │ │ │ │ │ │ │ │ │ │ │ │ "\*space\*"* │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-796 │ Improvement │ Closed │ Major │ Getting started help screen │ This is the help screen shown when no │ Fixed │ 2019-09-30 │ 2019-10-03 │ 2019-10-02 │ 9.0.0 │ │ │ │ │ │ │ other parameters are provided and │ │ │ │ │ │ │ │ │ │ │ │ provides some links to documentation, │ │ │ │ │ │ │ │ │ │ │ │ introduction information, and simple │ │ │ │ │ │ │ │ │ │ │ │ examples. Shown for all of the │ │ │ │ │ │ │ │ │ │ │ │ following: ``` acli acli help │ │ │ │ │ │ │ │ │ │ │ │ acli --help acli ? ``` │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-795 │ Improvement │ Closed │ Major │ Add access parameters to action help │ Action help like for: -a getServerInfo │ Fixed │ 2019-09-30 │ 2019-10-03 │ 2019-10-01 │ 9.0.0 │ │ │ │ │ │ display │ --help │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-793 │ Bug │ Closed │ Major │ User home directory identification for │ It is common and handy to identify │ Fixed │ 2019-09-26 │ 2019-10-03 │ 2019-09-26 │ 9.0.0 │ │ │ │ │ │ a file parameter may not work as │ local file locations using the *~* │ │ │ │ │ │ │ │ │ │ │ expected │ prefix like: *\-\-file ~/xxx.csv*. │ │ │ │ │ │ │ │ │ │ │ │ However this does not resolve the user │ │ │ │ │ │ │ │ │ │ │ │ home file directory in all cases and │ │ │ │ │ │ │ │ │ │ │ │ instead it may or use a directory │ │ │ │ │ │ │ │ │ │ │ │ called *~*. h3. Simple usage works │ │ │ │ │ │ │ │ │ │ │ │ ``` -a getIssueList --file │ │ │ │ │ │ │ │ │ │ │ │ ~/xxx.csv ``` h3. When used │ │ │ │ │ │ │ │ │ │ │ │ within a quoted string it does not │ │ │ │ │ │ │ │ │ │ │ │ work ``` -a run --input "-a │ │ │ │ │ │ │ │ │ │ │ │ getIssueList --file ~/xxx.csv" │ │ │ │ │ │ │ │ │ │ │ │ ``` │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-792 │ Improvement │ Closed │ Major │ Support multiple findReplace and │ This make is easier to support │ Fixed │ 2019-09-25 │ 2019-10-03 │ 2019-09-26 │ 9.0.0 │ │ │ │ │ │ findReplaceRegex parameters │ multiple find and replace requests │ │ │ │ │ │ │ │ │ │ │ │ avoiding older support requiring a │ │ │ │ │ │ │ │ │ │ │ │ comma separated list of colon │ │ │ │ │ │ │ │ │ │ │ │ separated values and the associated │ │ │ │ │ │ │ │ │ │ │ │ problems with delimiters and quoting. │ │ │ │ │ │ │ │ │ │ │ │ Each *findReplace* or │ │ │ │ │ │ │ │ │ │ │ │ *findReplaceRegex* parameter should be │ │ │ │ │ │ │ │ │ │ │ │ a colon separated find:replace pair. │ │ │ │ │ │ │ │ │ │ │ │ The colon delimiter can be replaced │ │ │ │ │ │ │ │ │ │ │ │ with a different delimiter using the │ │ │ │ │ │ │ │ │ │ │ │ *special* parameter (just like │ │ │ │ │ │ │ │ │ │ │ │ previous releases). With this support, │ │ │ │ │ │ │ │ │ │ │ │ we are deprecating the older │ │ │ │ │ │ │ │ │ │ │ │ capability and may remove that at some │ │ │ │ │ │ │ │ │ │ │ │ future version. To use the older │ │ │ │ │ │ │ │ │ │ │ │ capability, one one *findReplace* │ │ │ │ │ │ │ │ │ │ │ │ and/or one *findReplaceRegex* │ │ │ │ │ │ │ │ │ │ │ │ parameter can be specified. │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-790 │ Bug │ Closed │ Major │ Missing database related parameters in │ dbCreateTable, dbTable, dbTableKeys, │ Fixed │ 2019-09-25 │ 2019-10-03 │ 2019-09-26 │ 9.0.0 │ │ │ │ │ │ documentation and help text │ afterSql and dbJar │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-788 │ Improvement │ Closed │ Major │ Support field parameter on run actions │ See ACLI-785 for more information on │ Fixed │ 2019-09-24 │ 2019-10-03 │ 2019-09-25 │ 9.0.0 │ │ │ │ │ │ to set replacement variables for the │ setting and getting replacement │ │ │ │ │ │ │ │ │ │ │ run script │ variables. This support provides │ │ │ │ │ │ │ │ │ │ │ │ another convenient way to set │ │ │ │ │ │ │ │ │ │ │ │ replacement variables as part of │ │ │ │ │ │ │ │ │ │ │ │ running a script with run actions. The │ │ │ │ │ │ │ │ │ │ │ │ scope of the variables being set is │ │ │ │ │ │ │ │ │ │ │ │ only within the script being run by │ │ │ │ │ │ │ │ │ │ │ │ the run action. │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-786 │ Improvement │ Closed │ Major │ Add a new outputType for get actions │ This support provides an easy way to │ Fixed │ 2019-09-23 │ 2019-10-03 │ 2019-09-25 │ 9.0.0 │ │ │ │ │ │ to set replacement variables for run │ retrieve data from various objects │ │ │ │ │ │ │ │ │ │ │ scripts │ that have a *get* action as part of a │ │ │ │ │ │ │ │ │ │ │ │ CLI run script. The variables will be │ │ │ │ │ │ │ │ │ │ │ │ available in the build script after │ │ │ │ │ │ │ │ │ │ │ │ the *get* action and can be used like │ │ │ │ │ │ │ │ │ │ │ │ any other replacement variable for use │ │ │ │ │ │ │ │ │ │ │ │ in subsequent actions. Variable names │ │ │ │ │ │ │ │ │ │ │ │ are simple, lowercased names │ │ │ │ │ │ │ │ │ │ │ │ containing only characters from │ │ │ │ │ │ │ │ │ │ │ │ [a-z_0-9]. The name is converted from │ │ │ │ │ │ │ │ │ │ │ │ field text that normally show with │ │ │ │ │ │ │ │ │ │ │ │ pretty print output. h3. Example │ │ │ │ │ │ │ │ │ │ │ │ ``` -a getIssue --issue XXX-1 │ │ │ │ │ │ │ │ │ │ │ │ --suppressId --outputType variables │ │ │ │ │ │ │ │ │ │ │ │ issue_key . . . . . . . . . . : │ │ │ │ │ │ │ │ │ │ │ │ ZJIRACLI-4 subtask . . . . . . . . . . │ │ │ │ │ │ │ │ │ │ │ │ . : XXX-2 description . . . . . . . . │ │ │ │ │ │ │ │ │ │ │ │ . : Content from a file watches . . . │ │ │ │ │ │ │ │ │ │ │ │ . . . . . . . . : 1 ... issue_id . . . │ │ │ │ │ │ │ │ │ │ │ │ . . . . . . . : 305597 status . . . . │ │ │ │ │ │ │ │ │ │ │ │ . . . . . . . : Resolved assignee . . │ │ │ │ │ │ │ │ │ │ │ │ . . . . . . . . : automation updated . │ │ │ │ │ │ │ │ │ │ │ │ . . . . . . . . . . : 9/23/19 2:18 PM │ │ │ │ │ │ │ │ │ │ │ │ ``` │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-785 │ Improvement │ Closed │ Major │ New setReplacementVariables and │ Replacement variables are a powerful │ Fixed │ 2019-09-23 │ 2019-10-03 │ 2019-09-25 │ 9.0.0 │ │ │ │ │ │ getReplaceVariableList actions │ technique for scripts to access │ │ │ │ │ │ │ │ │ │ │ │ important information generated by │ │ │ │ │ │ │ │ │ │ │ │ other actions. Now, with this support, │ │ │ │ │ │ │ │ │ │ │ │ scripts can define custom variables │ │ │ │ │ │ │ │ │ │ │ │ that can be used in the same manner of │ │ │ │ │ │ │ │ │ │ │ │ other replacement variables making it │ │ │ │ │ │ │ │ │ │ │ │ possible to do more within a CLI run │ │ │ │ │ │ │ │ │ │ │ │ script without having to resort to │ │ │ │ │ │ │ │ │ │ │ │ program logic. Replacement variable │ │ │ │ │ │ │ │ │ │ │ │ names can contain letters (a-z, A-Z), │ │ │ │ │ │ │ │ │ │ │ │ numbers (0-9), or underbar and must │ │ │ │ │ │ │ │ │ │ │ │ not start with a number. h3. │ │ │ │ │ │ │ │ │ │ │ │ setReplacementVariables Set one or │ │ │ │ │ │ │ │ │ │ │ │ more replacement variables specified │ │ │ │ │ │ │ │ │ │ │ │ using field parameters with name=value │ │ │ │ │ │ │ │ │ │ │ │ syntax. Value specified replaces any │ │ │ │ │ │ │ │ │ │ │ │ previously set variable with the same │ │ │ │ │ │ │ │ │ │ │ │ name including values set by other │ │ │ │ │ │ │ │ │ │ │ │ actions that set replacement │ │ │ │ │ │ │ │ │ │ │ │ variables. This is an example to save │ │ │ │ │ │ │ │ │ │ │ │ a previously set value: *\-\-field │ │ │ │ │ │ │ │ │ │ │ │ myIssue=*. Find and replace │ │ │ │ │ │ │ │ │ │ │ │ logic is applied to the value before │ │ │ │ │ │ │ │ │ │ │ │ setting the variable providing a way │ │ │ │ │ │ │ │ │ │ │ │ to manipulate values in a script. │ │ │ │ │ │ │ │ │ │ │ │ Variables are available only within │ │ │ │ │ │ │ │ │ │ │ │ the scope of the run script they were │ │ │ │ │ │ │ │ │ │ │ │ set in. Standard replacement variable │ │ │ │ │ │ │ │ │ │ │ │ syntax works for set variables - see │ │ │ │ │ │ │ │ │ │ │ │ the documentation. h3. │ │ │ │ │ │ │ │ │ │ │ │ getReplaceVariableList More for script │ │ │ │ │ │ │ │ │ │ │ │ testing or to understand what existing │ │ │ │ │ │ │ │ │ │ │ │ variables are available in a run │ │ │ │ │ │ │ │ │ │ │ │ script. │ │ │ │ │ │ ├──────────┼─────────────┼────────┼──────────┼────────────────────────────────────────┼────────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤ │ ACLI-783 │ Bug │ Closed │ Major │ Help text table output wrap problem on │ Table wrapping when it should not. │ Fixed │ 2019-09-21 │ 2019-10-03 │ 2019-09-21 │ 9.0.0 │ │ │ │ │ │ wide screens │ │ │ │ │ │ │ └──────────┴─────────────┴────────┴──────────┴────────────────────────────────────────┴────────────────────────────────────────┴────────────┴────────────┴────────────┴─────────────────┴──────────────┘ ```