Skip to end of banner
Go to start of banner

Action Examples - jira getIssueList

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

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-796 │ Improvement │ Open           │ Major    │ Getting started help screen        │ This is the help screen shown when │            │ 2019-09-30 │ 2019-09-30 │                 │ 9.0.0        │
│          │             │                │          │                                    │ no 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 │ Quality Review │ Major    │ Add access parameters to action    │ Action help like for: -a           │            │ 2019-09-30 │ 2019-09-30 │                 │ 9.0.0        │
│          │             │                │          │ help display                       │ getServerInfo --help               │            │            │            │                 │              │
├──────────┼─────────────┼────────────────┼──────────┼────────────────────────────────────┼────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤
│ ACLI-793 │ Bug         │ Resolved       │ Major    │ User home directory identification │ It is common and handy to identify │ Fixed      │ 2019-09-26 │ 2019-09-26 │ 2019-09-26      │ 9.0.0        │
│          │             │                │          │ for a file parameter may not work  │ local file locations using the *~* │            │            │            │                 │              │
│          │             │                │          │ as 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 │ Resolved       │ Major    │ Support multiple findReplace and   │ This make is easier to support     │ Fixed      │ 2019-09-25 │ 2019-09-26 │ 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         │ Resolved       │ Major    │ Missing database related           │ dbCreateTable, dbTable,            │ Fixed      │ 2019-09-25 │ 2019-09-26 │ 2019-09-26      │ 9.0.0        │
│          │             │                │          │ parameters in documentation and    │ dbTableKeys, afterSql and dbJar    │            │            │            │                 │              │
│          │             │                │          │ help text                          │                                    │            │            │            │                 │              │
├──────────┼─────────────┼────────────────┼──────────┼────────────────────────────────────┼────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤
│ ACLI-788 │ Improvement │ Resolved       │ Major    │ Support field parameter on run     │ See ACLI-785 for more information  │ Fixed      │ 2019-09-24 │ 2019-09-30 │ 2019-09-25      │ 9.0.0        │
│          │             │                │          │ actions to set replacement         │ on setting and getting replacement │            │            │            │                 │              │
│          │             │                │          │ variables for the 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 │ Resolved       │ Major    │ Add a new outputType for get       │ This support provides an easy way  │ Fixed      │ 2019-09-23 │ 2019-09-25 │ 2019-09-25      │ 9.0.0        │
│          │             │                │          │ actions to set replacement         │ to retrieve data from various      │            │            │            │                 │              │
│          │             │                │          │ variables for run scripts          │ objects 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 │ Resolved       │ Major    │ New setReplacementVariables and    │ Replacement variables are a        │ Fixed      │ 2019-09-23 │ 2019-09-30 │ 2019-09-25      │ 9.0.0        │
│          │             │                │          │ getReplaceVariableList actions     │ powerful 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=<at:var at:name="issue" />*. 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         │ Resolved       │ Major    │ Help text table output wrap        │ Table wrapping when it should not. │ Fixed      │ 2019-09-21 │ 2019-09-21 │ 2019-09-21      │ 9.0.0        │
│          │             │                │          │ problem on wide screens            │                                    │            │            │            │                 │              │
├──────────┼─────────────┼────────────────┼──────────┼────────────────────────────────────┼────────────────────────────────────┼────────────┼────────────┼────────────┼─────────────────┼──────────────┤
│ ACLI-778 │ Improvement │ Resolved       │ Major    │ Change user default for Cloud      │ Current *user* parameter default   │ Fixed      │ 2019-09-17 │ 2019-09-30 │ 2019-09-18      │ 9.0.0        │
│          │             │                │          │                                    │ is *automation* and this is        │            │            │            │                 │              │
│          │             │                │          │                                    │ defined at the outer (parser)      │            │            │            │                 │              │
│          │             │                │          │                                    │ level meaning that it is visible   │            │            │            │                 │              │
│          │             │                │          │                                    │ in the help text and reference     │            │            │            │                 │              │
│          │             │                │          │                                    │ documentation as the default.      │            │            │            │                 │              │
│          │             │                │          │                                    │ While this was helpful and still   │            │            │            │                 │              │
│          │             │                │          │                                    │ appropriate for Server, it is not  │            │            │            │                 │              │
│          │             │                │          │                                    │ valid for Cloud (Jira and          │            │            │            │                 │              │
│          │             │                │          │                                    │ Confluence) as Cloud now requires  │            │            │            │                 │              │
│          │             │                │          │                                    │ an email address for the *user*    │            │            │            │                 │              │
│          │             │                │          │                                    │ parameter. Therefore we are making │            │            │            │                 │              │
│          │             │                │          │                                    │ the following changes: # Remove    │            │            │            │                 │              │
│          │             │                │          │                                    │ default value so that it will no   │            │            │            │                 │              │
│          │             │                │          │                                    │ longer appear in help text and     │            │            │            │                 │              │
│          │             │                │          │                                    │ reference documentation # We will  │            │            │            │                 │              │
│          │             │                │          │                                    │ still default Server to            │            │            │            │                 │              │
│          │             │                │          │                                    │ *automation* to maintain           │            │            │            │                 │              │
│          │             │                │          │                                    │ compatibility so there is no       │            │            │            │                 │              │
│          │             │                │          │                                    │ impact to existing usage # We will │            │            │            │                 │              │
│          │             │                │          │                                    │ default Cloud to *anonymous* which │            │            │            │                 │              │
│          │             │                │          │                                    │ will make it easy to access sites  │            │            │            │                 │              │
│          │             │                │          │                                    │ that support anonymous access.     │            │            │            │                 │              │
│          │             │                │          │                                    │ This still maintains compatibility │            │            │            │                 │              │
│          │             │                │          │                                    │ in the sense that Cloud users were │            │            │            │                 │              │
│          │             │                │          │                                    │ required to provide a *user*       │            │            │            │                 │              │
│          │             │                │          │                                    │ parameter anyway to avoid an error │            │            │            │                 │              │
│          │             │                │          │                                    │ based on the *automation* user now │            │            │            │                 │              │
│          │             │                │          │                                    │ being invalid on Cloud. This       │            │            │            │                 │              │
│          │             │                │          │                                    │ change also covers the Bitbucket   │            │            │            │                 │              │
│          │             │                │          │                                    │ Cloud client.                      │            │            │            │                 │              │
└──────────┴─────────────┴────────────────┴──────────┴────────────────────────────────────┴────────────────────────────────────┴────────────┴────────────┴────────────┴─────────────────┴──────────────┘
  • No labels