Availability

Child pages
  • Documentation

Skip to end of metadata
Go to start of metadata

This page has been renamed to Reference.

On this page

Related information for 6.1.0

Actions

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

addAttachment

Attachments

Add an attachment to an issue.

issue, file

findReplace, findReplaceRegex, name, encoding

 

2

addAttachments

Attachments

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

issue, file

recursive, regex, findReplace, findReplaceRegex, name, encoding

 

3

addComment

Comments

Add a comment to an issue.

issue

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

 

4

addComponent

Components

Add component to a project.

project, component

description, lead, defaultAssignee, replace

 

5

addCustomField

Fields

Add a new custom field. Type must be a valid custom field type key. Optionally, search can be a valid search template key.

field, type

description, search

 

6

addGroup

Groups

Add a new group.

group

preserveCase

 

7

addLabels

Labels

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

issue, labels

suppressNotify

 

8

addProjectRoleActors

Projects

Add users or groups to a project role.

project, role, userId or group

 

 

9

addRemoteLink

Links

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, reversLink, targetServer, targetUser, targetPassword

 

10

addTransitionFunction

Issues

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

 

11

addTransition

Issues

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

 

12

addUserToGroupWithFile

Users

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

file

autoGroup, preserveCase, encoding

 

13

addUserToGroup

Users

Add user to a group.

userId, group

autoGroup, preserveCase

 

14

addUserWithFile

Users

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

file

notify, preserveCase, encoding

 

15

addUser

Users

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

userId, userEmail

userFullName, userPassword, notify, preserveCase

 

16

addVersion

Versions

Add a new version to a project.

project, version

description, after, date, startDate, dateFormat, replace

 

17

addVote

Vote

Add vote for issue.

issue

 

 

18

addWatchers

Watches

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

issue

userId, lookup, continue

 

19

addWork

Work

Add work log entry.

issue, timeSpent

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

 

20

archiveVersion

Versions

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

 

21

assignIssue

Issues

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

 

 

22

associateWorkflow

Workflow

Associate workflow to a workflow scheme.

name, workflowScheme

 

 

23

cloneIssue

Issues

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

 

24

cloneIssues

Issues

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

 

25

cloneProject

Projects

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 search 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

 

26

copyAttachments

Attachments

Copy attachments from an issue to another issue.

issue, toIssue

name, regex

 

27

copyComponent

Components

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

project, component

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

 

28

copyComponents

Components

Copy all or some components from one project to another.

project, toProject

components, replace

 

29

copyFieldValue

Fields

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

 

30

copyProjectRoleActors

Projects

Copy all role actors from a project to another project.

project, toProject

continue

 

31

copyVersion

Versions

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

project, version

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

 

32

copyVersions

Versions

Copy all versions from one project to another project.

project, toProject

continue, replace

 

33

copyWorkflow

Workflow

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

workflow, name

description

 

34

createBoard

Agile Boards

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

 

 

35

createFilter

Filters

Create a filter.

name, search

description, favorite

 

36

createIssue

Issues

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, labels, findReplace, findReplaceRegex, file, encoding

 

37

createOrUpdateIssue

Issues

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

 

38

createOrUpdateIssue

Issues

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

 

39

createProject

Projects

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

 

40

createWorkflowScheme

Workflow

Create a workflow scheme using a default workflow.

name, workflow

description

 

41

deleteBoard

Agile Boards

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

id or board

continue

 

42

deleteComponent

Components

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

project, component

continue

 

43

deleteFilter

Filters

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

 

44

deleteIssueTypeScheme

Issues

Delete an issue type scheme by id.

id

continue

 

45

deleteIssueTypeScreenScheme

Issues

Delete an issue type screen scheme by id.

id

continue

 

46

deleteIssue

Issues

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

issue

continue

 

47

deleteLink

Links

Remove link to another issue.

issue, toIssue, link

 

 

48

deleteProject

Projects

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

project

continue

 

49

deleteScreenScheme

 

Delete a screen scheme by id.

id

continue

 

50

deleteScreen

 

Delete a screen id.

id

continue

 

51

deleteVersion

Versions

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

 

52

deleteWorkflowScheme

Workflow

Delete an inactive workflow scheme.

name

continue

 

53

deleteWorkflow

Workflow

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

