Availability

Child pages
  • Reference - 6.4.0-SNAPSHOT

Versions Compared

Key

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

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Related information for 6.4.0-SNAPSHOT

Actions

Div

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

addAttachment

Anchor
addAttachment
addAttachment

Attachments

Add an attachment to an issue.

issue, file

findReplace, findReplaceRegex, name, encoding

 

2

addAttachments

Anchor
addAttachments
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

Anchor
addComment
addComment

Comments

Add a comment to an issue.

issue

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

 

4

addComponent

Anchor
addComponent
addComponent

Components

Add component to a project.

project, component

description, lead, defaultAssignee, replace

 

5

addCustomField

Anchor
addCustomField
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

Anchor
addGroup
addGroup

Groups

Add a new group.

group

preserveCase

 

7

addLabels

Anchor
addLabels
addLabels

Labels

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

issue, labels

suppressNotify

 

8

addProjectRoleActors

Anchor
addProjectRoleActors
addProjectRoleActors

Projects

Add users or groups to a project role.

project, role, userId or group

 

 

9

addRemoteLink

Anchor
addRemoteLink
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

Anchor
addTransitionFunction
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

Anchor
addTransition
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

Anchor
addUserToGroupWithFile
addUserToGroupWithFile

Users

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

file

autoGroup, preserveCase, encoding

 

13

addUserToGroup

Anchor
addUserToGroup
addUserToGroup

Users

Add user to a group.

userId, group

autoGroup, preserveCase

 

14

addUserWithFile

Anchor
addUserWithFile
addUserWithFile

Users

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

file

notify, preserveCase, encoding

 

15

addUser

Anchor
addUser
addUser

Users

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

userId, userEmail

userFullName, userPassword, notify, preserveCase

 

16

addVersion

Anchor
addVersion
addVersion

Versions

Add a new version to a project.

project, version

description, after, date, startDate, dateFormat, replace

 

17

addVote

Anchor
addVote
addVote

Vote

Add vote for issue.

issue

 

 

18

addWatchers

Anchor
addWatchers
addWatchers

Watches

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

issue

userId, lookup, continue

 

19

addWork

Anchor
addWork
addWork

Work

Add work log entry.

issue, timeSpent

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

 

20

archiveVersion

Anchor
archiveVersion
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

Anchor
assignIssue
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

Anchor
associateWorkflow
associateWorkflow

Workflow

Associate workflow to a workflow scheme.

name, workflowScheme

 

 

23

cloneIssue

Anchor
cloneIssue
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

Anchor
cloneIssues
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

Anchor
cloneProject
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

Anchor
copyAttachments
copyAttachments

Attachments

Copy attachments from an issue to another issue.

issue, toIssue

name, regex

 

27

copyComponent

Anchor
copyComponent
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

Anchor
copyComponents
copyComponents

Components

Copy all or some components from one project to another.

project, toProject

components, replace

 

29

copyFieldValue

Anchor
copyFieldValue
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

Anchor
copyProjectRoleActors
copyProjectRoleActors

Projects

Copy all role actors from a project to another project.

project, toProject

continue

 

31

copyVersion

Anchor
copyVersion
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

Anchor
copyVersions
copyVersions

Versions

Copy all versions from one project to another project.

project, toProject

continue, replace

 

33

copyWorkflow

Anchor
copyWorkflow
copyWorkflow

Workflow

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

workflow, name

description

 

34

createBoard

Anchor
createBoard
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

Anchor
createFilter
createFilter

Filters

Create a filter.

name, search

description, favorite

 

36

createIssue

Anchor
createIssue
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, labelsfindReplace, findReplaceRegex, file, encoding

 

37

createOrUpdateIssue

Anchor
createOrUpdateIssue
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

Anchor
createOrUpdateIssue
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

Anchor
createProject
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

Anchor
createWorkflowScheme
createWorkflowScheme

Workflow

Create a workflow scheme using a default workflow.

name, workflow

description

 

41

deleteBoard

Anchor
deleteBoard
deleteBoard

Agile Boards

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

id or board

continue

 

42

deleteComponent

Anchor
deleteComponent
deleteComponent

Components

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

project, component

continue

 

43

deleteFieldConfigurationScheme

Anchor
deleteFieldConfigurationScheme
deleteFieldConfigurationScheme

Fields

Delete a field configuration scheme by id.

id

continue

 

44

deleteFieldConfiguration

