Skip to end of metadata
Go to start of metadata

This page has been renamed to Reference.

Related information for 4.4.0

Actions

Action Category Description Required parameters Optional parameters Output formats

addAttachment

Attachments Add an attachment to an issue.

issue, file

findReplace, findReplaceRegex, name, encoding

 

addComment

Comments Add a comment to an issue.

issue

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

 

addComponent

Components Add component to a project.

project, component

description, lead, defaultAssignee, replace, api

 

addGroup

Groups Add a new group.

group

preserveCase

 

addLabels

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

issue, labels

   

addProjectRoleActors

Projects Add users or groups to a project role.

project, role, userId or group

   

addUserToGroupWithFile

Users Add users to groups from comma separated file.

file

autoGroup, preserveCase, encoding

 

addUserToGroup

Users Add user to a group.

userId, group

autoGroup, preserveCase

 

addUserWithFile

Users Add users from comma separated file.

file

preserveCase, encoding

 

addUser

Users Add a new user.

userId, userEmail

userFullName, userPassword, preserveCase

 

addVersion

Versions Add a new version to a project.

project, version

description, after, date, startDate, dateFormat, replace

 

addVote

Vote Add vote for issue.

issue

   

addWatchers

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

issue

userId, lookup, continue

 

addWork

Work Add work log entry.

issue, timeSpent

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

 

archiveVersion

Versions Archive a version for a project. This hides the version from the UI.

project, version

   

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

   

cloneIssue

Issues Create a new issue by copying an existing issue. Advanced options require the Clone Plus for JIRA be installed.

issue

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

 

cloneIssues

Issues Clone issues returned from a JQL search. Advanced options require the Clone Plus for JIRA be installed.

jql

project, type, continue, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, autoVersion, autoComponent, fieldExcludes, propertyPrefix, jsp

 

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). Optionally copy versions, components, role actors, and issues to new project. Issue cloning requires Clone Plus for JIRA. 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, copyComponents, copyRoleActors, cloneIssues, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix, jsp

 

copyComponent

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

project, component

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

 

copyComponents

Components Copy all or some components from one project to another.

project, toProject

components, replace, api

 

copyFieldValue

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

issue, field, toIssue or field2

asVersion, asComponent, asCascadeSelect, append, appendText, encoding, dateFormat

 

copyProjectRoleActors

Projects Copy all role actors from a project to another project.

project, toProject

continue

 

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

 

copyVersions

Versions Copy all versions from one project to another project.

project, toProject

continue, replace

 

createBoard

Agile Beta. 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

   

createFilter

Filter Beta. Create a filter.

name, search

description, favorite

 

createIssue

Issues Create a new issue or subtask for a project.

project, type

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

 

createProject

Projects Create a new project with key provided by project parameter.

project, lead

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

 

createWorkflowScheme

Workflow Create a workflow scheme using a default workflow.

name, workflow

description

 

deleteBoard

Agile Beta. Delete an Agile board.

id or board

   

deleteComponent

Components Delete component from a project.

project, component

api

 

deleteFilter

Filter Beta. Delete a filter by id or filter name (if it is a favorite filter).

id or filter

   

deleteIssue

Issues Delete an issue.

issue

   

deleteLink

Links Remove link to another issue.

issue, toIssue, link

   

deleteProject

Projects Delete a project.

project

   

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.

project, version

affectsVersions, fixVersions, autoVersion, api

 

deleteWorkflowScheme

Workflow Delete an inactive workflow scheme.

name

   

deleteWorkflow

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

name

   

exportData

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

project or search

file, exportType, dateFormat, encoding, search, limit

 

exportSite

Export Create a site export into a file in the JIRA home/export directory.

file

   

exportWorkflow

Workflow Export workflow to XML.

name

file, encoding

 

getAttachmentList

Lists List attachments for an issue.

issue

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

1 - default
999 - all

getAttachment

Attachments Get lastest attachment by name or id for an issue.

issue, file

name, encoding

 

getAvailableSteps

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

issue

file, append, encoding

 

getBoardList

Lists Beta. List Agile boards with optional filtering by regex on name.  

regex, file, append, columns, encoding

 

getClientInfo

Info Get information about the this client tool.  

outputFormat, file, append, encoding

1 - basic
2 - JVM

getCommentList

Lists List of comment information (id, dates, ...) for an issue.