name

continue

 

54

exportData

Export

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

project or search

file, exportType, dateFormat, encoding, search, limit

 

55

exportSite

Export

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

 

56

exportWorkflow

Workflow

Export workflow to XML.

name

file, encoding

 

57

getApplicationLinkList

Links

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

 

58

getAttachmentList

Attachments

List attachments for an issue.

issue

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

1 - default
999 - all

59

getAttachment

Attachments

Get lastest attachment by name or id for an issue.

issue, file

name, encoding

 

60

getAvailableSteps

Issues

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

issue

file, append, encoding

 

61

getBoardList

Agile Boards

List Agile boards with optional filtering by regex on name.

 

regex, file, append, columns, encoding

 

62

getClientInfo

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

1 - basic
2 - JVM

63

getCommentList

Comments

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

64

getComment

Comments

Get comment information.

issue, id

dateFormat, file, append, encoding

 

65

getComments

Comments

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

issue

file, dateFormat, encoding

 

66

getComponentList

Components

List components defined for a projects.

project

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

1 - default
2 - with project
999 - all

67

getComponent

Components

Get information for a component of a project.

project, component

file, encoding

 

68

getCustomFieldList

Fields

Get information on all custom fields.

 

file, append, columns, encoding

 

69

getFieldList

Fields

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

 

regex, file, append, columns, encoding

 

70

getFieldValue

Fields

Get field value for an issue.

issue, field

file, dateFormat, reference, withId, suppressId, encoding

 

71

getFilterList

Filters

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

 

72

getFilter

Filters

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

id or filter

 

 

73

getGroupList

Groups

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

 

limit, regex, file, encoding, append

 

74

getIssueHistoryList

Issues

Get issue change history.

issue

file, dateFormat, columns, encoding

 

75

getIssueList

Issues

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

filter or jql or search 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

76

getIssueTypeList

Issues

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

 

project, file, columns, encoding, append

 

77

getIssue

Issues

Get information about an existing issue.

issue

file, dateFormat, suppressId, encoding

1 - default
999 - all

78

getLinkList

Links

List issue links for an issue.

issue

file, columns, encoding, append

 

79

getLinkTypeList

Links

Get a list of all issue link types.

 

file, columns, encoding

 

80

getLoginInfo

Info

Get login information for the current logged in user.

 

 

 

81

getProjectCategoryList

Projects

List defined project categories.

 

file, append, columns, encoding

 

82

getProjectList

Projects

List defined projects with optional filtering by lead and regex on project key.

 

lead, regex, outputFormat, file, columns, encoding

1 - default
2 - schemes
999 - all

83

getProjectRoleActorList

Projects

Get users and groups for a project's role.

project, role

file, columns, encoding

 

84

getProjectRoleByUserList

Users

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! Use userId of @all to product a list for all users. Use a regex pattern to subset projects to be included. 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

regex, file, append, columns, encoding

 

85

getProjectRoleList

Projects

Get project roles.

 

regex, file, append, columns, encoding

 

86

getProject

Projects

Get project information.

project

suppressId, file, encoding

 

87

getRemoteLinkList

Links

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 - base
999 - all

88

getScreenList

Lists

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

89

getSecurityLevelList

Issues

List security levels defined for a projects.

project

file, columns, encoding, append, outputFormat

1 - default
999 - all

90

getServerInfo

Info

Get information about the JIRA server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail

91

getStatusList

Lists

List statuses in their customized order.

 

file, encoding, append

 

92

getTransitionList

Issues

Get available workflow transitions for an issue.

issue

outputFormat, file, append, encoding

1 - basic
2 - fields

93

getUserList

Users

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

94

getUser

Users

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

userId or userKey or name

file, endcoding

 

95

getVersionList

Versions

List versions defined for a projects.

project

regex, file, columns, encoding, append, outputFormat

1 - default
2 - description
999 - all

96

getVersion

Versions

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

project, version

dateFormat, file, encoding

 

97

getVoterList

Vote

Get list of users that have voted for an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple
2 - CSV
999 - all

98

getWatcherList

Watches

Get list of users that are watching an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple
2 - CSV
999 - all

99

getWorkList

Work

Get list of a work log entry.

issue

dateFormat, file, columns, encoding, append, outputFormat

