Availability

Child pages
  • Documentation

Skip to end of metadata
Go to start of metadata

This page has been renamed to Reference.

On this page

Quick Tips

  • To get all help from a command line use: --help
  • To get help for any action, add --help to the action
    • Example: --action getClientInfo --help
  • More tips

Actions

 

Action

Description

Required Parameters

Optional Parameters

Output Formats

Category

Type

1

addAttachment

Add an attachment to an issue.

issue, file

findReplace, findReplaceRegex, name, encoding

 

Attachments

Create

2

addAttachments

Add multiple attachments to an issue from files in a directory matching a regex pattern.

issue, file

recursive, regex, findReplace, findReplaceRegex, name, encoding

 

Attachments

Create

3

addComment

Add a comment to an issue.

issue

comment, group, role, findReplace, findReplaceRegex, file, encoding, dateFormat

 

Comments

Create

4

addComponent

Add component to a project.

project, component

description, lead, defaultAssignee, replace

 

Components

Create

5

addCustomField

Add a new custom field. Type must be a valid custom field type key. Optionally, search can be a valid search template key. If continue is specified, a new custom field will be added even if a custom field exists with the same name.

field, type

description, search, continue

 

Fields

Create

6

addGroup

Add a new group.

group

preserveCase

 

Groups

Create

7

addLabels

Add labels to an issue. Requires labels are available for edit on the issue screen.

issue, labels

suppressNotify

 

Labels

Create

8

addProjectCategory

Add a project category.

name, description

 

 

Projects

Create

9

addProjectRole

Add a global project role.

name

description, replace, continue

 

Projects

Create

10

addProjectRoleActors

Add users or groups to a project role.

project, role, userId or group

 

 

Projects

Create

11

addRemoteLink

Add a remote link to an issue. Name is used instead of title from the UI. Specify a reverseLink value to have a reverse link added where supported.

issue, name or link

url, toIssue, reverseLink, targetServer, targetUser, targetPassword

 

Links

Create

12

addTransition

Add a transition to a workflow. Use name for the transition name. Step represents the source step and transition the target step which defaults to step. Transition screen defaults to none.

workflow, name, step

description, transition, screen

 

Issues

Create

13

addTransitionFunction

Add a transition function (post function or validator type) to a workflow transition. Function configuration is just field/values pairs and is provided using the same parameters as for setting custom field configuration - custom and related parameters.

workflow, transition, step, functionKey

type, custom, field, values, field2, values2

 

Issues

Create

14

addUser

Add a new user. Specify notify to send an email.

userId, userEmail

userFullName, userPassword, notify, preserveCase

 

Users

Create

15

addUserToGroup

Add user to a group.

userId, group

autoGroup, preserveCase

 

Users

Create

16

addUserToGroupWithFile

Add users to groups from comma separated file. Deprecated - use runFromCsv support with addUserToGroup instead.

file

autoGroup, preserveCase, encoding

 

Users

Create

17

addUserWithFile

Add users from comma separated file. Deprecated - use runFromCsv support with addUser instead.

file

notify, preserveCase, encoding

 

Users

Create

18

addVersion

Add a new version to a project.

project, version

description, after, date, startDate, dateFormat, replace

 

Versions

Create

19

addVote

Add vote for issue.

issue

 

 

Votes

Create

20

addWatchers

Add watchers to an issue. A comma separated list of user ids can be specified.

issue

userId, lookup, continue

 

Watches

Create

21

addWork

Add work log entry.

issue, timeSpent

comment, date, dateFormat, estimate, role, group, autoAdjust

 

Work

Create

22

archiveVersion

Archive a version for a project. This hides the version from the UI. Use continue to ignore error when the version is already in the correct state.

project, version

description, continue

 

Versions

Update

23

assignIssue

Assign an isssue to a userId. Use @default for userId to set the assignee to the project default. Use blank to set the assignee to null.

issue, userId

 

 

Issues

Update

24

associateWorkflow

Associate workflow to a workflow scheme.

name, workflowScheme

 

 

Workflow

Update

25

cloneIssue

Create a new issue by copying an existing issue. By default, if the issue is a subtask, it will be cloned to the same parent. Specifying the parent parameter will allow a subtask to be cloned to a different parent.

issue

parent, issueType or type, summary, resolution, labels, comment, group, role, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, findReplace, findReplaceRegex, file, encoding, toProject, reference, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix

 

Issues

Create

26

cloneIssues

Clone issues returned from a JQL search. CLI Issue Cloning has more details.

jql

toProject, issueType or type, continue, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, autoVersion, autoComponent, fieldExcludes, propertyPrefix

 

Issues

Create

27

cloneProject

Create a new project as a clone of a base project (only issue security, notification, and permission schemes will be copied to clone, some other fields are also not available to be copied to the clone).Parameters specified will override the setting copied from the base project.Optionally copy versions, components, role actors, and issues to new project. Provide a jql parameter to subset the issues to be cloned.

