Availability

Page tree

Skip to end of metadata
Go to start of metadata

On this page

Related information for 6.3.0-SNAPSHOT

Actions

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

addOrganizationUsers

Users

Cloud only. Experimental. Add uses to an organization.

organization, participants

 

 

2

addOrganization

 

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

organization

project, continue

 

3

addParticipants

 

Add one or more participants to a request.

request, participants

 

 

4

addRequestType

Organizations

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

project, name, issueType

description, helpText

 

5

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

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

1 - basic
2 - JVM

7

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

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

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

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

Lists

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

request

regex, limit, file, columns, encoding

 

12

getProjectList

Projects

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

 

regex, file, columns, encoding

 

13

getRequestTypeList

Organizations

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

project

regex, file, columns, encoding

 

14

getRequestType

Organizations

Get request type.

project, type

 

 

15

getRequest

Organizations

Get a request by key or id.

request

file, encoding

 

16

getServerInfo

Info

Get information about the JIRA and Service Desk server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail

17

removeOrganizationUsers

Users

Cloud only. Experimental. Remove users from an organization.

organization, participants

 

 

18

removeOrganization

 

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

organization

project, continue

 

19

removeParticipants

 

Remove one or more participants from a request.

request, participants

 

 

20

runFromCsv

CSV

Run actions generated from a CSV file.

file

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

 

21

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

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

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

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

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

Run

Run actions from a file or standard input.

file or standard input

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

 

27

validateLicense

Misc

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

 

 

 

Parameter Tips

Common parameters

A few common parameters are available that are not specifically listed for each action: verbose, debug, quiet.

Tips

  • Use single dash for single letter parameters - example: -v
  • Use double dash for multi-letter parameters - example: --help
  • When parameters are specified, most need a value - example: --action addPage
  • Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
  • Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
  • Some parameters become required once a specific action is chosen. This is indicated in the help text for each action.
  • Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same
  • Some parameters have default values, if so, they are indicated in the help text - example: (default: automation)
  • Some parameters are required - indicated by (...) in the help text - example: (-a|--action) <action>
  • Some parameters are optional - indicated by [...] in the help text - example: [(-f|--file) <file>]
  • Values that have more than one word must be enclosed by double quotes - example: --title "this is my title"
  • Quoting rules in commands can vary by environment (sad), here are the techniques that may work in your environment:
    • Many environments: embedded double quotes within a double quoted string can be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
    • Some environments may need different escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common "-a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
    • Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
    • A single quote sometimes can used in place of a double quote - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
  • Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
  • Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"
  • To get help for a specific action (release 5.5 and above), type the action followed by --help - example: --action getProjectList --help

Special parameter

Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command line handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.

PositionCharacterCharacter nameSuggested alternateUsage
1,comma Some parameters use comma separated lists.
2:colon#Some parameters use colon separated values.
3@at sign  
4'single quote Used in separated lists to cover cases where content contains separator.
5"double quote~Parameters containing blanks.

A blank in any position is ignored (no alternate provided).

Example: –special " #  ~" provides alternates for colon and double quote. 
         --common "--findReplace ~something to find containing a : (colon)#replacement~"  

Character Set

User and password values should be in the ISO-8859-1 character set. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.

 

Parameters

Parameter

Short

Value

Description

1

action

a

(tick)

 

2

afterSql

 

(tick)

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

3

api

 

(tick)

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

4

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

 

(error)

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

6

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

 

(tick)

Comment text.

8

common

 

(tick)

Common parameter string added to all run actions.

9

components

 

(tick)

Comma separated list of component names or ids.

10

connectionTimeout

 

(tick)

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

11

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

 

(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

 

(tick)

Database name is required for SQL actions.

14

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

 

(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

 

(error)

Database table needs to be created before adding rows.

17

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

 

(tick)

Database user password. Defaults to password.

19

dbTable

 

(tick)

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

20

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

 

(tick)

Database user name. Defaults to user.

22

debug

 

(error)

Requests detail debug output. Optional for all actions.

23

description

 

(tick)

Description of a request.

24

driver

 

(tick)

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

25

encoding

 

(tick)

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

26

field1

 

(tick)

Field name. Value is specified by the value1 parameter.

27

field2

 

(tick)

Field name. Value is specified by the value2 parameter.

28

field3

 

(tick)

Field name. Value is specified by the value3 parameter.

29

field4

 

(tick)

Field name. Value is specified by the value4 parameter.

30

field5

 

(tick)

Field name. Value is specified by the value5 parameter.

31

field6

 

(tick)

Field name. Value is specified by the value6 parameter.

32

field7

 

(tick)

Field name. Value is specified by the value7 parameter.

33

field8

 

(tick)

Field name. Value is specified by the value8 parameter.

34

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

f

(tick)

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

36

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

 

(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

 

(tick)

Request is made on behalf of another user.

39

help

 

(error)

Prints this help message.

40

helpText

 

(tick)

Help text.

41

host

 

(tick)

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

42

issueType

 

(tick)

JIRA issue type id.

43

limit

 

(tick)

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

44

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

 

(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

 

(tick)

Name.

47

options

 

(tick)

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

48

organization

 

(tick)

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

49

outputFormat

 

(tick)

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

50

participants

 

(tick)

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

51

password

p

(tick)

User password for remote access.

52

port

 

(tick)

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

53

priority

 

(tick)

Request priority - name or id.

54

project

 

(tick)

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

55

propertyFile

 

(tick)

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

56

quiet

 

(error)

Limit some output messages. Optional for all actions.

57

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

 

(tick)

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

59

replace

 

(error)

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

60

request

 

(tick)

Request key or id.

61

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

 

(tick)

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

63

simulate

 

(error)

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

64

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

 

(tick)

SQL select statement used to generate a run script.

66

summary

 

(tick)

Summary of a request.

67

type

 

(tick)

Request type name or id.

68

url

 

(tick)

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

69

user

u

(tick)

User name for remote access. (default: automation)

70

value1

 

(tick)

Value corresponding to the field1 parameter name.

71

value2

 

(tick)

Value corresponding to the field2 parameter name.

72

value3

 

(tick)

Value corresponding to the field3 parameter name.

73

value4

 

(tick)

Value corresponding to the field4 parameter name.

74

value5

 

(tick)

Value corresponding to the field5 parameter name.

75

value6

 

(tick)

Value corresponding to the field6 parameter name.

76

value7

 

(tick)

Value corresponding to the field7 parameter name.

77

value8

 

(tick)

Value corresponding to the field8 parameter name.

78

verbose

v

(error)

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

  • No labels