999 - all

100

getWorkflowList

Workflow

Get list of a workflows matching selection criteria.

 

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

 

101

getWorkflowSchemeList

Workflow

Get list of a workflow schemes matching selection criteria.

 

limit, regex, file, append, columns, encoding

 

102

getWorkflowScheme

Workflow

Get workflow scheme information.

name

file, encoding

 

103

getWorkflow

Workflow

Get workflow information.

name

dateFormat, file, encoding

 

104

importWorkflow

Workflow

Import workflow from XML.

name, file

description, findReplace, findReplaceRegex, encoding

 

105

linkIssue

Issues

Link an issue to another issue.

issue, toIssue, link

comment, group, role,

 

106

login

Misc

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

password

user

 

107

logout

Misc

Logout of remote server.

 

 

 

108

modifyFieldValue

Fields

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

issue, field, findReplace or findReplaceRegex

dateFormat, autoVersion, autoComponent, suppressNotify

 

109

progressIssue

Issues

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

 

110

releaseVersion

Versions

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

 

111

removeAttachment

Attachments

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

issue, name or id

 

 

112

removeComment

Comments

Remove a comment by id from an issue.

issue, id

 

 

113

removeCustomField

Fields

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

field

continue

 

114

removeGroup

Groups

Remove a group.

group

defaultGroup

 

115

removeLabels

Labels

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

issue, labels

suppressNotify

 

116

removeProjectRoleActors

Projects

Remove users or groups from a project role.

project, role, userId or group

 

 

117

removeRemoteLink

Links

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

issue, name

 

 

118

removeUserFromGroupWithFile

Users

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

file

encoding

 

119

removeUserFromGroup

Users

Remove user from a group.

userId, group

 

 

120

removeUserProperty

Users

Remove a user's property.

userId, name

lookup

 

121

removeUserWithFile

Users

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

file

encoding

 

122

removeUser

Users

Remove a user.

userId

 

 

123

removeVote

Vote

Remove vote from issue.

issue

 

 

124

removeWatchers

Watches

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

issue

userId, lookup, continue

 

125

removeWork

Work

Remove work log entry.

id

 

 

126

renderRequest

Render

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

 

127

restoreExport

Export

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

file

 

 

128

runFromAttachmentList

Attachments

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

 

129

runFromCommentList

Comments

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

 

130

runFromComponentList

Components

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

 

131

runFromCsv

CSV

Run actions generated from a CSV file.

file

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

 

132

runFromGroupList

Groups

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

 

133

runFromIssueList

Issues

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

filter or jql or search or project

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

 

134

runFromIssueTypeSchemeList

Issues

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

 

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

 

135

runFromIssueTypeScreenSchemeList

Issues

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

 

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

 

136

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

 

137

runFromProjectList

Projects

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

 

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

 

138

runFromRemoteLinkList

Links

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

 

139

runFromScreenList

Run

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

 

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

 

140

runFromScreenSchemeList

Run

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

 

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

 

141

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

 

142

runFromUserList

Users

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

 

143

runFromVersionList

Versions

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

 

144

runFromWorkflowList

Workflow

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

 

145

runFromWorkflowSchemeList

Workflow

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

 

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

 

146

run

Run

Run actions from a file or standard input.

file or standard input

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

 

147

setFieldValue

Fields

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

 

148

setShareScope

Filters

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

value

 

 

149

transitionIssue

Issues

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

 

150

unarchiveVersion

Versions

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

 

151

unreleaseVersion

Versions

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

 

152

updateComment

Comments

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

issue

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

 

153

updateComponent

Components

Update component for a project.

project, component

name, description, lead, defaultAssignee

 

154

updateFilter

Filters

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

id of filter

name, search, description, favorite

 

155

updateIssue

Issues

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

 

156

updateProject

Projects

Update project information. Scheme updates require compatible schemes.

project

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

 

157

updateUserProperty

Users

Add or update a user's property.

userId, name, value

lookup

 

158

updateUser

Users

Update user information or status.

userId or userKey

userFullName, userEmail, newUserId, activate, deactivate

 

159

updateVersion

Versions

Update version for a project.

project, version

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

 

160

updateWork

Work

Update work log entry.

id, issue

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

 

161

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

acceptType

 

(tick)