project, toProject

name, description, url, permissionScheme, notificationScheme, issueSecurityScheme,workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category, search, type, continue, copyVersions, autoVersion, copyComponents, autoComponent, copyRoleActors, cloneIssues, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix

 

Projects

Create

28

copyAttachments

Copy attachments from an issue to another issue.

issue, toIssue

name, regex

 

Attachments

Create

29

copyComponent

Copy a component from one project to the same project or another project.

project, component

toProject, toComponent, name, description, lead, defaultAssignee, replace

 

Components

Create

30

copyComponents

Copy all or some components from one project to another.

project, toProject

components, replace

 

Components

Create

31

copyFieldValue

Copy field value from an issue to a field of another issue. Warning: only works for fields that can be updated from their text representation.

issue, field, toIssue or field2

suppressNotify, append, appendText, encoding, dateFormat

 

Fields

Create

32

copyProjectRoleActors

Copy all role actors from a project to another project.

project, toProject

continue

 

Projects

Create

33

copyVersion

Copy a version from one project to the same project or another project.

project, version

toProject, name, description, after, date, startDate, dateFormat, replace

 

Versions

Create

34

copyVersions

Copy all versions from one project to another project.

project, toProject

continue, replace

 

Versions

Create

35

copyWorkflow

Copy a workflow to a new workflow with the name provided by the name parameter.

workflow, name

description

 

Workflow

Create

36

createBoard

Create an Agile board. Type is any support type like scrum, kanban, or diy. Project is a comma separated list of projects identified by key, name, or id.

name, type, project

 

 

Boards

Create

37

createFilter

Create a filter based on a jql search.

name, jql

description, favorite

 

Filters

Create

38

createIssue

Create a new issue for a project or a subtask of a parent issue.

issueType or type, project or parent

summary, reference, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, estimate, originalEstimate, comment, group, role, labelsfindReplace, findReplaceRegex, file, encoding

 

Issues

Create

39

createOrUpdateIssue

Search for an issue using JQL. If a single issue is found, update it. If no issue is found, create it. Formerly known as updateOrCreateIssue (deprecated).

jql, issueType or type, project or parent

summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, estimate, originalEstimate, append, appendText, continue, suppressNotify, comment, group, role, findReplace, findReplaceRegex, file, encoding

 

Issues

Create

40

createProject

Create a new project with key provided by project parameter. To share some or all scheme configurations with an existing project, consider using cloneProject or specifying an existing project on the template parameter.

project, lead

name, description, url, defaultAssignee, lookup, template, permissionScheme, notificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category

 

Projects

Create

41

createWorkflowScheme

Create a workflow scheme using a default workflow.

name, workflow

description

 

Workflow

Create

42

deleteBoard

Delete an Agile board. Use continue to ignore not found errors.

id or board

continue

 

Boards

Delete

43

deleteComponent

Delete component from a project. Use continue to ignore component not found error.

project, component

continue

 

Components

Delete

44

deleteFieldConfiguration

Delete a field configuration by id.

id

continue

 

Fields

Delete

45

deleteFieldConfigurationScheme

Delete a field configuration scheme by id.

id

continue

 

Fields

Delete

46

deleteFilter

Delete a filter by id or filter name (if it is a favorite filter). Use continue to ignore not found errors.

id or filter

continue

 

Filters

Delete

47

deleteIssue

Delete an issue. Use continue to ignore error if the issue does not exist.

issue

continue

 

Issues

Delete

48

deleteIssueSecurityScheme

Delete an issue security scheme by id.

id

continue

 

Issues

Delete

49

deleteIssueTypeScheme

Delete an issue type scheme by id.

id

continue

 

Issues

Delete

50

deleteIssueTypeScreenScheme

Delete an issue type screen scheme by id.

id

continue

 

Issues

Delete

51

deleteLink

Remove link to another issue.

issue, toIssue, link

 

 

Links

Delete

52

deleteNotificationScheme

Delete a permission scheme by id.

id

continue

 

Notifications

Delete

53

deletePermissionScheme

Delete a permission scheme by id.

id

continue

 

Permissions

Delete

54

deleteProject

Delete a project. Use continue to ignore a not found error.

project

continue

 

Projects

Delete

55

deleteScreen

Delete a screen by id.

id

continue

 

Screens

Delete

56

deleteScreenScheme

Delete a screen scheme by id.

id

continue

 

Screens

Delete

57

deleteVersion

Delete a version from a project. Update affects and fix versions for issues by removing version reference or swapping it with versions specified. Use continue to ignore version not found error.

project, version

affectsVersions, fixVersions, autoVersion, continue

 

Versions

Delete

58

deleteWorkflow

Delete an inactive workflow. Inactive means it is not associated with any project.

workflow

continue

 

Workflow

Delete

59

deleteWorkflowScheme

Delete an inactive workflow scheme.

