Availability

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 6.3.0-SNAPSHOT
Div
idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Related information for 6.3.0-SNAPSHOT

Actions

Div

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

addOrganizationUsers

Anchor
addOrganizationUsers
addOrganizationUsers

Users

Cloud only. Experimental. Add uses to an organization.

organization, participants

 

 

2

addOrganization

Anchor
addOrganization
addOrganization

 

Cloud only. Experimental. Add a new organization to the site or add an existing organization to a project.

organization

project, continue

 

3

addParticipants

Anchor
addParticipants
addParticipants

 

Add one or more participants to a request.

request, participants

 

 

4

addRequestType

Anchor
addRequestType
addRequestType

Organizations

Add request type. The JIRA issue type id must be valid for the project.

project, name, issueType

description, helpText

 

5

createRequest

Anchor
createRequest
createRequest

Organizations

Create a request for a service desk project.

project, type

summary, description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8

 

6

getClientInfo

Anchor
getClientInfo
getClientInfo

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

1 - basic
2 - JVM

7

getFieldList

Anchor
getFieldList
getFieldList

Fields

List fields with optional filtering by regex on field name. Specify specific project and/or type to filter selections, otherwise they default to @all.

 

project, type, regex, file, columns, encoding

 

8

getMyRequestList

Anchor
getMyRequestList
getMyRequestList

Organizations

List requests the user is the reporter or a participatant with optional regex filtering on summary. You can also filter by service desk project and request type.

 

project, type, regex, limit, outputFormat, file, columns, encoding

2 - fields

9

getOrganizationList

Anchor
getOrganizationList
getOrganizationList

Lists

Cloud only. Experimental. List site organizations or project specific organizations with optional filtering by regex on name.

 

project, regex, limit, file, columns, encoding

 

10

getOrganizationUserList

Anchor
getOrganizationUserList
getOrganizationUserList

Users

Cloud only. Experimental. List site organizations or project specific organizations with optional filtering by regex on user id.

organization

regex, limit, file, columns, encoding

 

11

getParticipantList

Anchor
getParticipantList
getParticipantList

Lists

List a request's participants with optional filtering by regex on name.

request

regex, limit, file, columns, encoding

 

12

getProjectList

Anchor
getProjectList
getProjectList

Projects

List service desk projects with optional filtering by regex on project key.

 

regex, file, columns, encoding

 

13

getRequestTypeList

Anchor
getRequestTypeList
getRequestTypeList

Organizations

List project's request types with optional filtering by regex on name.

project

regex, file, columns, encoding

 

14

getRequestType

Anchor
getRequestType
getRequestType

Organizations

Get request type.

project, type

 

 

15

getRequest

Anchor
getRequest
getRequest

Organizations

Get a request by key or id.

request

file, encoding

 

16

getServerInfo

Anchor
getServerInfo
getServerInfo

Info

Get information about the JIRA and Service Desk server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail

17

removeOrganizationUsers

Anchor
removeOrganizationUsers
removeOrganizationUsers

Users

Cloud only. Experimental. Remove users from an organization.

organization, participants

 

 

18

removeOrganization

Anchor
removeOrganization
removeOrganization

 

Cloud only. Experimental. Remove an organization from the site or from a project.

organization

project, continue

 

19

removeParticipants

Anchor
removeParticipants
removeParticipants

 

Remove one or more participants from a request.

request, participants

 

 

20

runFromCsv

Anchor
runFromCsv
runFromCsv

CSV

Run actions generated from a CSV file.

file

common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

21

runFromList

Anchor
runFromList
runFromList

Run

Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variables are entry, entry2.

list

list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

22

runFromMyRequestList

Anchor
runFromMyRequestList
runFromMyRequestList

Organizations

Run actions for each request from a list based on selection criteria similar to getMyRequestList. Available replacement variables are request and requestId.

 

project, type, common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding

 

23

runFromOrganizationList