Content type to accept for renderRequest if different than type.

2

action

a

(tick)

 

3

activate

 

(error)

Activate user.

4

affectsVersions

 

(tick)

Affects versions - comma separated names or ids.

5

after

 

(tick)

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

6

afterSql

 

(tick)

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

7

api

 

(tick)

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

8

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.

9

appendText

 

(error)

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

10

asCascadeSelect

 

(error)

Deprecatated. Ignored on JIRA 7.x.

11

asComponent

 

(error)

Deprecated. Ignored on JIRA 7.x

12

asVersion

 

(error)

Deprecated. Ignored on JIRA 7.x.

13

assignee

 

(tick)

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

14

autoAdjust

 

(error)

Auto adjust remaining estimate when adding work entry.

15

autoComponent

 

(error)

Automatically add components used in components parameter.

16

autoGroup

 

(error)

Groups are automatically added when referenced in add user functions.

17

autoVersion

 

(error)

Automatically add versions used in affectsVersions and fixVersions parameters.

18

board

 

(tick)

Agile board name.

19

category

 

(tick)

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

20

clearFileBeforeAppend

 

(error)

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

21

cloneIssues

 

(error)

Clone issues when cloning a project.

22

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.

23

comment

 

(tick)

Comment text.

24

common

 

(tick)

Common parameter string added to all run actions.

25

component

 

(tick)

Project component name or id.

26

components

 

(tick)

Project components - comma separated names or ids.

27

connectionTimeout

 

(tick)

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

28

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.

29

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.

30

copyAttachments

 

(error)

Copy attachments when cloning an issue.

31

copyComments

 

(error)

Copy comments when cloning an issue.

32

copyComponents

 

(error)

Copy components when cloning a project.

33

copyLinks

 

(error)

Copy issue links when cloning an issue.

34

copyRoleActors

 

(error)

Copy project role actors when cloning a project.

35

copySubtaskEstimates

 

(error)

Copy subtask estimates when cloning an issue.

36

copySubtasks

 

(error)

Copy subtasks when cloning an issue.

37

copyVersions

 

(error)

Copy versions when cloning a project.

38

copyWatchers

 

(error)

Copy Watchers when cloning an issue.

39

custom

 

(tick)

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

 

(tick)

Database name is required for SQL actions.

41

date

 

(tick)

Release date for version or due date for issue.

42

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.

43

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.

44

dbCreateTable

 

(error)

Database table needs to be created before adding rows.

45

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

46

dbPassword

 

(tick)

Database user password. Defaults to password.

47

dbTable

 

(tick)

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

48

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.

49

dbUser

 

(tick)

Database user name. Defaults to user.

50

deactivate

 

(error)

Deactivate user.

51

debug

 

(error)

Requests detail debug output. Optional for all actions.

52

defaultAssignee

 

(tick)

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

 

(tick)

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

54

deleteFilter

 

(error)

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

55

description

 

(tick)

Description.

56

driver

 

(tick)

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

57

encoding

 

(tick)

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

58

environment

 

(tick)

Issue environment.

59

estimate

 

(tick)

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

60

exportAttachments

 

(error)

Export attachments and similar data for site export.

61

exportType

 

(tick)

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

62

favorite

 

(error)

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

63

field

 

(tick)

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

64

field2

 

(tick)

Field name or id for a custom field.

65

fieldConfigurationScheme

 

(tick)

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

66

fieldExcludes

 

(tick)

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

67

file

f

(tick)

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

68

filter

 

(tick)

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

69

findReplace

 

(tick)

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

70

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.

71

fixVersions

 

(tick)

Fix versions - comma separated names or ids.

72

forUser

 

(tick)

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

73

functionKey

 

(tick)

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

74

group

 

(tick)

Group name.

75

help

 

(error)

Prints this help message.

76

helpText

 

(tick)

Service Desk: Help text.

77

host

 

(tick)

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

78

id

 

(tick)

Numeric id of an item.

79

includeInactive

 

(error)

To include inactive users in a user list.

80

issue

 

(tick)

Issue key or id.

81

issueSecurityScheme

 

(tick)

Issue security scheme name or id

82

issueType

 

(tick)

Issue type - name or id.

83

issueTypeScheme

 

(tick)

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

84