id or name

continue

 

Workflow

Delete

60

exportData

Experimental - export project or issue participant data in a CLI compatible format.

project or jql

file, exportType, dateFormat, encoding, limit

 

 

Export

61

exportSite

Create a site export. For server, data is put into a file in the JIRA home/export directory. For Cloud, data is put into a JIRA defined file on the associated webdav server - the file can optionally be copied to a local file if the file parameter is specified and permissions allow. Also for Cloud only, use the exportAttachments parameter to request the export contain attachments and similar data.

 

file, exportAttachments

 

 

Export

62

exportWorkflow

Export workflow to XML.

workflow

file, encoding

 

Workflow

Export

63

getApplicationLinkList

Get list of a application links with optional filtering on application type and regex filtering on the name or url. Example types: jira, confluence.

 

type, limit, regex, file, append, columns, encoding

 

Links

Get

64

getAttachment

Get lastest attachment by name or id for an issue.

issue, file

name, encoding

 

Attachments

Get

65

getAttachmentList

List attachments for an issue.

issue

file, limit, regex, dateFormat, columns, encoding, append, outputFormat

1 - default, 999 - all

Attachments

Get

66

getAvailableSteps

Deprecated - getTransitionList is recommended. Get available workflow steps for issue.

issue

file, append, encoding

 

Issues

Get

67

getBoardList

List Agile boards with optional filtering by regex on name.

 

regex, file, append, columns, encoding

 

Boards

Get

68

getClientInfo

Get information about this client tool.

 

outputFormat, file, append, encoding

1 - basic, 2 - JVM, 11 - action list, 12 - parameter list

Info

Get

69

getComment

Get comment information.

issue, id

dateFormat, file, append, encoding

 

Comments

Get

70

getCommentList

List of comment information for an issue with regex filtering on comment body.

issue

file, regex, limit, outputFormat, dateFormat, columns, encoding, append

1 - default, 999 - all

Comments

Get

71

getComments

Get a formatted string of all comment text for an issue.

issue

file, dateFormat, encoding

 

Comments

Get

72

getComponent

Get information for a component of a project.

project, component

file, encoding

 

Components

Get

73

getComponentList

List components defined for a projects.

project

limit, regex, file, columns, encoding, append, outputFormat

1 - default, 2 - with project, 999 - all

Components

Get

74

getCustomFieldList

Get information on all custom fields.

 

file, append, columns, encoding

 

Fields

Get

75

getFieldConfigurationList

Get a list of field configurations with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Fields

Get

76

getFieldConfigurationSchemeList

Get a list of field configuration schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Fields

Get

77

getFieldList

Get information on all fields. Filter by id or name regex.

 

regex, file, append, columns, encoding

 

Fields

Get

78

getFieldValue

Get field value for an issue.

issue, field

file, dateFormat, reference, withId, suppressId, encoding

 

Fields

Get

79

getFilter

Get information about a filter by id or filter name (if it is a favorite filter).

id or filter

 

 

Filters

Get

80

getFilterList

Get a list of filters for the current user. On Server or if favorite is specified, the current users favorite filters will be listed. Otherwise, the filters owned by the current user will be listed. Subset the list by regex pattern on the filter name.

 

favorite, regex, limit

 

Filters

Get

81

getGroupList

Get a list of groups with optional filtering by regex on group name.

 

limit, regex, file, encoding, append

 

Groups

Get

82

getIssue

Get information about an existing issue.

issue

file, dateFormat, suppressId, encoding

1 - default, 999 - all

Issues

Get

83

getIssueHistoryList

Get issue change history.

issue

file, dateFormat, columns, encoding

 

Issues

Get

84

getIssueList

List issues for a JQL query, filter, or by project.

filter or jql or project

file, dateFormat, limit, withId, suppressId, outputFormat, columns, encoding, append

1 - default, 2 or 4 - custom fields, 3 or 4 - security level, 5 - 4 plus time values, 101 - issue keys only, 998 - all except custom, 999 - all

Issues

Get

85

getIssueSecuritySchemeList

Get a list of issue security schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Issues

Get

86

getIssueTypeList

List issue types valid for a project. If project is blank or @all, all issue types will be listed.

 

project, file, columns, encoding, append

 

Issues

Get

87

getIssueTypeSchemeList

Get a list of issue type schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Issues

Get

88

getIssueTypeScreenSchemeList

Get a list of issue type screen schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Issues

Get

89

getLinkList

List issue links for an issue or issues selected by JQL. Filter by regex pattern matching link name or description. Setting options parameter to one of outward or inward will additionally filter by link direction.

issue or jql

limit, regex, options, file, columns, encoding, append

 

Links

Get

90

getLinkTypeList

Get a list of all issue link types.

 

file, columns, encoding

 

Links

Get

91

getLoginInfo

Get login information for the current logged in user.

 

 

 

Info

Get

92