Anchor
deleteFieldConfiguration
deleteFieldConfiguration

Fields

Delete a field configuration by id.

id

continue

 

45

deleteFilter

Anchor
deleteFilter
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

 

46

deleteIssueSecurityScheme

Anchor
deleteIssueSecurityScheme
deleteIssueSecurityScheme

Issues

Delete an issue security scheme by id.

id

continue

 

47

deleteIssueTypeScheme

Anchor
deleteIssueTypeScheme
deleteIssueTypeScheme

Issues

Delete an issue type scheme by id.

id

continue

 

48

deleteIssueTypeScreenScheme

Anchor
deleteIssueTypeScreenScheme
deleteIssueTypeScreenScheme

Issues

Delete an issue type screen scheme by id.

id

continue

 

49

deleteIssue

Anchor
deleteIssue
deleteIssue

Issues

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

issue

continue

 

50

deleteLink

Anchor
deleteLink
deleteLink

Links

Remove link to another issue.

issue, toIssue, link

 

 

51

deleteNotificationScheme

Anchor
deleteNotificationScheme
deleteNotificationScheme

Notifications

Delete a permission scheme by id.

id

continue

 

52

deletePermissionScheme

Anchor
deletePermissionScheme
deletePermissionScheme

Permissions

Delete a permission scheme by id.

id

continue

 

53

deleteProject

Anchor
deleteProject
deleteProject

Projects

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

project

continue

 

54

deleteScreenScheme

Anchor
deleteScreenScheme
deleteScreenScheme

 

Delete a screen scheme by id.

id

continue

 

55

deleteScreen

Anchor
deleteScreen
deleteScreen

 

Delete a screen by id.

id

continue

 

56

deleteVersion

Anchor
deleteVersion
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

 

57

deleteWorkflowScheme

Anchor
deleteWorkflowScheme
deleteWorkflowScheme

Workflow

Delete an inactive workflow scheme.

id or name

continue

 

58

deleteWorkflow

Anchor
deleteWorkflow
deleteWorkflow

Workflow

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

workflow

continue

 

59

exportData

Anchor
exportData
exportData

Export

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

project or search

file, exportType, dateFormat, encoding, search, limit

 

60

exportSite

Anchor
exportSite
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

 

61

exportWorkflow

Anchor
exportWorkflow
exportWorkflow

Workflow

Export workflow to XML.

workflow

file, encoding

 

62

getApplicationLinkList

Anchor
getApplicationLinkList
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

 

63

getAttachmentList

Anchor
getAttachmentList
getAttachmentList

Attachments

List attachments for an issue.

issue

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

1 - default
999 - all

64

getAttachment

Anchor
getAttachment
getAttachment

Attachments

Get lastest attachment by name or id for an issue.

issue, file

name, encoding

 

65

getAvailableSteps

Anchor
getAvailableSteps
getAvailableSteps

Issues

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

issue

file, append, encoding

 

66

getBoardList

Anchor
getBoardList
getBoardList

Agile Boards

List Agile boards with optional filtering by regex on name.

 

regex, file, append, columns, encoding

 

67

getClientInfo

Anchor
getClientInfo
getClientInfo

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

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

68

getCommentList

Anchor
getCommentList
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

69

getComment

Anchor
getComment
getComment

Comments

Get comment information.

issue, id

dateFormat, file, append, encoding

 

70

getComments

Anchor
getComments
getComments

Comments

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

issue

file, dateFormat, encoding

 

71

getComponentList

Anchor
getComponentList
getComponentList

Components

List components defined for a projects.

project

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

1 - default
2 - with project
999 - all

72

getComponent

Anchor
getComponent
getComponent

Components

Get information for a component of a project.

project, component

file, encoding

 

73

getCustomFieldList

Anchor
getCustomFieldList
getCustomFieldList

Fields

Get information on all custom fields.

 

file, append, columns, encoding

 

74

getFieldConfigurationList

Anchor
getFieldConfigurationList
getFieldConfigurationList

Fields

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

75

getFieldConfigurationSchemeList

Anchor
getFieldConfigurationSchemeList
getFieldConfigurationSchemeList

Fields

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

76

getFieldList

Anchor
getFieldList
getFieldList

Fields

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

 

regex, file, append, columns, encoding

 

77

getFieldValue

Anchor
getFieldValue
getFieldValue

Fields

Get field value for an issue.

issue, field

