Page Comparison

action

a

Requested operation to perform. Valid actions are listed at the end.

afterSql

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

append

Append values to existing values for version fields, components field, and custom fields supporting multiple values. For some actions using the file parameter, append will append output to the existing file.

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 run actions.

components

Comma separated list of component names or ids.

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.

cookies

Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.

customer

A customer identified by an email address and name. Usually means a portal only user, but, in some cases, may also include full users.

data

JSON data for runFromJson.

database

Database name is required for SQL actions.

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

Database table needs to be created before adding rows.

dbJar

By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-42.1.4.jar or

dbPassword

Database user password. Defaults to password.

dbTable

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

dbTableKeys

Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.

dbUser

Database user name. Defaults to user.

debug

Requests detail debug output. Optional for all actions.

description

Description of a request.

driver

JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

encoding

Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

field

Use to set client and construct specific fields or variables using name=value syntax. The first equal sign (=) delineates the name from it's value. This provides a more convenient and expandable alternative for setting field or variables and is the recommended approach. Values are trimmed unless single quoted and single quoted strings will have single quotes removed. This provides a more convenient and expandable way to set fields as an alternative to the fields and numbered field parameters.

field1

Deprecated. Field name. Value is specified by the value1 parameter.

field2

Deprecated. Field name. Value is specified by the value2 parameter.

fields

Deprecated. Use the multiple field parameters. Use to specify request fields. A comma separated list of key:value pairs. Single quote the key:value pair if it contains a comma (,) or line breaks. An alternative is to use a JSON formatted string to represent the list of key:value pairs.

file

f

Path to file based content or result output. Use - for standard input. Use + for getting lines from 'input' parameters.

findReplace

Successively find and replace matching text with the find and replace values specified using find:replace syntax. The first colon ( delineates the find value from the replace value. Single quote values containing a color and then escape embedded quotes. Deprecated use is a comma separated list of the same. Recommend using multiple parameters instead. The deprecated use case is only valid when the multiple parameter feature is not being used.

findReplaceRegex

Successively find and replace matching text with the find and replace values specified using find:replace syntax. The first colon ( delineates the find value from the replace value. Single quote values containing a color and then escape embedded quotes. The find value must be a valid regular regular expression and the replace value can contain replacement variables for capture groups like $1, $2, and so on. For some command shells, the $ may need to be escaped. Deprecated use is a comma separated list of the same. Recommend using multiple parameters instead. The deprecated use case is only valid when the multiple parameter feature is not being used.

forUser

Request is made on behalf of another user.

help

Prints this Shows a help message.

helpText

Help text.

host

Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

input

i

Line of input used in place of file data for run actions. One or more input parameters are used as lines instead of using the file parameter. In some cases requiring a file parameter, it may be necessary to use a special value of + to indicate to use the input parameters instead.

issueType

Jira issue type id.

limit

Maximum number of list entries to return. Some actions or environments may impose a more smaller default limit.

list

Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

list2

Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

name

Name.

options

Comma separated list of support, experimental, or other client or action specific options.

organization

Organization name or id representing a grouping of users primarily for access permissions.

outputFormat

Specify output format for a list actions. Output format determines what columns are retrieved for the list. More columns usually take longer to retrieve.

outputType

CSV output from get list actions and pretty print output from get actions can optionally be converted to plain text, HTML, or json based on the value of this parameter. Get actions also support the variables output type to set replacement variables for use in a CLI run script. Valid values are: text, table, html, json, variables.

participants

A comma separated list of user ids for request participation or as organization members.

password

p

User password for remote access. Cloud users need to use an API token for almost all cases and the preference is to provide the token with the token parameter. However, for compatibility reasons, we still allow the token to be provided using the password parameter."

port

Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

priority

Request priority - name or id.

project

Service desk project name, key, or id. Also known as a service desk.

propertyFile

Property file with database parameters, field mappings, or client specific information.

quiet

Limit some output messages. Optional for all actions.

reference

Reference to a replacement key value used to remember an action specific value like issue key, entity id, or similar so it can be referenced later. Each action that allows this parameter will specify that the reference parameter is valid for the action.

regex

Regular expression for condition matching or list filtering.

replace

Replace existing entity on add, create, or similar actions.

request

Request key or id.

server

s

Server URL. Normally the same URL used when using a browser to access the server. This is a required parameter for most actions.

simulate

Simulate running actions. Log the action that would be taken.

special

Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.

sql

SQL select statement used to generate a run script.

summary

Summary of a request.

token

t

Cloud API token associated to your Atlassian account. Login to

and go to Security - API tokens to create a token.

type

Request type name or id.

url

Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

user

u

User name for remote access. Cloud users are identified by email address.

value

Field value or condition value for matching.

value1

Deprecated. Value corresponding to the field1 parameter name.

value2

Deprecated. Value corresponding to the field2 parameter name.

verbose

 v

Requests verbose output to help with problem determination. Optional for all actions.