getNotificationSchemeList

Get a list of notification schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Notifications

Get

93

getPermissionSchemeList

Get a list of permission schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Permissions

Get

94

getProject

Get project information.

project

suppressId, file, encoding

 

Projects

Get

95

getProjectCategory

Get project category information.

category

 

 

Projects

Get

96

getProjectCategoryList

Get list of project categories with regex filtering on name.

 

regex, limit, file, append, columns, encoding

 

Projects

Get

97

getProjectList

List defined projects with optional filtering by lead, category, and regex on project key. Get projects with no category by setting the category parameter to blank.

 

lead, category, regex, outputFormat, file, columns, encoding

1 - default, 2 - schemes, 999 - all

Projects

Get

98

getProjectRoleActorList

Get users and groups for a project's role.

project, role

file, columns, encoding

 

Projects

Get

99

getProjectRoleByUserList

Get project roles for a user across projects. By default all projects will be included. This action can take a long time to complete depending on number of projects and roles! Filter projects by lead, category, and regex on project key. Use userId of @all to product a list for all users. Each role defines a column with a Yes or No value that indicates if the user is authorize to the project according to the role. This includes either directly authorized as a user or as a member of a group that is authorized. Use columns to subset the roles you want to display.

userId

lead, category, regex, file, append, columns, encoding

 

Users

Get

100

getProjectRoleList

Get project roles with regex filtering by role name.

 

outputFormat, regex, file, append, columns, encoding

 

Projects

Get

101

getRemoteLinkList

Get list of a remote links for an issue with optional regex filtering on the name or global id. Also filter by a specific link description if needed using link parameter. If specified, regex2 filtering will be appied to the application type specific information column.

issue

link, limit, regex, regex2, targetUser, targetPassword, outputFormat, file, append, columns, encoding

1 - basic, 999 - all

Links

Get

102

getScreenList

Get a list of screens with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Screens

Get

103

getScreenSchemeList

Get a list of screen schemes with optional regex filtering on name.

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

Screens

Get

104

getSecurityLevelList

List security levels defined for a projects.

project

file, columns, encoding, append, outputFormat

1 - default, 999 - all

Issues

Get

105

getServerInfo

Get information about the JIRA server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic, 2 - detail

Info

Get

106

getStatusList

List statuses in their customized order. If project is specified, only statuses for valid for the project will be listed.

 

project, file, encoding, append

 

Lists

Get

107

getTransitionList

Get available workflow transitions for an issue.

issue

outputFormat, file, append, encoding

1 - basic, 2 - fields

Issues

Get

108

getUser

Get user information. When name is used, the name search must return a single user.

userId or userKey or name

file, endcoding

 

Users

Get

109

getUserList

List users from a group or a search by name fragment (userId, display name, and email). Use name of @all to search for all users. Or use project and role to get all users that are part of the role for the project specified. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches.

group or name or project and role

limit, regex, includeInactive, file, columns, encoding, append, outputFormat

1 - basic, 2 - extended attributes, 999 - all

Users

Get

110

getVersion

Get information for a project version (since JIRA 4.2).

project, version

dateFormat, file, encoding

 

Versions

Get

111

getVersionList

List versions defined for a projects.

project

regex, file, columns, encoding, append, outputFormat

1 - default, 2 - description, 999 - all

Versions

Get

112

getVoterList

Get list of users that have voted for an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple, 2 - CSV, 999 - all

Votes

Get

113

getWatcherList

Get list of users that are watching an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple, 2 - CSV, 999 - all

Watches

Get

114

getWorkflow

Get workflow information.

workflow

dateFormat, file, encoding

 

Workflow

Get

115

getWorkflowList

Get list of a workflows matching selection criteria.

 

limit, regex, dateFormat, file, append, columns, encoding

 

Workflow

Get

116

getWorkflowScheme

Get workflow scheme information.

name

file, encoding

 

Workflow

Get

117

getWorkflowSchemeList

Get list of a workflow schemes matching selection criteria.

 

limit, regex, file, append, columns, encoding

1 - basic, 2 - detail

Workflow

Get

118

getWorkList

Get list of a work log entry.

issue

dateFormat, file, columns, encoding, append, outputFormat

999 - all

Work

Get

119

import

Experimental - import JSON data into JIRA from format specified by the JIRA importer.

value or file

encoding

 

 

Import

120

importWorkflow

Import workflow from XML.

workflow, file

description, findReplace, findReplaceRegex, encoding

 

Workflow

Import

121

linkIssue

Link an issue to another issue.

issue, toIssue, link

comment, group, role,

 

Issues

Update

122

login

Login to remote server. Returns login token that can be used on subsequent requests with the login or loginFromStandardInput parameters.

password

user

 

Misc

Login

123

logout

Logout of remote server.

 

 

 

Misc

Login

124

modifyFieldValue

Modify the current field value for an issue with find replace logic.