file, dateFormat, reference, withId, suppressId, encoding

 

78

getFilterList

Anchor
getFilterList
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

 

79

getFilter

Anchor
getFilter
getFilter

Filters

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

id or filter

 

 

80

getGroupList

Anchor
getGroupList
getGroupList

Groups

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

 

limit, regex, file, encoding, append

 

81

getIssueHistoryList

Anchor
getIssueHistoryList
getIssueHistoryList

Issues

Get issue change history.

issue

file, dateFormat, columns, encoding

 

82

getIssueList

Anchor
getIssueList
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

83

getIssueSecuritySchemeList

Anchor
getIssueSecuritySchemeList
getIssueSecuritySchemeList

Issues

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

84

getIssueTypeList

Anchor
getIssueTypeList
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

 

85

getIssueTypeSchemeList

Anchor
getIssueTypeSchemeList
getIssueTypeSchemeList

Issues

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

86

getIssueTypeScreenSchemeList

Anchor
getIssueTypeScreenSchemeList
getIssueTypeScreenSchemeList

Issues

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

87

getIssue

Anchor
getIssue
getIssue

Issues

Get information about an existing issue.

issue

file, dateFormat, suppressId, encoding

1 - default
999 - all

88

getLinkList

Anchor
getLinkList
getLinkList

Links

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

 

89

getLinkTypeList

Anchor
getLinkTypeList
getLinkTypeList

Links

Get a list of all issue link types.

 

file, columns, encoding

 

90

getLoginInfo

Anchor
getLoginInfo
getLoginInfo

Info

Get login information for the current logged in user.

 

 

 

91

getNotificationSchemeList

Anchor
getNotificationSchemeList
getNotificationSchemeList

Notifications

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

92

getPermissionSchemeList

Anchor
getPermissionSchemeList
getPermissionSchemeList

Permissions

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

93

getProjectCategoryList

Anchor
getProjectCategoryList
getProjectCategoryList

Projects

List defined project categories.

 

file, append, columns, encoding

 

94

getProjectList

Anchor
getProjectList
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

95

getProjectRoleActorList

Anchor
getProjectRoleActorList
getProjectRoleActorList

Projects

Get users and groups for a project's role.

project, role

file, columns, encoding

 

96

getProjectRoleByUserList

Anchor
getProjectRoleByUserList
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

 

97

getProjectRoleList

Anchor
getProjectRoleList
getProjectRoleList

Projects

Get project roles.

 

regex, file, append, columns, encoding

 

98

getProject

Anchor
getProject
getProject

Projects

Get project information.

project

suppressId, file, encoding

 

99

getRemoteLinkList

Anchor
getRemoteLinkList
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 - basic
999 - all

100

getScreenList

Anchor
getScreenList
getScreenList

Lists

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

101

getScreenSchemeList

Anchor
getScreenSchemeList
getScreenSchemeList

Lists

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

 

regex, limit, file, encoding, append, clearFileBeforeAppend

 

102

getSecurityLevelList

Anchor
getSecurityLevelList
getSecurityLevelList

Issues

List security levels defined for a projects.

project

file, columns, encoding, append, outputFormat

1 - default
999 - all

103

getServerInfo

Anchor
getServerInfo
getServerInfo

Info

Get information about the JIRA server.

 

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail

104

getStatusList

Anchor
getStatusList
getStatusList

Lists

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

 

project, file, encoding, append

 

105

getTransitionList

Anchor
getTransitionList
getTransitionList

Issues

Get available workflow transitions for an issue.

issue

outputFormat, file, append, encoding

1 - basic
2 - fields

106

getUserList

Anchor
getUserList
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

107

getUser

Anchor
getUser
getUser

Users

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

userId or userKey or name

file, endcoding

 

108

getVersionList

Anchor
getVersionList
getVersionList

Versions

List versions defined for a projects.

project

regex, file, columns, encoding, append, outputFormat

1 - default
2 - description
999 - all

109

getVersion

Anchor
getVersion
getVersion

Versions

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

project, version

dateFormat, file, encoding

 

110

getVoterList

Anchor
getVoterList
getVoterList

Vote

Get list of users that have voted for an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple
2 - CSV
999 - all

111

getWatcherList

Anchor
getWatcherList
getWatcherList

Watches

Get list of users that are watching an issue.

issue

outputFormat, append, file, columns, encoding

1 - simple
2 - CSV
999 - all

112

getWorkList