Anchor
runFromOrganizationList
runFromOrganizationList

Run

Run actions for each organization from a list based on selection criteria similar to getOrganizationList. Available replacement variables are organization, organizationId.

 

project, common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding

 

24

runFromProjectList

Anchor
runFromProjectList
runFromProjectList

Projects

Run actions for each project from a list based on selection criteria similar to getProjectList. Available replacement variables are serviceDesk, serviceDeskId, projectKey, projectId.

 

common, continue, simulate, limit, regex, clearFileBeforeAppend, file, encoding

 

25

runFromSql

Anchor
runFromSql
runFromSql

Run

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file or standard input

common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

26

run

Anchor
run
run

Run

Run actions from a file or standard input.

file or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

27

validateLicense

Anchor
validateLicense
validateLicense

Misc

Validates the CLI Connector is enabled and licensed on the server.

 

 

 

Parameter Tips

Include Page
ACLI:Shared - tips for documentation
ACLI:Shared - tips for documentation

Parameters

Div

Parameter

Short

Value

Description

1

action

Anchor
action
action

a

(tick)

 

2

afterSql

Anchor
afterSql
afterSql

 

(tick)

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

3

api

Anchor
api
api

 

(tick)

API version. Some requests produce different results based on the api version used. (default: latest)

4

append

Anchor
append
append

 

(error)

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.

5

clearFileBeforeAppend

Anchor
clearFileBeforeAppend
clearFileBeforeAppend

 

(error)

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

6

columns

Anchor
columns
columns

 

(tick)

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.

7

comment

Anchor
comment
comment

 

(tick)

Comment text.

8

common

Anchor
common
common

 

(tick)

Common parameter string added to all run actions.

9

components

Anchor
components
components

 

(tick)

Comma separated list of component names or ids.

10

connectionTimeout

Anchor
connectionTimeout
connectionTimeout

 

(tick)

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

11

continue

Anchor
continue
continue

 

(error)

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.

12

cookies

Anchor
cookies
cookies

 

(tick)

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.

13

database

Anchor
database
database

 

(tick)

Database name is required for SQL actions.

14

dateFormat

Anchor
dateFormat
dateFormat

 

(tick)

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.

15

dateFormat2

Anchor
dateFormat2
dateFormat2

 

(tick)

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.

16

dbCreateTable

Anchor
dbCreateTable
dbCreateTable

 

(error)

Database table needs to be created before adding rows.

17

dbJar

Anchor
dbJar
dbJar

 

(tick)

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-9.3-1102.jdbc41.jar or

https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar

18

dbPassword

Anchor
dbPassword
dbPassword

 

(tick)

Database user password. Defaults to password.

19

dbTable

Anchor
dbTable
dbTable

 

(tick)

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

20

dbTableKeys

Anchor
dbTableKeys
dbTableKeys

 

(tick)

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

21

dbUser

Anchor
dbUser
dbUser

 

(tick)

Database user name. Defaults to user.

22

debug

Anchor
debug
debug

 

(error)

Requests detail debug output. Optional for all actions.

23

description

Anchor
description
description

 

(tick)

Description of a request.

24

driver

Anchor
driver
driver

 

(tick)

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

25

encoding

Anchor
encoding
encoding

 

(tick)

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

26

field1

Anchor
field1
field1

 

(tick)

Field name. Value is specified by the value1 parameter.

27

field2

Anchor
field2
field2

 

(tick)

Field name. Value is specified by the value2 parameter.

28

field3

Anchor
field3
field3

 

(tick)

Field name. Value is specified by the value3 parameter.

29

field4

Anchor
field4
field4

 

(tick)

Field name. Value is specified by the value4 parameter.

30

field5

Anchor
field5
field5

 

(tick)

Field name. Value is specified by the value5 parameter.

31

field6

Anchor
field6
field6

 

(tick)

Field name. Value is specified by the value6 parameter.