issue, field, findReplace or findReplaceRegex

dateFormat, autoVersion, autoComponent, suppressNotify

 

Fields

Update

125

progressIssue

Progress (transition) issue through workflow. Deprecated in favor of transitionIssue which uses better terminology

issue, step

issueType or type, summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, comment, group, role, findReplace, findReplaceRegex, file, encoding

 

Issues

Update

126

releaseVersion

Release a version for a project. Resets release date if provided. Defaults to current server date if release date is not set. Use continue to ignore error whem that the version is already in the correct state.

project, version

date, dateFormat, description, continue

 

Versions

Update

127

removeAttachment

Remove an attachment from an issue. A single attachment is removed by id or all attachments matching the file name.

issue, name or id

 

 

Attachments

Delete

128

removeComment

Remove a comment by id from an issue.

issue, id

 

 

Comments

Delete

129

removeCustomField

Remove a custom field by name or id. Use continue to ignore a not defined error.

field

continue

 

Fields

Delete

130

removeGroup

Remove a group.

group

defaultGroup

 

Groups

Delete

131

removeLabels

Remove labels from an issue. Requires labels are available for edit on the issue screen.

issue, labels

suppressNotify

 

Labels

Delete

132

removeProjectCategory

Remove a project category. Use continue to ignore a not found error.

category

continue

 

Projects

Delete

133

removeProjectRole

Remove a global project role.

name

continue

 

Projects

Delete

134

removeProjectRoleActors

Remove users or groups from a project role.

project, role, userId or group

 

 

Projects

Delete

135

removeRemoteLink

Remove a remote link to an issue. Name can be an numeric id, global link id, or a name.

issue, name

 

 

Links

Delete

136

removeUser

Remove a user.

userId

 

 

Users

Delete

137

removeUserFromGroup

Remove user from a group.

userId, group

 

 

Users

Delete

138

removeUserFromGroupWithFile

Remove users from groups from comma separated file. Deprecated - use runFromCsv support with removeUserFromGroup instead.

file

encoding

 

Users

Delete

139

removeUserProperty

Remove a user's property.

userId, name

lookup

 

Users

Delete

140

removeUserWithFile

Remove users from comma separate file. Deprecated - use runFromCsv support with removeUser instead.

file

encoding

 

Users

Delete

141

removeVote

Remove vote from issue.

issue

 

 

Votes

Delete

142

removeWatchers

Remove watchers from an issue. A comma separated list of user ids can be specified.

issue

userId, lookup, continue

 

Watches

Delete

143

removeWork

Remove work log entry.

id

 

 

Work

Delete

144

renderRequest

Render url based request. The response data modified by findReplace processing is returned.

request or project or issue

requestParameters, requestType, type, acceptType, findReplace, findReplaceRegex, file, encoding

 

Render

Get

145

restoreExport

Restore export from file in the JIRA home/import directory.

file

 

 

 

Import

146

run

Run actions from a file or standard input.

file or standard input

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

 

Run

Run

147

runFromAttachmentList

Run actions for a list of attachments for an issue. Available replacement variables are attachment, attachmentId.

issue

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

 

Attachments

Run

148

runFromCommentList

Run action for each comment for an issue with optional regex filtering on the comment body. Available replacement variable is commentId.

issue

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Comments

Run

149

runFromComponentList

Run actions for each component in a project. Available replacement variables are project, projectId, component, componentId.

project

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

 

Components

Run

150

runFromCsv

Run actions generated from a CSV file.

file

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

 

CSV

Run

151

runFromFieldConfigurationList

Run action for each field configuration with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Fields

Run

152

runFromFieldConfigurationSchemeList

Run action for each field configuration scheme with optional regex filtering on name. Available replacement variables are fieldConfiguration and fieldConfigurationId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Fields

Run

153

runFromGroupList

Run action for each group with optional regex filtering on group name. Available replacement variable is group.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Groups

Run

154

runFromIssueList

Run actions for each issue from an issue list based on a filter or a jql search. Available replacement variables are project, issue, issueId.

filter or jql or project

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

 

Issues

Run

155

runFromIssueSecuritySchemeList

Run action for each issue security scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Issues

Run

156

runFromIssueTypeSchemeList

Run action for each issue type scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Issues

Run

157

runFromIssueTypeScreenSchemeList

Run action for each issue type screen scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Issues

Run

158

runFromLinkList

Run action for each issue link for an issue or issues selected by JQL including filtering just like with getLinkList.

issue or jql

limit, regex, options, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Links

Run

159

runFromList

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

 

Run

Run

160

runFromNotificationSchemeList

Run action for each notification scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Notifications

Run

161

runFromPermissionSchemeList

Run action for each permission scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Permissions

Run

162

runFromProjectCategoryList

Run action for each project category with filtering like with getProjectCategoryList.

 

limit, regex, options, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Projects

Run

163

runFromProjectList