issue

file, dateFormat, columns, encoding, append

1 - default
999 - all

getComments

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

issue

file, dateFormat, encoding

 

getComponentList

Lists List components defined for a projects.

project

file, columns, encoding, append, outputFormat

1 - default
999 - all

getComponent

Components Get information for a component of a project.

project, component

file, encoding

 

getCustomFieldList

Lists Get information on all custom fields.  

file, append, columns, encoding

 

getFieldList

Lists Get information on all fields.  

regex, file, append, columns, encoding

 

getFieldValue

Fields Get field value for an issue.

issue, field

file, dateFormat, asVersion, suppressId, encoding

 

getFilter

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

id or filter

   

getIssueHistoryList

Lists Get issue change history.

issue

file, dateFormat, columns, encoding

 

getIssueList

Lists List issues for a filter or a search.

filter or jql or search or project

file, dateFormat, limit, 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

getIssueTypeList

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

project, file, columns, encoding, append

 

getIssue

Issues Get information about an existing issue.

issue

file, dateFormat, asVersion, suppressId, encoding

1 - default
999 - all

getLinkList

Lists List issue links for an issue.

issue

file, columns, encoding, append

 

getLinkTypeList

Lists Get a list of all issue link types.  

file, columns, encoding

 

getProjectCategoryList

Lists List defined project categories.  

file, append, columns, encoding

 

getProjectList

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

lead, regex, outputFormat, file, columns, encoding

1 - default
2 - schemes

getProjectRoleActorList

Lists Get users and groups for a project's role.

project, role

file, columns, encoding

 

getProjectRoleList

Lists Get project roles.  

regex, file, append, columns, encoding

 

getProject

Projects Get project information.

project

suppressId, file, encoding

 

getSecurityLevelList

Lists List security levels defined for a projects.

project

file, columns, encoding, append, outputFormat

1 - default
999 - all

getServerInfo

Info Get information about the JIRA server.  

outputFormat, dateFormat, file, append, encoding

1 - basic
2 - detail

getStatusList

Lists List statuses.  

file, encoding, append

 

getTransitionList

Lists Get available workflow transitions for an issue.

issue

outputFormat, file, append, encoding

1 - basic
2 - fields

getUserList

Lists List users from a group or a search by name fragment (userId, display name, and email). Use name of @all to retrieve all users. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches.

group or name

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

1 - basic
2 - extended attributes
999 - all

getUser

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

userId or userKey or name

file, endcoding

 

getVersionList

Lists List versions defined for a projects.

project

regex, file, columns, encoding, append, outputFormat

1 - default
2 - description
999 - all

getVersion

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

project, version

dateFormat, file, encoding

 

getVoterList

Lists Get list of users that have voted for an issue.

issue

append, file, columns, encoding

1 - simple
2 - CSV

getWatcherList

Lists Get list of users that are watching an issue.

issue

append, file, columns, encoding

1 - simple
2 - CSV

getWorkList

Lists Get list of a work log entry.

issue

dateFormat, file, columns, encoding, append, outputFormat

999 - all

getWorkflowList

Lists Get list of a workflows matching selection criteria.  

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

 

getWorkflowSchemeList

Lists Get list of a workflow schemes matching selection criteria.  

limit, regex, file, append, columns, encoding

 

getWorkflowScheme

Workflow Get workflow scheme information.

name

file, encoding

 

getWorkflow

Workflow Get workflow information.

name

dateFormat, file, encoding

 

importWorkflow

Workflow Import workflow from XML.

name, file

description, findReplace, findReplaceRegex, encoding

 

linkIssue

Issues Link an issue to another issue.

issue, toIssue, link

comment, group, role,

 

login

Misc Login to remote server. Returns login token.

password

user

 

logout

Misc Logout of remote server.      

progressIssue

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

issue, step

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

 

releaseVersion

Versions Release a version for a project. Resets release date if provided. Defaults to current if release date is not set.

project, version

date, dateFormat

 

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

   

removeGroup

Groups Remove a group.

group

defaultGroup

 

removeLabels

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

issue, labels

   

removeProjectRoleActors

Projects Remove users or groups from a project role.

project, role, userId or group

   

removeUserFromGroupWithFile

Users Remove users from groups from comma separated file.

file

encoding

 

removeUserFromGroup