Anchor
getWorkList
getWorkList

Work

Get list of a work log entry.

issue

dateFormat, file, columns, encoding, append, outputFormat

999 - all

113

getWorkflowList

Anchor
getWorkflowList
getWorkflowList

Workflow

Get list of a workflows matching selection criteria.

 

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

 

114

getWorkflowSchemeList

Anchor
getWorkflowSchemeList
getWorkflowSchemeList

Workflow

Get list of a workflow schemes matching selection criteria.

 

limit, regex, file, append, columns, encoding

1 - basic
2 - detail

115

getWorkflowScheme

Anchor
getWorkflowScheme
getWorkflowScheme

Workflow

Get workflow scheme information.

name

file, encoding

 

116

getWorkflow

Anchor
getWorkflow
getWorkflow

Workflow

Get workflow information.

workflow

dateFormat, file, encoding

 

117

importWorkflow

Anchor
importWorkflow
importWorkflow

Workflow

Import workflow from XML.

workflow, file

description, findReplace, findReplaceRegex, encoding

 

118

linkIssue

Anchor
linkIssue
linkIssue

Issues

Link an issue to another issue.

issue, toIssue, link

comment, group, role,

 

119

login

Anchor
login
login

Misc

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

password

user

 

120

logout

Anchor
logout
logout

Misc

Logout of remote server.

 

 

 

121

modifyFieldValue

Anchor
modifyFieldValue
modifyFieldValue

Fields

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

issue, field, findReplace or findReplaceRegex

dateFormat, autoVersion, autoComponent, suppressNotify

 

122

progressIssue

Anchor
progressIssue
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

 

123

releaseVersion

Anchor
releaseVersion
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

 

124

removeAttachment

Anchor
removeAttachment
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

 

 

125

removeComment

Anchor
removeComment
removeComment

Comments

Remove a comment by id from an issue.

issue, id

 

 

126

removeCustomField

Anchor
removeCustomField
removeCustomField

Fields

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

field

continue

 

127

removeGroup

Anchor
removeGroup
removeGroup

Groups

Remove a group.

group

defaultGroup

 

128

removeLabels

Anchor
removeLabels
removeLabels

Labels

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

issue, labels

suppressNotify

 

129

removeProjectRoleActors

Anchor
removeProjectRoleActors
removeProjectRoleActors

Projects

Remove users or groups from a project role.

project, role, userId or group

 

 

130

removeRemoteLink

Anchor
removeRemoteLink
removeRemoteLink

Links

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

issue, name

 

 

131

removeUserFromGroupWithFile

Anchor
removeUserFromGroupWithFile
removeUserFromGroupWithFile

Users

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

file

encoding

 

132

removeUserFromGroup

Anchor
removeUserFromGroup
removeUserFromGroup

Users

Remove user from a group.

userId, group

 

 

133

removeUserProperty

Anchor
removeUserProperty
removeUserProperty

Users

Remove a user's property.

userId, name

lookup

 

134

removeUserWithFile

Anchor
removeUserWithFile
removeUserWithFile

Users

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

file

encoding

 

135

removeUser

Anchor
removeUser
removeUser

Users

Remove a user.

userId

 

 

136

removeVote

Anchor
removeVote
removeVote

Vote

Remove vote from issue.

issue

 

 

137

removeWatchers

Anchor
removeWatchers
removeWatchers

Watches

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

issue

userId, lookup, continue

 

138

removeWork

Anchor
removeWork
removeWork

Work

Remove work log entry.

id

 

 

139

renderRequest

Anchor
renderRequest
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

 

140

restoreExport

Anchor
restoreExport
restoreExport

Export

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

file

 

 

141

runFromAttachmentList

Anchor
runFromAttachmentList
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

 

142

runFromCommentList

Anchor
runFromCommentList
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

 

143

runFromComponentList

Anchor
runFromComponentList
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

 

144

runFromCsv

Anchor
runFromCsv
runFromCsv

CSV

Run actions generated from a CSV file.

file

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

 

145

runFromFieldConfigurationList

Anchor
runFromFieldConfigurationList
runFromFieldConfigurationList

Fields

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

 

146

runFromFieldConfigurationSchemeList

Anchor
runFromFieldConfigurationSchemeList
runFromFieldConfigurationSchemeList

Fields

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

 

147

runFromGroupList

Anchor
runFromGroupList
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

 

148

runFromIssueList

Anchor
runFromIssueList
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

 