Run actions for each project with optional filtering by lead, category, and regex on project key. Available replacement variables are project, projectId.

 

lead, category, regex, common, continue, simulate, limit, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Projects

Run

164

runFromRemoteLinkList

Run action for each remote link for an issue with optional filtering defined the same as for getRemoteLinkList.

issue

link, regex, regex2, targetUser, targetPassword, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Links

Run

165

runFromScreenList

Run action for each screen with optional regex filtering on name. Available replacement variables are screen and screenId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Screens

Run

166

runFromScreenSchemeList

Run action for each screen scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Screens

Run

167

runFromSql

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

 

SQL

Run

168

runFromUserList

Run action for each user with similar filtering as getUserList. Available replacement variable is userId.

group or name or project and role

regex, limit, includeInactive, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Users

Run

169

runFromVersionList

Run actions for each version in a project. Available replacement variables are project, projectId, version, versionId.

project

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

 

Versions

Run

170

runFromWorkflowList

Run action for each workflow with regex filtering on workflow name. Available replacement variable is workflow.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Workflow

Run

171

runFromWorkflowSchemeList

Run action for each workflow scheme with regex filtering on workflow scheme name. Available replacement variables are scheme and schemeId.

 

regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

Workflow

Run

172

setFieldValue

Set field value for an issue. Use appendText to append the value to text field. Use append or subtact to have an array field modified by taking the current value and adding or removing the value specified.

issue, field, file or value or values

field2, values2, suppressNotify, appendText, append, subtract, encoding, dateFormat

 

Fields

Update

173

setShareScope

Set current users default share scope for filters. Valid values are GLOBAL and PRIVATE.

value

 

 

Filters

Update

174

transitionIssue

Transition issue through workflow.

issue, transition, continue

issueType or type, summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, comment, group, role, findReplace, findReplaceRegex, file, encoding

 

Issues

Update

175

unarchiveVersion

Unarchive a version for a project. This makes the version visible again in the UI. Use continue to ignore error when the version is already in the correct state.

project, version

description, continue

 

Versions

Update

176

unreleaseVersion

Unrelease a version for a project, optionally reset release date. Use continue to ignore error when the version is already in the correct state.

project, version

date, dateFormat, description, continue

 

Versions

Update

177

updateComment

Update an existing comment to an issue. Use  (commentBody) replacement variable if needed when replacing the comment body.

issue

comment, group, role, findReplace, findReplaceRegex, file, encoding

 

Comments

Update

178

updateComponent

Update component for a project.

project, component

name, description, lead, defaultAssignee

 

Components

Update

179

updateFilter

Update a filter by id or filter name (if it is a favorite filter).

id of filter

name, jql, description, favorite

 

Filters

Update

180

updateIssue

Update an existing issue. Use appendText to append the parameter value to for the description and environment fields. Use append to modify the fix versions or affects versions fields by their respective values.

issue

issueType or type, summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, lookup, date, dateFormat, custom, autoVersion, autoComponent, , estimate, originalEstimate, append, appendText, continue, suppressNotify, comment, group, role, findReplace, findReplaceRegex, file, encoding

 

Issues

Update

181

updateProject

Update project information. Scheme updates require compatible schemes.

project

name, description, lead, url, defaultAssignee, permissionScheme, notificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category

 

Projects

Update

182

updateProjectCategory

Update a project category with a new name or description.

category

name, description

 

Projects

Update

183

updateProjectRole

Update a global project role.

role

name, description

 

Projects

Update

184

updateUser

Update user information or status.

userId or userKey

userFullName, userEmail, newUserId, activate, deactivate

 

Users

Update

185

updateUserProperty

Add or update a user's property.

userId, name, value

lookup

 

Users

Update

186

updateVersion

Update version for a project.

project, version

name, description, after, date, startDate, dateFormat, autoVersion

 

Versions

Update

187

updateWork

Update work log entry.

id, issue

timeSpent, comment, date, dateFormat, estimate, role, group, autoAdjust

 

Work

Update

188

validateLicense

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

 

 

 

Misc

Check

Parameters

 

Parameter

Short

Value

Description

1

acceptType

 

Content type to accept for renderRequest if different than type.

2

action

a

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

3

activate

 

 

Activate user.

4

affectsVersions

 

Affects versions - comma separated names or ids.

5

after

 

Version name or id to add a version after. Defaults to after last version. Use -1 to make it the first version.

6

afterSql

 

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

7

api

 

API version. Some requests produce different results based on the api version used.

8

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.

9

appendText

 

 

Append text to existing value text for description, environment, and single and multi-value custom fields.

10

asCascadeSelect

 

 

Deprecatated. Ignored on JIRA 7.x.

11

asComponent

 

 

Deprecated. Ignored on JIRA 7.x

12

assignee

 

Issue assignee user id. In some contexts, use -1 for automatic assignment and "" for unassigned.

13

asVersion

 

 