Users Remove user from a group.

userId, group

   

removeUserProperty

Users Remove a user's property.

userId, name

lookup

 

removeUserWithFile

Users Remove users from comma separate file.

file

encoding

 

removeUser

Users Remove a user.

userId

   

removeVote

Vote Remove vote from issue.

issue

   

removeWatchers

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

issue

userId, lookup, continue

 

removeWork

Work Remove work log entry.

id

   

renderRequest

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

request

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

 

restoreExport

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

file

   

runFromAttachmentList

Run 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,

 

runFromCsv

Run Run actions generated from a CSV file.

file

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

 

runFromIssueList

Run 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,

 

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 variable is entry.

list

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

 

runFromProjectList

Run 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,

 

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

 

runFromVersionList

Run 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,

 

runFromWorkflowList

Run 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,

 

run

Run Run actions from a file or standard input.

file or standard input

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

 

setFieldValue

Fields Set custom field value for an issue.

issue, field, file or value or values

field2, values2, asVersion, asComponent, asCascadeSelect, append, appendText, subtract, encoding, dateFormat

 

setShareScope

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

value

   

transitionIssue

Issues Transition issue through workflow.

issue, transition

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

 

unarchiveVersion

Versions Unarchive a version for a project. This makes the version visible again in the UI.

project, version

   

unreleaseVersion

Versions Unrelease a version for a project, optionally reset release date.

project, version

date, dateFormat

 

updateComponent

Components Update component for a project.

project, component

name, description, lead, defaultAssignee, api

 

updateFilter

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

id of filter

name, search, description, favorite

 

updateIssue

Issues Update an existing issue.

issue

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

 

updateOrCreateIssue

Issues Experimental. Search for an issue using JQL. If a single issue is found, update it. If no issue is found, create it.

jql

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

 

updateProject

Projects Update project information. Scheme updates require compatible schemes.

project

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

 

updateUserProperty

Users Add or update a user's property.

userId, name, value

lookup

 

updateUser

Users Update user information.

userId or userKey

userFullName, userEmail, newUserId, activate, deactivate

 

updateVersion

Versions Update version for a project.

project, version

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

 

updateWork

Work Update work log entry.

id, issue

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

 

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 can vary by environment (sad), here are the techniques that may work in your environment:
    • 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\" "
    • Non-Windows 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"" "
    • Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote
    • 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"

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

acceptType

 

Content type to accept for renderRequest if different than type.

action

a

 

activate

 

Activate user.

affectsVersions

 

Affects versions - comma separated names or ids.

after

 

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

api

 

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

append

 

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

appendText

 

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

asCascadeSelect

 

Interpret values parameter as a cascade select value ids.

asComponent

 

Interpret values parameter as component values and convert each to the component id.

asVersion

 

Interpret values parameter as version values and convert each to the version id.

assignee

 

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

autoAdjust

 

Auto adjust remaining estimate when adding work entry.

autoComponent

 

Automatically add components used in components parameter.

autoGroup

 

Groups are automatically added when referenced in add user functions.

autoVersion

 

Automatically add versions used in affectsVersions and fixVersions parameters.

board

 

Agile board name.

category

 

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

clearFileBeforeAppend

 

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

cloneIssues

 

Clone issues when cloning a project.

columns

 

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

comment

 

Comment for an issue.

common

 

Common parameter string added to all run actions.

component

 

Project component name or id.

components

 

Project components - comma separated names or ids.

connectionTimeout

 

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

continue

 

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

cookies

 

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

copyAttachments

 

Copy attachments when cloning an issue.

copyComments

 

Copy comments when cloning an issue.

copyComponents

 

Copy components when cloning a project.

copyLinks

 

Copy issue links when cloning an issue.

copyRoleActors

 

Copy project role actors when cloning a project.

copySubtaskEstimates

 

Copy subtask estimates when cloning an issue.

copySubtasks

 

Copy subtasks when cloning an issue.

copyVersions

 

Copy versions when cloning a project.

copyWatchers

 

Copy Watchers when cloning an issue.

custom

 

Custom fields - comma separated key:value pairs. Key can be field name or id. Single quote the key:value pair if it contains a comma (,) or line breaks.

database

 

Database name is required for SQL actions.

date

 

Release date for version or due date for issue.

dateFormat

 