149

runFromIssueSecuritySchemeList

Anchor
runFromIssueSecuritySchemeList
runFromIssueSecuritySchemeList

Issues

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

 

150

runFromIssueTypeSchemeList

Anchor
runFromIssueTypeSchemeList
runFromIssueTypeSchemeList

Issues

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

 

151

runFromIssueTypeScreenSchemeList

Anchor
runFromIssueTypeScreenSchemeList
runFromIssueTypeScreenSchemeList

Issues

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

 

152

runFromLinkList

Anchor
runFromLinkList
runFromLinkList

Links

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

 

153

runFromList

Anchor
runFromList
runFromList

Run

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

list

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

 

154

runFromNotificationSchemeList

Anchor
runFromNotificationSchemeList
runFromNotificationSchemeList

Notifications

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

 

155

runFromPermissionSchemeList

Anchor
runFromPermissionSchemeList
runFromPermissionSchemeList

Permissions

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

 

156

runFromProjectList

Anchor
runFromProjectList
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

 

157

runFromRemoteLinkList

Anchor
runFromRemoteLinkList
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

 

158

runFromScreenList

Anchor
runFromScreenList
runFromScreenList

Run

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

 

159

runFromScreenSchemeList

Anchor
runFromScreenSchemeList
runFromScreenSchemeList

Run

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

 

160

runFromSql

Anchor
runFromSql
runFromSql

Run

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

sql or file or standard input

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

 

161

runFromUserList

Anchor
runFromUserList
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

 

162

runFromVersionList

Anchor
runFromVersionList
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

 

163

runFromWorkflowList

Anchor
runFromWorkflowList
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

 

164

runFromWorkflowSchemeList

Anchor
runFromWorkflowSchemeList
runFromWorkflowSchemeList

Workflow

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

 

165

run

Anchor
run
run

Run

Run actions from a file or standard input.

file or standard input

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

 

166

setFieldValue

Anchor
setFieldValue
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

 

167

setShareScope

Anchor
setShareScope
setShareScope

Filters

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

value

 

 

168

transitionIssue

Anchor
transitionIssue
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

 

169

unarchiveVersion

Anchor
unarchiveVersion
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

 

170

unreleaseVersion

Anchor
unreleaseVersion
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

 

171

updateComment

Anchor
updateComment
updateComment

Comments

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

 

172

updateComponent

Anchor
updateComponent
updateComponent

Components

Update component for a project.

project, component

name, description, lead, defaultAssignee

 

173

updateFilter

Anchor
updateFilter
updateFilter

Filters

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

id of filter

name, search, description, favorite

 

174

updateIssue

Anchor
updateIssue
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

 

175

updateProject

Anchor
updateProject
updateProject

Projects

Update project information. Scheme updates require compatible schemes.

project

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

 

176

updateUserProperty

Anchor
updateUserProperty
updateUserProperty

Users

Add or update a user's property.

userId, name, value

lookup

 

177

updateUser

Anchor
updateUser
updateUser

Users

Update user information or status.

userId or userKey

userFullName, userEmail, newUserId, activate, deactivate

 

178

updateVersion

Anchor
updateVersion
updateVersion

Versions

Update version for a project.

project, version

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

 

179

updateWork

Anchor
updateWork
updateWork

Work

Update work log entry.

id, issue

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

 

180

validateLicense

Anchor
validateLicense
validateLicense

Misc

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

 

 

 

Parameter Tips

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

Parameters

Div

Parameter

Short

Value

Description

1

acceptType

Anchor
acceptType
acceptType

 

(tick)

Content type to accept for renderRequest if different than type.

2

action

Anchor
action
action

a

(tick)

 

3

activate

Anchor
activate
activate

 

(error)

Activate user.

4

affectsVersions

Anchor
affectsVersions
affectsVersions

 

(tick)

Affects versions - comma separated names or ids.

5

after

Anchor
after
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

Anchor
afterSql
afterSql

 

(tick)

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

7

api

Anchor
api
api

 

(tick)

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

8

append

Anchor
append
append

 

(error)

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

9

appendText

Anchor
appendText
appendText

 

(error)

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

10

asCascadeSelect

Anchor
asCascadeSelect
asCascadeSelect

 

(error)

Deprecatated. Ignored on JIRA 7.x.

11

asComponent

Anchor
asComponent
asComponent

 

(error)

Deprecated. Ignored on JIRA 7.x