Deprecated. Ignored on JIRA 7.x.

14

autoAdjust

 

 

Auto adjust remaining estimate when adding work entry.

15

autoComponent

 

 

Automatically add components used in components parameter.

16

autoGroup

 

 

Groups are automatically added when referenced in add user functions.

17

autoVersion

 

 

Automatically add versions used in affectsVersions and fixVersions parameters.

18

board

 

Agile board name.

19

category

 

Project category. Administrator access required to see or use project categories.

20

clearFileBeforeAppend

 

 

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

21

cloneIssues

 

 

Clone issues when cloning a project.

22

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.

23

comment

 

Comment text.

24

common

 

Common parameter string added to all run actions.

25

component

 

Project component name or id.

26

components

 

Project components - comma separated names or ids.

27

connectionTimeout

 

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

28

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.

29

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.

30

copyAttachments

 

 

Copy attachments when cloning an issue.

31

copyComments

 

 

Copy comments when cloning an issue.

32

copyComponents

 

 

Copy components when cloning a project.

33

copyLinks

 

 

Copy issue links when cloning an issue.

34

copyRoleActors

 

 

Copy project role actors when cloning a project.

35

copySubtaskEstimates

 

 

Copy subtask estimates when cloning an issue.

36

copySubtasks

 

 

Copy subtasks when cloning an issue.

37

copyVersions

 

 

Copy versions when cloning a project.

38

copyWatchers

 

 

Copy Watchers when cloning an issue.

39

custom

 

A list of custom field key:value pairs. Normally a comma separated list of colon separated pairs. Key can be field name or id. Single quote the key:value pair if it contains a comma (,) or line breaks and similarly for the colon separator. An alternative is to use a JSON formatted string to represent the list of key:value pairs.

40

database

 

Database name is required for SQL actions.

41

date

 

Release date for version or due date for issue.

42

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.

43

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.

44

dbCreateTable

 

 

Database table needs to be created before adding rows.

45

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

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

46

dbPassword

 

Database user password. Defaults to password.

47

dbTable

 

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

48

dbTableKeys

 

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

49

dbUser

 

Database user name. Defaults to user.

50

deactivate

 

 

Deactivate user.

51

debug

 

 

Requests detail debug output. Optional for all actions.

52

defaultAssignee

 

Project or compnent default assignee for issues. For projects, default is unassigned with options: PROJECT_LEAD or UNASSIGNED (blank). For components, default is PROJECT_DEFAULT with options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or UNASSIGNED (blank).

53

defaultGroup

 

Default group to transfer comment and worklog visibility settings to on removeGroup.

54

deleteFilter

 

 

Attempt to delete the filter associated with the board. Filter must be a findable as a favorite filter.

55

description

 

Description.

56

driver

 

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

57

encoding

 

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

58

environment

 

Issue environment.

59

estimate

 

Estimate of time remaining for an issue. Example: 3h 30m.

60

exportAttachments

 

 

Export attachments and similar data for site export.

61

exportType

 

PROJECT to export project information, PARTICIPANTS to export issue participants. Use comman separated list if more than one are needed.

62

favorite

 

 

Mark a filter as a favorite when creating or updating a filter.

63

field

 

Field name or id. For some actions, this parameter must be a custom field.

64

field2

 

Field name or id for a custom field.

65

fieldConfigurationScheme

 

Field configuration scheme name or id. Use blank for default scheme.

66

fieldExcludes

 

Fields to exclude from cloning - comma separated list of fields.

67

file

f

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

68

filter

 

Filter id or favorite filter name. Use for getIssueList is deprecated. Use JQL instead.

69

findReplace

 

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

70

findReplaceRegex

 

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.

71

fixVersions

 

Fix versions - comma separated names or ids.

72

forUser

 

Service Desk: Request is made on behalf of another user.

73

functionKey

 

Transition function's unique key. Example: org.swift.jira.cot:createissue-function

74

group

 

Group name.

75

help

 

 

Prints this help message.

76

helpText

 

Service Desk: Help text.

77

host

 

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

78

id

 

Numeric id of an item.

79

includeInactive

 

 

To include inactive users in a user list.

80

issue

 

Issue key or id.

81

issueSecurityScheme

 

Issue security scheme name or id

82

issueType

 

Issue type - name or id.

83

issueTypeScheme

 

Issue type scheme name or id. Use blank for default scheme.

84

issueTypeScreenScheme

 

Issue type screen scheme name or id. Use blank for default scheme.

85

jql

 

JQL query. Standard way to specify a search for issues for getIssueList, runFromIssueList, and similar.

86

labels

 

Labels or tags. A blank separated list.

87

lead

 

Project lead user id.

88

legacy

 

 

Some capabilities have newer impementations (like using newer REST APIs). In some cases, the older (deprecated) implementation may still be available for a limited number of releases. This switch can be set to use the older implementation to ease migration to the newer support.

89