issueTypeScreenScheme

 

(tick)

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

85

jql

 

(tick)

JQL query. Alternate way to search for issues for getIssueList and runFromIssueList - continue to use search parameter for compatibility with previous.

86

labels

 

(tick)

Labels or tags. A blank separated list.

87

lead

 

(tick)

Project lead user id.

88

legacy

 

(error)

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

 

(tick)

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

90

link

 

(tick)

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

 

(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.

92

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.

93

login

 

(tick)

Login token from previous login request.

94

loginFromStandardInput

l

(error)

Get login token from standard input.

95

lookup

 

(error)

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

96

name

 

(tick)

Name.

97

newUserId

 

(tick)

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

98

notificationScheme

 

(tick)

Notification scheme name or id.

99

notify

 

(error)

Notify user after user is added.

100

organization

 

(tick)

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

101

originalEstimate

 

(tick)

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

102

outputFormat

 

(tick)

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

103

parent

 

(tick)

Parent issue key or id.

104

participants

 

(tick)

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

105

password

p

(tick)

User password for remote access.

106

permissionScheme

 

(tick)

Permission scheme name or id. (default: Default Permission Scheme)

107

port

 

(tick)

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

108

preserveCase

 

(error)

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.

109

priority

 

(tick)

Issue priority - name or id.

110

project

 

(tick)

Project name, key, or id.

111

propertyFile

 

(tick)

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

112

propertyPrefix

 

(tick)

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

113

quiet

 

(error)

Limit some output messages. Optional for all actions.

114

recursive

 

(error)

Include subdirectories.

115

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.

116

regex

 

(tick)

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

117

regex2

 

(tick)

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

118

replace

 

(error)

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

119

reporter

 

(tick)

Issue reporter user id.

120

request

 

(tick)

URL fragment for a request.

121

requestParameters

 

(tick)

URL request parameters or post data..

122

requestType

 

(tick)

Type of a render request like GET or POST (default: GET)

123

resolution

 

(tick)

Resolution name or id.

124

reverseLink

 

(tick)

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

125

role

 

(tick)

User role in project

126

screen

 

(tick)

Transition screen name.

127

search

 

(tick)

Search JQL query using legacy support. Deprecated. Use jql parameter instead for new support.

128

security

 

(tick)

Issue security level name or id.

129

server

s

(tick)

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

130

service

 

(tick)

Service address extension. (default: )

131

simulate

 

(error)

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

132

special

 

(tick)

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

133

sql

 

(tick)

SQL select statement used to generate a run script.

134

startDate

 

(tick)

Date version was started.

135

step

 

(tick)

Source step name for addTransition.

136

subtract

 

(error)

Subtract values from existing values custom fields supporting multiple values.

137

summary

 

(tick)

Summary of issue.

138

suppressId

 

(error)

Suppress showing an id when displaying issue fields on getIssue.

139

suppressNotify

 

(error)

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

140

targetPassword

 

(tick)

Target server user password. Defaults to password parameter.

141

targetServer

 

(tick)

Target server URL for copy requests.

142

targetUser

 

(tick)

Target server user. Defaults to user parameter.

143

template

 

(tick)

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.

144

timeSpent

 

(tick)

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

145

toComponent

 

(tick)

Project component name or id.

146

toIssue

 

(tick)

Target or link destination issue key or id.

147

toProject

 

(tick)

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

148

transition

 

(tick)

Workflow transition - name or id.

149

type

 

(tick)

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.

150

url

 

(tick)

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

151

useParentVersions

 

(error)

Copy parent versions to subtask when cloning an issue.

152

user

u

(tick)

User name for remote access. (default: automation)

153

userEmail

 

(tick)

User email for user management actions.

154

userFullName

 

(tick)

User name for user management actions.

155

userId

 

(tick)

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

156

userKey

 

(tick)

Unique internal identifier for user management.

157

userPassword

 

(tick)

User password for user management actions.

158

value

 

(tick)

Single field or property value.

159

values

 

(tick)

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

160

values2

 

(tick)

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

161

verbose

v

(error)

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

162

version

 

(tick)

Project version name or id or add-on version.

163

withId

 

(error)

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

164

workflow

 

(tick)

Workflow name.

165

workflowScheme

 

(tick)

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

  • No labels