12

asVersion

Anchor
asVersion
asVersion

 

(error)

Deprecated. Ignored on JIRA 7.x.

13

assignee

Anchor
assignee
assignee

 

(tick)

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

14

autoAdjust

Anchor
autoAdjust
autoAdjust

 

(error)

Auto adjust remaining estimate when adding work entry.

15

autoComponent

Anchor
autoComponent
autoComponent

 

(error)

Automatically add components used in components parameter.

16

autoGroup

Anchor
autoGroup
autoGroup

 

(error)

Groups are automatically added when referenced in add user functions.

17

autoVersion

Anchor
autoVersion
autoVersion

 

(error)

Automatically add versions used in affectsVersions and fixVersions parameters.

18

board

Anchor
board
board

 

(tick)

Agile board name.

19

category

Anchor
category
category

 

(tick)

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

20

clearFileBeforeAppend

Anchor
clearFileBeforeAppend
clearFileBeforeAppend

 

(error)

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

21

cloneIssues

Anchor
cloneIssues
cloneIssues

 

(error)

Clone issues when cloning a project.

22

columns

Anchor
columns
columns

 

(tick)

Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.

23

comment

Anchor
comment
comment

 

(tick)

Comment text.

24

common

Anchor
common
common

 

(tick)

Common parameter string added to all run actions.

25

component

Anchor
component
component

 

(tick)

Project component name or id.

26

components

Anchor
components
components

 

(tick)

Project components - comma separated names or ids.

27

connectionTimeout

Anchor
connectionTimeout
connectionTimeout

 

(tick)

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

28

continue

Anchor
continue
continue

 

(error)

Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions.

29

cookies

Anchor
cookies
cookies

 

(tick)

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

30

copyAttachments

Anchor
copyAttachments
copyAttachments

 

(error)

Copy attachments when cloning an issue.

31

copyComments

Anchor
copyComments
copyComments

 

(error)

Copy comments when cloning an issue.

32

copyComponents

Anchor
copyComponents
copyComponents

 

(error)

Copy components when cloning a project.

33

copyLinks

Anchor
copyLinks
copyLinks

 

(error)

Copy issue links when cloning an issue.

34

copyRoleActors

Anchor
copyRoleActors
copyRoleActors

 

(error)

Copy project role actors when cloning a project.

35

copySubtaskEstimates

Anchor
copySubtaskEstimates
copySubtaskEstimates

 

(error)

Copy subtask estimates when cloning an issue.

36

copySubtasks

Anchor
copySubtasks
copySubtasks

 

(error)

Copy subtasks when cloning an issue.

37

copyVersions

Anchor
copyVersions
copyVersions

 

(error)

Copy versions when cloning a project.

38

copyWatchers

Anchor
copyWatchers
copyWatchers

 

(error)

Copy Watchers when cloning an issue.

39

custom

Anchor
custom
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

Anchor
database
database

 

(tick)

Database name is required for SQL actions.

41

date

Anchor
date
date

 

(tick)

Release date for version or due date for issue.

42

dateFormat

Anchor
dateFormat
dateFormat

 

(tick)

Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format.

43

dateFormat2

Anchor
dateFormat2
dateFormat2

 

(tick)

Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

44

dbCreateTable

Anchor
dbCreateTable
dbCreateTable

 

(error)

Database table needs to be created before adding rows.

45

dbJar

Anchor
dbJar
dbJar

 

(tick)

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

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

46

dbPassword

Anchor
dbPassword
dbPassword

 

(tick)

Database user password. Defaults to password.

47

dbTable

Anchor
dbTable
dbTable

 

(tick)

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

48

dbTableKeys

Anchor
dbTableKeys
dbTableKeys

 

(tick)

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

49

dbUser

Anchor
dbUser
dbUser

 

(tick)

Database user name. Defaults to user.

50

deactivate

Anchor
deactivate
deactivate

 

(error)

Deactivate user.

51

debug

Anchor
debug
debug

 

(error)

Requests detail debug output. Optional for all actions.

52

defaultAssignee

Anchor
defaultAssignee
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

Anchor
defaultGroup
defaultGroup

 

(tick)

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

54

deleteFilter

Anchor
deleteFilter
deleteFilter

 

(error)

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

55

description

Anchor
description
description

 

(tick)

Description.

56

driver

Anchor
driver
driver

 

(tick)

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

57

encoding

Anchor
encoding
encoding

 