limit

 

Maximum number of entries to return.

90

link

 

Link description. Usually link type name for local links and relationship description for remote links.The link id can also be used for both linkIssue and deleteLink.

91

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.

92

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.

93

login

 

Login token from previous login request.

94

loginFromStandardInput

 

 

Get login token from standard input.

95

lookup

 

 

Lookup userId via search and validate. An error is reported if search does not return a single user.

96

name

 

Name.

97

newUserId

 

Used to assign a new user id to an existing user.

98

notificationScheme

 

Notification scheme name or id.

99

notify

 

 

Notify user after user is added.

100

options

 

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

101

organization

 

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

102

originalEstimate

 

Original estimate of time to complete work for an issue. Example: 3h 30m.

103

outputFormat

 

Specify output format for an action.

104

parent

 

Parent issue key or id.

105

participants

 

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

106

password

p

User password for remote access.

107

permissionScheme

 

Permission scheme name or id.

108

port

 

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

109

preserveCase

 

 

Some actions (example addUser, addGroup) automatically lowercase names usually because the construct is case insensitive. Use this switch to override the default behavior and preserve the case.

110

priority

 

Issue priority - name or id.

111

project

 

Project name, key, or id.

112

propertyFile

 

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

113

propertyPrefix

 

Prefix used for accessing properties for custom clone actions. Requires Clone Plus for JIRA be installed on the server.

114

quiet

 

 

Limit some output messages. Optional for all actions.

115

recursive

 

 

Include subdirectories.

116

reference

 

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.

117

regex

 

Regular expression for including matching content. For example, used to subset projects or versions on getProjectList and runFromVersionList.

118

regex2

 

Regular expression for secondary content matching. In some cases, filtering on a secondary field may be needed.

119

replace

 

 

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

120

reporter

 

Issue reporter user id.

121

request

 

URL fragment for a request.

122

requestParameters

 

URL request parameters or post data..

123

requestType

 

Type of a render request like GET or POST

124

resolution

 

Resolution name or id.

125

reverseLink

 

Link description for the (optional) reverse link for addRemoteLink.

126

role

 

User role in project

127

screen

 

Transition screen name.

128

search

 

Deprecated for issue search. Use jql parameter instead. For custom field actions, search represents the search key.

129

security

 

Issue security level name or id.

130

server

s

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

131

service

 

Service address extension.

132

simulate

 

 

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

133

special

 

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

134

sql

 

SQL select statement used to generate a run script.

135

startDate

 

Date version was started.

136

step

 

Source step name for addTransition.

137

subtract

 

 

Subtract values from existing values custom fields supporting multiple values.

138

summary

 

Summary of issue.

139

suppressId

 

 

Suppress showing an id when displaying issue fields on getIssue.

140

suppressNotify

 

 

Suppress notifying users when an issue is updated. Initially only available for JIRA Cloud.

141

targetPassword

 

Target server user password. Defaults to password parameter.

142

targetServer

 

Target server URL for copy requests.

143

targetUser

 

Target server user. Defaults to user parameter.

144

template

 

Project template or shared project key, name, or id (createProject action only). Project template names (case sensitive) can be found on the 'Create project' dialog. If a project template is not found, a list of valid templates will be shown in the error message.

145

timeSpent

 

Time spent on work. Example: 3h 30m.

146

toComponent

 

Project component name or id.

147

toIssue

 

Target or link destination issue key or id.

148

toProject

 

Project name, key, or id to copy to. For cloning issues, either toProject or project can be used.

149

transition

 

Workflow transition - name or id.

150

type

 

Issue type (alternative to issueType), custom field type, link type, transition function type, application link type, project type, board type, and content type for renderRequest.

151

url

 

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

152

useParentVersions

 

 

Copy parent versions to subtask when cloning an issue.

153

user

u

User name for remote access.

154

userEmail

 

User email for user management actions.

155

userFullName

 

User name for user management actions.

156

userId

 

User id for user management and other actions. For some actions, a comma separated list of ids.

157

userKey

 

Unique internal identifier for user management.

158

userPassword

 

User password for user management actions.

159

value

 

Single field or property value.

160

values

 

Comma separated list of field values. Single quote values containing commas.

161

values2

 

Comma separated list of field values. Single quote values containing commas.

162

verbose

 

 

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

163

version

 

Project version name or id or add-on version.

164

withId

 

 

Display the issue field value including the internal id (if the field has an internal value) using the following format: value (id).

165

workflow

 

Workflow name.

166

workflowScheme

 

Workflow scheme name or id. Use blank for default scheme.

Parameter Tips


Common parameters

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

Tips

  • Use double dash for multi-letter parameters - example: --help
  • Use single dash for single letter parameters indicated in the Short column - example: -v
  • When parameters are specified, most need a value as indicated by a check in the Value column - 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 and cannot both be specified
  • 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 contain blanks or some special characters 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.

 

  • No labels