Reference


Reference

Explained

Below you will find a complete list of the Actions and Parameters available in the ACLI for this client.

Actions

These are the keywords that tell the CLI what action to take. The listed actions correspond to everything you can do via the screens on the app when you point, click, and type text into fields.

You see a pattern to the beginning or prefix that is an action verb such as: add, copy, export, get, modify, move, remove, run, store, update, and more depending on the app.

The ending or suffix to the action name is the noun or object of the verb such as attachment, comment, label, permission, user, and more depending on the app.

For example, the action addComment adds a comment to an item in the app.

Each app has its own features and set of actions,  in addition to the actions shared with other apps.

 

Parameters

Parameters tell the CLI the specific details needed to perform an action.  Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform the task.

The CLI requires at least one special parameter named action that tells what action to perform, without the action parameter, CLI displays help with some example actions. Parameters do not have prefixes like actions and are often specific to the app for the action. 

For example, the action getServerInfo requires details about the app or server from where the information is retrieved. To obtain the required information, the server parameter is used.

The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.

Example

An action and its parameters put together unlock the power to get things done with your apps.

The example shows how to retrieve information from an example Jira Cloud application with anonymous access in a multi-line format:

acli --action getServerInfo --server https://examplegear.atlassian.net --outputFormat 2

Action output:

Server info Product . . . . . . . . . . . : Jira Hosting . . . . . . . . . . . : cloud Version . . . . . . . . . . . : 1001.0.0-SNAPSHOT Base URL . . . . . . . . . . : https://examplegear.atlassian.net Title . . . . . . . . . . . . : Appfire Example Gear Jira Build . . . . . . . . . . . . : 100221 Build date . . . . . . . . . : 2023/04/10 8:02 License information . . . . . : Not available. Reason: Administrator access is required to get license information. Client . . . . . . . . . . . : jira User . . . . . . . . . . . . : anonymous Response time (milliseconds) : 638

On this page

Related pages


Generating content properties report...

--host

 

 

Deprecated. Not needed when using the url parameter. Database host server for SQL actions. Defaults to localhost.

--port

 

 

Deprecated. Not needed when using the url parameter. Database host port for SQL actions. Defaults to database default.

--acceptType

 

 

Content type to accept for renderRequest if different than contentType.

--action

a

 

Requested operation to perform. Valid actions are listed separately.

--afterSql

 

 

SQL to run after a successful action. Limited to specific actions at this time.

--app

 

 

App key.

--append

 

 

For some actions using the file parameter, append will append output to an existing file.

--autoGroup

 

 

Groups are automatically added when referenced in add user functions.

--branch

 

 

Branch id or name. For a branch permissions, it can represent a branch, branch pattern, or branching model.

--channel

 

 

Channel name or id to use for slack output type on get actions.

--clearFileBeforeAppend

 

 

For run actions, this option will automatically clear an existing file on the first append requested.

--columns

 

 

Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.

--comment

 

 

Comment text.

--common

 

 

Common parameter string added to all actions in the run script.

--config

 

 

Hook configuration in JSON format.

--connectionTimeout

 

 

Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

--continue

 

 

Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions and already exists errors on add actions.

--cookies

 

 

Name of file to restore and persist cookies across invocations of ACLI actions.

--data

 

 

JSON data for runFromJson. Post data for renderRequest. Action specific definition in some cases.

--database

 

 

Database name or reference to a ACLI configuration entry when proceeded with an @ symbol. When referencing a configuration entry, the entry should contain appropriate parameters for for defining access to the database including url and, when necessary, dbUser and dbPassword authentication parameters.

--dateFormat

 

 

Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format.

--dateFormat2

 

 

Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

--dbCreateTable

 

 

Automatically create the database table before adding rows.

--dbJar

 

 

ACLI has built-in support for Postgres and by default loads database drivers found in the ACLI installation's lib/jdbc directory. Otherwise you can specify a specific file or URL reference for the database driver jar. Examples /jdbcDrivers/postgresql-42.4.2.jar or https://jdbc.postgresql.org/download/postgresql-42.4.2.jar.

--dbPassword

 

 

Database user password. Defaults to password.

--dbTable

 

 

Database table name when creating or updating a database from list output.

--dbUser

 

 

Database user name. Defaults to the same as the user parameter.

--debug

 

 

Requests detail debug output especially useful for Support. Optional for all actions. Recommend first using verbose logging for problem determination.

--defaultGroup

 

 

Default group to move users on removeGroup action.

--descendents

 

 

All descendent files for a directory.

 

Unable to render {include} The included page could not be found.
Unable to render {include} The included page could not be found.