(tick)

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

58

environment

Anchor
environment
environment

 

(tick)

Issue environment.

59

estimate

Anchor
estimate
estimate

 

(tick)

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

60

exportAttachments

Anchor
exportAttachments
exportAttachments

 

(error)

Export attachments and similar data for site export.

61

exportType

Anchor
exportType
exportType

 

(tick)

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

62

favorite

Anchor
favorite
favorite

 

(error)

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

63

field

Anchor
field
field

 

(tick)

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

64

field2

Anchor
field2
field2

 

(tick)

Field name or id for a custom field.

65

fieldConfigurationScheme

Anchor
fieldConfigurationScheme
fieldConfigurationScheme

 

(tick)

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

66

fieldExcludes

Anchor
fieldExcludes
fieldExcludes

 

(tick)

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

67

file

Anchor
file
file

f

(tick)

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

68

filter

Anchor
filter
filter

 

(tick)

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

69

findReplace

Anchor
findReplace
findReplace

 

(tick)

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

70

findReplaceRegex

Anchor
findReplaceRegex
findReplaceRegex

 

(tick)

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

71

fixVersions

Anchor
fixVersions
fixVersions

 

(tick)

Fix versions - comma separated names or ids.

72

forUser

Anchor
forUser
forUser

 

(tick)

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

73

functionKey

Anchor
functionKey
functionKey

 

(tick)

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

74

group

Anchor
group
group

 

(tick)

Group name.

75

help

Anchor
help
help

 

(error)

Prints this help message.

76

helpText

Anchor
helpText
helpText

 

(tick)

Service Desk: Help text.

77

host

Anchor
host
host

 

(tick)

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

78

id

Anchor
id
id

 

(tick)

Numeric id of an item.

79

includeInactive

Anchor
includeInactive
includeInactive

 

(error)

To include inactive users in a user list.

80

issue

Anchor
issue
issue

 

(tick)

Issue key or id.

81

issueSecurityScheme

Anchor
issueSecurityScheme
issueSecurityScheme

 

(tick)

Issue security scheme name or id

82

issueType

Anchor
issueType
issueType

 

(tick)

Issue type - name or id.

83

issueTypeScheme

Anchor
issueTypeScheme
issueTypeScheme

 

(tick)

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

84

issueTypeScreenScheme

Anchor
issueTypeScreenScheme
issueTypeScreenScheme

 

(tick)

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

85

jql

Anchor
jql
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

Anchor
labels
labels

 

(tick)

Labels or tags. A blank separated list.

87

lead

Anchor
lead
lead

 

(tick)

Project lead user id.

88

legacy

Anchor
legacy
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

Anchor
limit
limit

 

(tick)

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

90

link

Anchor
link
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

Anchor
list
list

 

(tick)

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

92

list2

Anchor
list2
list2

 

(tick)

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

93

login

Anchor
login
login

 

(tick)

Login token from previous login request.

94

loginFromStandardInput

Anchor
loginFromStandardInput
loginFromStandardInput

l

(error)

Get login token from standard input.

95

lookup

Anchor
lookup
lookup

 

(error)

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

96

name

Anchor
name
name

 

(tick)

Name.

97

newUserId

Anchor
newUserId
newUserId

 

(tick)

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

98

notificationScheme

Anchor
notificationScheme
notificationScheme

 

(tick)

Notification scheme name or id.

99

notify

Anchor
notify
notify

 

(error)

Notify user after user is added.

100

options

Anchor
options
options

 

(tick)

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

101

organization

Anchor
organization
organization

 

(tick)

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

102

originalEstimate

Anchor
originalEstimate
originalEstimate

 

(tick)

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

103

outputFormat

Anchor
outputFormat
outputFormat

 

(tick)

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

104

parent

Anchor
parent
parent

 

(tick)

Parent issue key or id.

105

participants

Anchor
participants
participants

 

(tick)

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

106

password

Anchor
password
password

p

(tick)

User password for remote access.

107

permissionScheme

Anchor
permissionScheme
permissionScheme

 

(tick)

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

108

port

Anchor
port
port

 

(tick)

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

109

preserveCase

Anchor
preserveCase
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.

110

priority

Anchor
priority
priority

 

(tick)

Issue priority - name or id.

111

project

Anchor
project
project

 

(tick)

Project name, key, or id.

112

propertyFile

Anchor
propertyFile
propertyFile

 

(tick)

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