32

field7

Anchor
field7
field7

 

(tick)

Field name. Value is specified by the value7 parameter.

33

field8

Anchor
field8
field8

 

(tick)

Field name. Value is specified by the value8 parameter.

34

fields

Anchor
fields
fields

 

(tick)

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.

35

file

Anchor
file
file

f

(tick)

Path to file based content or result output. Use - for standard input.

36

findReplace

Anchor
findReplace
findReplace

 

(tick)

Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.

37

findReplaceRegex

Anchor
findReplaceRegex
findReplaceRegex

 

(tick)

Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.

38

forUser

Anchor
forUser
forUser

 

(tick)

Request is made on behalf of another user.

39

help

Anchor
help
help

 

(error)

Prints this help message.

40

helpText

Anchor
helpText
helpText

 

(tick)

Help text.

41

host

Anchor
host
host

 

(tick)

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

42

issueType

Anchor
issueType
issueType

 

(tick)

JIRA issue type id.

43

limit

Anchor
limit
limit

 

(tick)

Maximum number of entries to return. (default: 2147483647)

44

list

Anchor
list
list

 

(tick)

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

45

list2

Anchor
list2
list2

 

(tick)

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

46

name

Anchor
name
name

 

(tick)

Name.

47

options

Anchor
options
options

 

(tick)

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

48

organization

Anchor
organization
organization

 

(tick)

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

49

outputFormat

Anchor
outputFormat
outputFormat

 

(tick)

Specify output format for an action. (default: 1)

50

participants

Anchor
participants
participants

 

(tick)

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

51

password

Anchor
password
password

p

(tick)

User password for remote access.

52

port

Anchor
port
port

 

(tick)

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

53

priority

Anchor
priority
priority

 

(tick)

Request priority - name or id.

54

project

Anchor
project
project

 

(tick)

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

55

propertyFile

Anchor
propertyFile
propertyFile

 

(tick)

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

56

quiet

Anchor
quiet
quiet

 

(error)

Limit some output messages. Optional for all actions.

57

reference

Anchor
reference
reference

 

(tick)

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

58

regex

Anchor
regex
regex

 

(tick)

Regular expression for including matching content. For example, used to subset a request list.

59

replace

Anchor
replace
replace

 

(error)

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

60

request

Anchor
request
request

 

(tick)

Request key or id.

61

server

Anchor
server
server

s

(tick)

Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

62

service

Anchor
service
service

 

(tick)

Service address extension. (default: /rest/servicedeskapi)

63

simulate

Anchor
simulate
simulate

 

(error)

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

64

special

Anchor
special
special

 

(tick)

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

65

sql

Anchor
sql
sql

 

(tick)

SQL select statement used to generate a run script.

66

summary

Anchor
summary
summary

 

(tick)

Summary of a request.

67

type

Anchor
type
type

 

(tick)

Request type name or id.

68

url

Anchor
url
url

 

(tick)

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

69

user

Anchor
user
user

u

(tick)

User name for remote access. (default: automation)

70

value1

Anchor
value1
value1

 

(tick)

Value corresponding to the field1 parameter name.

71

value2

Anchor
value2
value2

 

(tick)

Value corresponding to the field2 parameter name.

72

value3

Anchor
value3
value3

 

(tick)

Value corresponding to the field3 parameter name.

73

value4

Anchor
value4
value4

 

(tick)

Value corresponding to the field4 parameter name.

74

value5

Anchor
value5
value5

 

(tick)

Value corresponding to the field5 parameter name.

75

value6

Anchor
value6
value6

 

(tick)

Value corresponding to the field6 parameter name.

76

value7

Anchor
value7
value7

 

(tick)

Value corresponding to the field7 parameter name.

77

value8

Anchor
value8
value8

 

(tick)

Value corresponding to the field8 parameter name.

78

verbose

Anchor
verbose
verbose

v

(error)

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