Format string for date in Java SimpleDateFormat, default is client date format.

dbPassword

 

Database user password. Defaults to password.

dbUser

 

Database user name. Defaults to user.

deactivate

 

Deactivate user.

debug

 

Requests detail debug output. Optional for all actions.

defaultAssignee

 

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

defaultGroup

 

Default group to move users on removeGroup action.

deleteFilter

 

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

description

 

Description.

driver

 

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

encoding

 

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

environment

 

Issue environment.

estimate

 

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

exportType

 

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

favorite

 

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

field

 

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

field2

 

Field name or id for a custom field.

fieldConfigurationScheme

 

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

fieldExcludes

 

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

file

f

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

filter

 

Filter id or favorite filter name.

findReplace

 

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

findReplaceRegex

 

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

fixVersions

 

Fix versions - comma separated names or ids.

group

 

Group name.

help

 

Prints this help message.

host

 

Database host server for SQL actions. Not used if url is provided. (default: localhost)

id

 

Numeric id of an item.

includeInactive

 

To include inactive users in a user list.

issue

 

Issue key or id.

issueSecurityScheme

 

Issue security scheme name or id

issueTypeScheme

 

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

issueTypeScreenScheme

 

Issue type screen scheme name or id. Use blank for default scheme. JIRA 5.1 and later only.

jql

 

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

jsp

 

Custom JSP name for clone actions. Deprecated.

labels

 

Labels or tags. A blank separated list.

lead

 

Project lead user id.

limit

 

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

link

 

Link description.There are release level API differences on whether the link should be specified as the link type name (like 'relates') or the directed name (like 'relates to'). On later releases (JIRA 5.0+), link type name is the best choice. The link id can also be used for both linkIssue and deleteLink.

list

 

Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled.

login

 

Login token from previous login request.

loginFromStandardInput

l

Get login token from standard input. Only works for actions based solely on SOAP based server requests. Actions using REST based server requests require passwords on each action.

lookup

 

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

name

 

Name.

newUserId

 

Used to assign a new user id to an existing user. Since JIRA 6.1.

notificationScheme

 

Notification scheme name or id.

originalEstimate

 

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

outputFormat

 

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

parent

 

Parent issue key or id.

password

p

User password for remote access.

permissionScheme

 

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

port

 

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

preserveCase

 

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

priority

 

Issue priority - name or id.

project

 

Project name, key, or id.

propertyFile

 

Property file with mapping information.

propertyPrefix

 

Prefix used for accessing properties for custom clone actions.

quiet

 

Limit some output messages. Optional for all actions.

reference

 

Reference to a replacement key value used to remember last created issue key.

regex

 

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

replace

 

Replace existing entity.

reporter

 

Issue reporter user id.

request

 

URL fragment for a request.

requestParameters

 

URL request parameters.

requestType

 

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

resolution

 

Resolution name or id.

role

 

User role in project

search

 

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

security

 

Issue security level name or id.

server

s

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

service

 

Service address extension. (default: /rpc/soap/jirasoapservice-v2)

simulate

 

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

special

 

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

sql

 

SQL select statement used to generate a run script.

startDate

 

Date version was started.

step

 

Deprecated. Now called transition.

subtract

 

Subtract values from existing values custom fields supporting multiple values.

summary

 

Summary of issue.

suppressId

 

Suppress showing an id when displaying issue fields.

template

 

Project template. Experimental, JIRA 6.3 and above. Project template to use, default is JIRA Default Schemes. If a template is not found, a list of valid templates will be shown in the error message.

timeSpent

 

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

toComponent

 

Project component name or id.

toIssue

 

Link destination issue key or id.

toProject

 

Project name, key, or id to copy to.

transition

 

Workflow transition - name or id.

type

 

Issue type - name or id. Also, content type for renderRequest.

url

 

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

useParentVersions

 

Copy parent versions to subtask when cloning an issue.

user

u

User name for remote access. (default: automation)

userEmail

 

User email for user management actions.

userFullName

 

User name for user management actions.

userId

 

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

userKey

 

Unique internal identifier for user management. Since JIRA 6.1.

userPassword

 

User password for user management actions.

value

 

Single field or property value.

values

 

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

values2

 

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

verbose

v

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

version

 

Project version name or id or plugin version.

workflow

 

Workflow name.

workflowScheme

 

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

  • No labels