113

propertyPrefix

Anchor
propertyPrefix
propertyPrefix

 

(tick)

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

114

quiet

Anchor
quiet
quiet

 

(error)

Limit some output messages. Optional for all actions.

115

recursive

Anchor
recursive
recursive

 

(error)

Include subdirectories.

116

reference

Anchor
reference
reference

 

(tick)

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

117

regex

Anchor
regex
regex

 

(tick)

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

118

regex2

Anchor
regex2
regex2

 

(tick)

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

119

replace

Anchor
replace
replace

 

(error)

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

120

reporter

Anchor
reporter
reporter

 

(tick)

Issue reporter user id.

121

request

Anchor
request
request

 

(tick)

URL fragment for a request.

122

requestParameters

Anchor
requestParameters
requestParameters

 

(tick)

URL request parameters or post data..

123

requestType

Anchor
requestType
requestType

 

(tick)

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

124

resolution

Anchor
resolution
resolution

 

(tick)

Resolution name or id.

125

reverseLink

Anchor
reverseLink
reverseLink

 

(tick)

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

126

role

Anchor
role
role

 

(tick)

User role in project

127

screen

Anchor
screen
screen

 

(tick)

Transition screen name.

128

search

Anchor
search
search

 

(tick)

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

129

security

Anchor
security
security

 

(tick)

Issue security level name or id.

130

server

Anchor
server
server

s

(tick)

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

131

service

Anchor
service
service

 

(tick)

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

132

simulate

Anchor
simulate
simulate

 

(error)

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

133

special

Anchor
special
special

 

(tick)

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

134

sql

Anchor
sql
sql

 

(tick)

SQL select statement used to generate a run script.

135

startDate

Anchor
startDate
startDate

 

(tick)

Date version was started.

136

step

Anchor
step
step

 

(tick)

Source step name for addTransition.

137

subtract

Anchor
subtract
subtract

 

(error)

Subtract values from existing values custom fields supporting multiple values.

138

summary

Anchor
summary
summary

 

(tick)

Summary of issue.

139

suppressId

Anchor
suppressId
suppressId

 

(error)

Suppress showing an id when displaying issue fields on getIssue.

140

suppressNotify

Anchor
suppressNotify
suppressNotify

 

(error)

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

141

targetPassword

Anchor
targetPassword
targetPassword

 

(tick)

Target server user password. Defaults to password parameter.

142

targetServer

Anchor
targetServer
targetServer

 

(tick)

Target server URL for copy requests.

143

targetUser

Anchor
targetUser
targetUser

 

(tick)

Target server user. Defaults to user parameter.

144

template

Anchor
template
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.

145

timeSpent

Anchor
timeSpent
timeSpent

 

(tick)

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

146

toComponent

Anchor
toComponent
toComponent

 

(tick)

Project component name or id.

147

toIssue

Anchor
toIssue
toIssue

 

(tick)

Target or link destination issue key or id.

148

toProject

Anchor
toProject
toProject

 

(tick)

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

149

transition

Anchor
transition
transition

 

(tick)

Workflow transition - name or id.

150

type

Anchor
type
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.

151

url

Anchor
url
url

 

(tick)

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

152

useParentVersions

Anchor
useParentVersions
useParentVersions

 

(error)

Copy parent versions to subtask when cloning an issue.

153

user

Anchor
user
user

u

(tick)

User name for remote access. (default: automation)

154

userEmail

Anchor
userEmail
userEmail

 

(tick)

User email for user management actions.

155

userFullName

Anchor
userFullName
userFullName

 

(tick)

User name for user management actions.

156

userId

Anchor
userId
userId

 

(tick)

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

157

userKey

Anchor
userKey
userKey

 

(tick)

Unique internal identifier for user management.

158

userPassword

Anchor
userPassword
userPassword

 

(tick)

User password for user management actions.

159

value

Anchor
value
value

 

(tick)

Single field or property value.

160

values

Anchor
values
values

 

(tick)

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

161

values2

Anchor
values2
values2

 

(tick)

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

162

verbose

Anchor
verbose
verbose

v

(error)

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

163

version

Anchor
version
version

 

(tick)

Project version name or id or add-on version.

164

withId

Anchor
withId
withId

 

(error)

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

165

workflow

Anchor
workflow
workflow

 

(tick)

Workflow name.

166

workflowScheme

Anchor
workflowScheme
workflowScheme

 

(tick)

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