...
Related information for
...
6.
...
6.0
Help Text
No Format |
---|
Usage: jira (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>] [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--dbJar <dbJar>] [--afterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--propertyFilecomment <comment>] [--replace] [--propertyFile <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--dateFormat2 <dateFormat2>] [--reference <reference>] [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--list2 <list2>] [--options <options>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] (-s|--server) <server> (-u|--user) <user> (-p|--password) <password> [--serviceapi <service><api>] [--cookiesservice <cookies><service>] [-l|--loginFromStandardInputcookies <cookies>] [--project <project>] [--toProject <toProject>] [--name <name>] [--description <description>] [--lead <lead>] [--defaultAssignee <defaultAssignee>] [--after <after>] [--board <board>] [--issue <issue>] [--toIssue <toIssue>] [--parent <parent>] [--summary <summary>] [--priority <priority>] [--reporter <reporter>] [--assignee <assignee>] [--security <security>] [--environment <environment>] [--component <component>] [--toComponent <toComponent>] [--components <components>] [--version <version>] [--affectsVersions <affectsVersions>] [--fixVersions <fixVersions>] [--custom <custom>] [--field <field>] [--field2 <field2>] [--fieldExcludes <fieldExcludes>] [--date <date>] [--startDate <startDate>] [--issueType <issueType>] [--type <type>] [--resolution <resolution>] [--labels <labels>] [--workflow <workflow>] [--transition <transition>] [--step <step>] [--commentscreen <comment><screen>] [--filter <filter>] [--jql <jql>] [--search <search>] [--regex <regex>] [--referenceregex2 <reference><regex2>] [--link <link>] [--reverseLink <reverseLink>] [--value <value>] [--values <values>] [--values2 <values2>] [--timeSpent <timeSpent>] [--estimate <estimate>] [--originalEstimate <originalEstimate>] [--id <id>] [--propertyPrefix <propertyPrefix>] [--jsp <jsp><propertyPrefix>] [--request <request>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType <acceptType>] [--limit <limit>] [--api <api>] [--role <role>] [--group <group>] [--defaultGroup <defaultGroup>] [--userId <userId>] [--newUserId <newUserId>] [--userKey <userKey>] [--userFullName <userFullName>] [--userEmail <userEmail>] [--userPassword <userPassword>] [--autoGroup] [--permissionScheme <permissionScheme>] [--notificationScheme <notificationScheme>] [--issueSecurityScheme <issueSecurityScheme>] [--workflowScheme <workflowScheme>] [--issueTypeScheme <issueTypeScheme>] [--issueTypeScreenScheme <issueTypeScreenScheme>] [--fieldConfigurationScheme <fieldConfigurationScheme>] [--category <category>] [--template <template>] [--exportType <exportType>] [--login <login>] [-l|--loginFromStandardInput] [--functionKey <functionKey>] [--targetServer <targetServer>] [--targetUser <targetUser>] [--targetPassword <targetPassword>] [--autoVersion] [--autoComponent] [--autoAdjust] [--asVersion] [--asComponent] [--asCascadeSelect] [--appendText] [--subtract] [--suppressId] [--withId] [--exportAttachments] [--copyLinks] [--copyAttachments] [--copyComments] [--copyWatchers] [--copySubtasks] [--copySubtaskEstimates] [--useParentVersions] [--cloneIssues] [--copyVersions] [--copyComponents] [--copyRoleActors] [--replaceactivate] [--activatedeactivate] [--deactivatenotify] [--notifysuppressNotify] [--includeInactive] [--deleteFilter] [--favorite] [--lookup] [--legacy] [--preserveCase] [--recursive] [--helpText <helpText>] [--participants <participants>] [--organization <organization>] [--forUser <forUser>] [--help] Provides capability to make requests to a remote server. Required parameters: action, server, password. Optional parameters: user (likely required for your installation). Other required and optional parameters depending on action requested. (-a|--action) <action> Requested operation to perform. Valid actions are listed at the end. [(-f|--file) <file>] Path to file based content or result output. Use - for standard input. [--encoding <encoding>] Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. [--debug] Requests detail debug output. Optional for all actions. [-v|--verbose] Requests verbose output to help with problem determination. Optional for all actions. [--quiet] Limit some output messages. Optional for all actions. [--outputFormat <outputFormat>] Specify output format for an action. (default: 1) [--columns <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. [--connectionTimeout <connectionTimeout>] Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. [--sql <sql>] SQL select statement used to generate a run script. [--driver <driver>] JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. [--url <url>] Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. [--host <host>] Database host server for SQL actions. Not used if url is provided. (default:Defaults to localhost) if not provided. [--port <port>] Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. [--database <database>] Database name is required for SQL actions. [--dbUser <dbUser>] Database user name. Defaults to user. [--dbPassword <dbPassword>] Database user password. Defaults to password. [--propertyFiledbJar <propertyFile><dbJar>] By default, lib/jdbc is used Propertyto fileautomatically withload mappingdatabase informationdrivers. Otherwise you can [--common <common>] specify a specific file or url Common parameter string added toreference allfor runthe actions.database driver jar. Example [--special <special>]/jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parametershttps://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar [--afterSql <afterSql>] SQL to run after a successful action. Limited to specific actions at this time. [--dateFormatdbTable <dateFormat><dbTable>] FormatDatabase stringtable forname datewhen increating Javaor SimpleDateFormat,updating defaulta isdatabase clientfrom datelist formatoutput. [--findReplacedbTableKeys <findReplace><dbTableKeys>] FindComma andseparated replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded list of column names used to access existing rows for update. Normally this defines a primary key set for quotes must bethe doubledtable. [--findReplaceRegexdbCreateTable] <findReplaceRegex>] Database Findtable andneeds replaceto textbe withcreated abefore regularadding expression. Comma separated list of colon separated pairs. Single quote valuesrows. [--comment <comment>] Comment text. [--replace] Replace containingexisting aentity delimiter.on Embeddedadd, quotescreate, mustor besimilar doubledactions. [--listpropertyFile <list><propertyFile>] CommaProperty separatedfile listwith ofdatabase entries.parameters, Singlefield quotemappings, valuesor containingclient a delimiter. Embedded quotes must be doubledspecific information. [--continuecommon <common>] ContinueCommon processingparameter evenstring afteradded errors are encountered forto all run actions. Also used for some action to ignore certain errors[--special <special>] Ordered list of alternate likecharacters notfor foundcomma errors( on, remove), actions.colon ( : [--simulate] Simulate running actions. Log the action that would be taken. [--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. [--clearFileBeforeAppend] For run actions, this option will automatically clear an existing file on the first append requested. (-s|--server) <server> Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser. (-u|--user) <user> User name for remote access. (default: automation) (-p|--password) <password> User password for remote access. [--service <service>] Service address extension. (default: /rpc/soap/jirasoapservice-v2) [--cookies <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. [-l|--loginFromStandardInput), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. [--dateFormat <dateFormat>] Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format. [--dateFormat2 <dateFormat2>] Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd. [--reference <reference>] Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key. [--findReplace <findReplace>] Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. [--findReplaceRegex <findReplaceRegex>] GetFind loginand tokenreplace fromtext standardwith input.a Onlyregular worksexpression. forComma actionsseparated basedlist solelyof oncolon SOAP based server requestsseparated pairs. ActionsSingle usingquote RESTvalues basedcontaining servera requestsdelimiter. requireEmbedded passwordsquotes onmust eachbe actiondoubled. [--projectlist <project><list>] Project name, key, or id. [--toProject <toProject>] Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a Project name, key,delimiter. orEmbedded idquotes tomust copybe todoubled. [--namelist2 <name><list2>] Name.Comma separated list of [--description <description>] Description. [--lead <lead>]entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded Projectquotes leadmust userbe iddoubled. [--defaultAssigneeoptions <defaultAssignee><options>] ProjectComma orseparated compnentlist defaultof assigneesupport, forexperimental, issues.or Forother projects,client defaultor isaction unassignedspecific withoptions. options: PROJECT_LEAD or [--continue] UNASSIGNED (blank). For components, default is PROJECT_DEFAULT with options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or UNASSIGNED (blank). [--after <after>] Version name or id to add a version after. Defaults to after last version. Use -1 to make it the first versionContinue 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. [--simulate] Simulate running actions. Log the action that would be taken. [--board <board>append] AgileAppend boardvalues name.to existing values for [--issue <issue>] Issue key or id.version fields, components field, and custom fields supporting multiple values. For [--toIssue <toIssue>] some actions using the file parameter, append will Linkappend destinationoutput issueto keythe orexisting idfile. [--parent <parent>] Parent issue key or idclearFileBeforeAppend] For run actions, this option will automatically clear an existing file on the first append requested. [(-s|--summaryserver) <summary>]<server> SummaryServer of issueURL. Normally the base [--priority <priority>] Issue priority - name or idURL of the server and the same as how the server is accessed from a browser. [(-u|--reporteruser) <reporter>]<user> IssueUser reportername for userremote idaccess. (default: automation) [ (-p|--assigneepassword) <assignee>]<password> Issue assignee user id. In some contexts, use -1User password for automatic assignment and "" for unassignedremote access. [--securityapi <security><api>] Issue security level name or idAPI version. Some requests produce [--environment <environment>] Issue environment.different results based on the api version used. (default: latest) [--componentservice <component><service>] ProjectService componentaddress name or id.extension. (default: /rest/api) [--toComponentcookies <toComponent><cookies>] ProjectName componentof namefile orto id. [--components <components>] restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session Project components -affinity commafor separatedactions namesusing orREST idsAPIs. [--versionproject <version><project>] Project versionname, namekey, or id or add-on version. [--affectsVersionstoProject <affectsVersions><toProject>] Project name, key, or id to copy Affectsto. versionsFor -cloning commaissues, separatedeither namestoProject or ids project can be used. [--fixVersionsname <fixVersions><name>] Name. Fix versions [- comma separated names or ids-description <description>] Description. [--customlead <custom><lead>] CustomProject 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. [--field <field>] Field name or id. For some actions, this parameter must be a custom fieldlead user id. [--defaultAssignee <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). [--field2after <field2><after>] FieldVersion name or id forto add a customversion fieldafter. Defaults to after last [--fieldExcludes <fieldExcludes>] version. Use -1 to make it the first version. Fields to exclude from cloning - comma separated list of fields[--board <board>] Agile board name. [--dateissue <date><issue>] ReleaseIssue datekey for version or due date for issueid. [--startDatetoIssue <startDate><toIssue>] Target or link destination Dateissue versionkey wasor startedid. [--typeparent <type><parent>] IssueParent typeissue -key name or id. Also, content type for renderRequest. [--resolutionsummary <resolution><summary>] ResolutionSummary nameof or idissue. [--labelspriority <labels><priority>] LabelsIssue orpriority tags.- Aname blankor separated listid. [--workflowreporter <workflow><reporter>] Workflow nameIssue reporter user id. [--transitionassignee <transition><assignee>] Workflow transition - name or idIssue assignee user id. In some contexts, use -1 for automatic assignment and "" for unassigned. [--stepsecurity <step><security>] Deprecated. Now called transitionIssue security level name or id. [--commentenvironment <comment><environment>] Comment for an issueIssue environment. [--filtercomponent <filter><component>] Project Filtercomponent idname or favorite filter nameid. Use for getIssueList is deprecated. Use JQL instead.[--toComponent <toComponent>] [--jql <jql>] Project component name or id. JQL query. Alternate way to search for issues for getIssueList and runFromIssueList - continue to use search parameter for compatibility with previous[--components <components>] Project components - comma separated names or ids. [--searchversion <search><version>] SearchProject JQLversion queryname usingor legacyid support. Deprecated. Use jql parameter instead for new supportor add-on version. [--regexaffectsVersions <regex><affectsVersions>] Affects versions Regular- expressioncomma forseparated includingnames matchingor contentids. For example, used to subset projects or versions on getProjectList and runFromVersionList [--fixVersions <fixVersions>] Fix versions - comma separated names or ids. [--referencecustom <reference><custom>] A Referencelist toof acustom replacementfield key :value usedpairs. toNormally remembera lastcomma createdseparated issuelist key.of colon separated [--link <link>] pairs. Key can be field name or Link description.There are releaseid. levelSingle APIquote differencesthe onkey:value whetherpair theif linkit shouldcontains bea specifiedcomma as(,) theor linkline typebreaks nameand (likesimilarly for the colon separator. An 'relates') or the directed name (likealternative 'relatesis to'). Onuse latera releasesJSON (JIRA 5.0+), link type name is the best choice. The formatted string to represent the list of key:value pairs. [--field <field>] link id can also beField usedname foror bothid. linkIssue and deleteLinkFor some actions, this parameter must be a custom field. [--valuefield2 <value><field2>] SingleField fieldname or property valueid for a custom field. [--valuesfieldExcludes <values><fieldExcludes>] CommaFields separatedto listexclude offrom fieldcloning values.- Singlecomma quoteseparated valueslist containingof commasfields. [--values2date <values2><date>] CommaRelease separateddate listfor ofversion fieldor values.due Singledate quote values containing commasfor issue. [--timeSpentstartDate <timeSpent><startDate>] TimeDate spentversion on work using. Example: 3h 30mwas started. [--estimateissueType <estimate><issueType>] EstimateIssue oftype time- remainingname foror an issueid. Example: 3h 30m. [--originalEstimatetype <originalEstimate><type>] Original estimate of time to complete work for an issue. Example: 3h 30m. [--id <id>]Issue type (alternative to issueType), custom field type, link type, transition function type, application link type, project type, board type, Numericand idcontent oftype anfor itemrenderRequest. [--propertyPrefixresolution <propertyPrefix><resolution>] PrefixResolution usedname for accessing properties for custom clone actionsor id. [--jsplabels <jsp><labels>] CustomLabels JSPor nametags. forA cloneblank actions.separated Deprecatedlist. [--requestworkflow <request><workflow>] URL fragment for a requestWorkflow name. [--requestParameterstransition <requestParameters><transition>] URL request parametersWorkflow transition - name or id. [--requestTypestep <requestType><step>] TypeSource ofstep aname renderfor requestaddTransition. like GET or POST (default: GET) [--acceptTypescreen <acceptType><screen>] Transition Contentscreen typename. to accept for renderRequest if different than type.[--filter <filter>] [--limit <limit>] Filter id or favorite filter name. Use for MaximumgetIssueList numberis ofdeprecated. entriesUse toJQL returninstead. (default: 2147483647) [--apijql <api><jql>] APIJQL versionquery. SomeAlternate requestsway produceto differentsearch resultsfor basedissues onfor thegetIssueList apiand versionrunFromIssueList used.- Deprecated. (default: latest) [--role <role>]continue to use search parameter for compatibility User role in projectwith previous. [--groupsearch <group><search>] Search JQL query using legacy support. Deprecated. Use jql parameter instead for Groupnew namesupport. [--defaultGroupregex <defaultGroup><regex>] Default group to transfer comment and worklog visibility settings to on removeGroupRegular expression for including matching content. For example, used to subset projects or versions on getProjectList and runFromVersionList. [--userIdregex2 <userId><regex2>] UserRegular idexpression for usersecondary management and other actionscontent matching. ForIn some actionscases, filtering on a commasecondary separatedfield listmay ofbe idsneeded. [--newUserIdlink <newUserId><link>] UsedLink todescription. assignUsually alink newtype username for idlocal tolinks anand existingrelationship user.description Sincefor JIRAremote 6links.1.The link id can [--userKey <userKey>]also be Uniqueused internal identifier for userboth management.linkIssue Sinceand JIRA 6deleteLink.1. [--userFullNamereverseLink <userFullName><reverseLink>] UserLink namedescription for user management actions the (optional) reverse link for addRemoteLink. [--userEmailvalue <userEmail><value>] UserSingle emailfield foror userproperty management actionsvalue. [--userPasswordvalues <userPassword><values>] Comma separated list of field Uservalues. passwordSingle forquote uservalues managementcontaining actionscommas. [--autoGroupvalues2 <values2>] GroupsComma areseparated automaticallylist addedof whenfield referencedvalues. inSingle addquote uservalues containing functionscommas. [--permissionSchemetimeSpent <permissionScheme><timeSpent>] PermissionTime schemespent nameon orwork idusing. (defaultExample: Default Permission Scheme)3h 30m. [--notificationSchemeestimate <notificationScheme><estimate>] Estimate of time remaining for Notificationan schemeissue. nameExample: or3h id30m. [--issueSecuritySchemeoriginalEstimate <issueSecurityScheme><originalEstimate>] Original estimate of time to complete work Issuefor securityan schemeissue. nameExample: or3h id30m. [--workflowSchemeid <workflowScheme><id>] Workflow scheme name or id. Use blank for default schemeNumeric id of an item. [--issueTypeSchemepropertyPrefix <issueTypeScheme><propertyPrefix>] IssuePrefix typeused schemefor nameaccessing orproperties id.for Usecustom blankclone foractions. default schemeRequires Clone Plus for JIRA be installed on the server. [--issueTypeScreenSchemerequest <issueTypeScreenScheme><request>] Issue type screen scheme name or id. Use blank for default scheme. JIRA 5.1 and later onlyURL fragment for a request. [--requestParameters <requestParameters>] URL request parameters or post data.. [--fieldConfigurationSchemerequestType <fieldConfigurationScheme><requestType>] FieldType configurationof schemea namerender orrequest id.like UseGET blankor forPOST (default: scheme.GET) [--categoryacceptType <category><acceptType>] ProjectContent category.type Administratorto accessaccept requiredfor torenderRequest seeif ordifferent usethan project categoriestype. [--templatelimit <template><limit>] ProjectMaximum template.number JIRAof 6.3entries andto above. Project template name to use (case sensitive) as found on the Create project dialog.return. (default: 2147483647) [--role <role>] User role Ifin aproject template is not found, a list of valid templates will be shown in the error message [--group <group>] Group name. [--exportTypedefaultGroup <exportType><defaultGroup>] Default PROJECTgroup to export project information, PARTICIPANTStransfer comment and worklog visibility settings to exporton issue participantsremoveGroup. Use comman separated list if more than one[--userId <userId>] User id arefor needed.user management and [--login <login>] Login token from previous login request. [--autoVersion]other actions. For some actions, a comma separated list of ids. [--newUserId <newUserId>] Used to assign a new Automaticallyuser addid versionsto usedan in affectsVersions and fixVersions parametersexisting user. [--autoComponentuserKey <userKey>] AutomaticallyUnique addinternal componentsidentifier usedfor inuser components parametermanagement. [--autoAdjustuserFullName <userFullName>] AutoUser adjustname remainingfor estimateuser when adding work entrymanagement actions. [--asVersionuserEmail <userEmail>] InterpretUser valuesemail parameterfor asuser version values and convert each to the version idmanagement actions. [--asComponentuserPassword <userPassword>] InterpretUser valuespassword parameterfor asuser component values and convert each to the component idmanagement actions. [--asCascadeSelectautoGroup] InterpretGroups valuesare parameterautomatically added aswhen areferenced cascadein selectadd valueuser idsfunctions. [--appendTextpermissionScheme <permissionScheme>] AppendPermission textscheme toname existingor value text for description, environment, and single and multi-value custom fieldsid. (default: Default Permission Scheme) [--notificationScheme <notificationScheme>] Notification scheme name or id. [--subtractissueSecurityScheme <issueSecurityScheme>] SubtractIssue valuessecurity fromscheme existingname valuesor customid fields supporting multiple values. [--suppressIdworkflowScheme <workflowScheme>] Workflow Suppressscheme showingname anor id. whenUse displayingblank issuefor fieldsdefault on getIssuescheme. [--withIdissueTypeScheme <issueTypeScheme>] DisplayIssue thetype issuescheme fieldname valueor including the internal id (if the field has an internal value) using the following format:id. Use blank for default scheme. [--issueTypeScreenScheme <issueTypeScreenScheme>] Issue type screen scheme name valueor (id)id. Use blank for default scheme. [--exportAttachmentsfieldConfigurationScheme <fieldConfigurationScheme>] Export attachments and similar dataField configuration scheme name or id. Use blank for sitedefault exportscheme. [--copyLinkscategory <category>] Copy issue links when cloning an issueProject category. Administrator access required to see or use project categories. [--copyAttachmentstemplate <template>] CopyProject attachmentstemplate whenor cloningshared anproject issue.key, name, or [--copyComments] Copy comments when cloning an issue. [--copyWatchers] Copy Watchers when cloning an issue. [--copySubtasks] 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 Copy subtasks when cloning anerror issuemessage. [--copySubtaskEstimatesexportType <exportType>] CopyPROJECT subtaskto estimatesexport whenproject cloninginformation, anPARTICIPANTS issue.to export issue [--useParentVersions] Copy parent versions to subtask when cloning an issueparticipants. Use comman separated list if more than one are needed. [--cloneIssueslogin <login>] CloneLogin issuestoken whenfrom cloningprevious alogin projectrequest. [-l|--copyVersionsloginFromStandardInput] CopyGet versionslogin whentoken cloningfrom astandard projectinput. [--copyComponentsfunctionKey <functionKey>] CopyTransition componentsfunction's whenunique cloningkey. a project.Example: org.swift.jira.cot:createissue-function [--copyRoleActorstargetServer <targetServer>] CopyTarget projectserver roleURL actorsfor when cloning a projectcopy requests. [--replacetargetUser <targetUser>] ReplaceTarget existingserver entityuser. Defaults to [--activate]user parameter. [--targetPassword <targetPassword>] Activate user. [--deactivate]Target server user password. Defaults to password Deactivate userparameter. [--notifyautoVersion] Automatically add Notifyversions used userin afteraffectsVersions userand isfixVersions addedparameters. [--includeInactiveautoComponent] ToAutomatically includeadd inactivecomponents usersused in acomponents user listparameter. [--deleteFilterautoAdjust] Attempt to delete the filter associated with the board. Filter must be a findable as a favorite filterAuto adjust remaining estimate when adding work entry. [--asVersion] Deprecated. Ignored on JIRA 7.x. [--favoriteasComponent] Deprecated. Ignored on JIRA 7.x [--asCascadeSelect] Mark a filter as a favorite when creatingDeprecatated. orIgnored updatingon aJIRA filter7.x. [--lookupappendText] LookupAppend userIdtext viato searchexisting andvalue validate.text Anfor errordescription, isenvironment, reportedand ifsingle searchand doesmulti-value not return a single usercustom fields. [--legacysubtract] SomeSubtract capabilitiesvalues havefrom newerexisting impementationsvalues (likecustom usingfields newersupporting RESTmultiple APIs)values. In some cases, the older (deprecated) [--suppressId] Suppress showing implementationan mayid stillwhen bedisplaying availableissue forfields a limited number of releaseson getIssue. This switch can be[--withId] set to use the older Display the issue field value implementationincluding tothe easeinternal migrationid to(if the newerfield support.has an internal [--preserveCase] value) using the following format: Some actions (example addUser,value addGroup(id). automatically lowercase names usually[--exportAttachments] because the construct is case insensitive. Export attachments and similar data Use this switch to override the default behavior and preserve the casefor site export. [--copyLinks] Copy issue links when cloning an issue. [--helpcopyAttachments] PrintsCopy thisattachments helpwhen message.cloning an issue. Valid actions (case insensitive): [--copyComments] login - Login to remote server. Returns loginCopy token.comments Deprecatedwhen startingcloning withan JIRA 7.0. Required parameters: password Optional parameters: user logout - Logout of remote server. Deprecated starting with JIRA 7.0. getClientInfo - Get information about the this client tool. Optional parameters: outputFormat, file, append, encoding Output formats: 1 - basic, 2 - JVM getServerInfo - Get information about the JIRA server. Optional parameters: outputFormat, dateFormat, file, append, encoding Output formats: 1 - basic, 2 - detail validateLicense - Validates the CLI Connector is enabled and licensed on the server. renderRequest - Render url based request. The response data modified by findReplace processing is returned. Required parameters: request Optional parameters: requestParameters, requestType, type, acceptType, issue, project, , findReplace, findReplaceRegex, file, encoding, run - Run actions from a file or standard input. Required parameters: file or standard input Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input Required parameters: sql or file or standard input Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromCsv - Run actions generated from a CSV file. Required parameters: file Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromList - Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variable is entry. Required parameters: list Optional parameters: file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromIssueList - Run actions for each issue from an issue list based on a filter or a search. Available replacement variables are project, issue, issueId. Required parameters: filter or jql or search or project Optional parameters: common, continue, simulate, limit, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromProjectList - Run actions for each project with optional filtering by lead and regex on project key. Available replacement variables are project, projectId. Optional parameters: lead, regex, common, continue, simulate, limit, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromVersionList - Run actions for each version in a project. Available replacement variables are project, projectId, version, versionId. Required parameters: project Optional parameters: regex, common, continue, simulate, limit, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromComponentList - Run actions for each component in a project. Available replacement variables are project, projectId, component, componentId. Required parameters: project Optional parameters: regex, common, continue, simulate, limit, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromAttachmentList - Run actions for a list of attachments for an issue. Available replacement variables are attachment, attachmentId. Required parameters: issue Optional parameters: common, continue, simulate, limit, regex, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromGroupList - Run action for each group with optional regex filtering on group name. Available replacement variable is group. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, getProjectList - List defined projects with optional filtering by lead and regex on project key. Optional parameters: lead, regex, outputFormat, file, columns, encoding Output formats: 1 - default, 2 - schemes, 999 - all getProjectCategoryList - List defined project categories. Optional parameters: file, append, columns, encoding getVersionList - List versions defined for a projects. Required parameters: project Optional parameters: regex, file, columns, encoding, append, outputFormat Output formats: 1 - default, 2 - description, 999 - all getComponentList - List components defined for a projects. Required parameters: project Optional parameters: limit, regex, file, columns, encoding, append, outputFormat issue. [--copyWatchers] Copy Watchers when cloning an issue. [--copySubtasks] Copy subtasks when cloning an issue. [--copySubtaskEstimates] Copy subtask estimates when cloning an issue. [--useParentVersions] Copy parent versions to subtask when cloning an issue. [--cloneIssues] Clone issues when cloning a project. [--copyVersions] Copy versions when cloning a project. [--copyComponents] Copy components when cloning a project. [--copyRoleActors] Copy project role actors when cloning a project. [--activate] Activate user. [--deactivate] Deactivate user. [--notify] Notify user after user is added. [--suppressNotify] Suppress notifying users when an issue is updated. Initially only available for JIRA Cloud. [--includeInactive] To include inactive users in a user list. [--deleteFilter] Attempt to delete the filter associated with the board. Filter must be a findable as a favorite filter. [--favorite] Mark a filter as a favorite when creating or updating a filter. [--lookup] Lookup userId via search and validate. An error is reported if search does not return a single user. [--legacy] Some capabilities have newer impementations (like using newer REST APIs). In some cases, the older (deprecated) implementation may still be available for a limited number of releases. This switch can be set to use the older implementation to ease migration to the newer support. [--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. [--recursive] Include subdirectories. [--helpText <helpText>] Service Desk: Help text. [--participants <participants>] Service Desk: A comma separated list of user ids for request participation or as organization members. [--organization <organization>] Service Desk: Organization name or id representing a grouping of users primarily for access permissions. [--forUser <forUser>] Service Desk: Request is made on behalf of another user. [--help] Prints this help message. Valid actions (case insensitive): login - Login to remote server. Returns login token that can be used on subsequent requests with the login or loginFromStandardInput parameters. Required parameters: password Optional parameters: user logout - Logout of remote server. getLoginInfo - Get login information for the current logged in user. getClientInfo - Get information about the this client tool. Optional parameters: outputFormat, file, append, encoding Output formats: 1 - defaultbasic, 2 - with projectJVM, 99911 - all getSecurityLevelListaction list, 12 - Listparameter securitylist levelsgetServerInfo defined- forGet ainformation projects.about the Required parameters: projectJIRA server. Optional parameters: fileoutputFormat, columnsdateFormat, encodingfile, append, outputFormatencoding Output formats: 1 - defaultbasic, 9992 - alldetail getProjectRoleListvalidateLicense - GetValidates projectthe roles.CLI Connector Optionalis parameters:enabled regex,and file,licensed append,on columns,the encodingserver. getProjectRoleActorListrenderRequest - Get users and groups for a project's roleRender url based request. The response data modified by findReplace processing is returned. Required parameters: request or project, or roleissue Optional parameters: filerequestParameters, columnsrequestType, encodingtype, getProjectRoleByUserListacceptType, -findReplace, GetfindReplaceRegex, projectfile, rolesencoding forrun a- userRun acrossactions projects.from Bya defaultfile allor projectsstandard willinput. be included.Required Requires JIRA 7.0parameters: file or higher.standard Useinput a regexOptional patternparameters: tocommon, subsetcontinue, projectssimulate, toclearFileBeforeAppend, 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 displayencoding, findReplace, findReplaceRegex runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input Required parameters: sql or file or standard input Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromCsv - Run actions generated from a CSV file. Required parameters: userIdfile Optional parameters: regex common, propertyFile, continue, filequiet, appendsimulate, columnsclearFileBeforeAppend, encoding getIssueList, findReplace, findReplaceRegex runFromList - ListRun issuesactions for aeach JQLentry query,in filter, search or by projecta list. RequiredWhen parameters:file filteris orprovided, jqleach oraction searchin orthe projectfile augmented Optionalby parameters:the file,common dateFormat,parameter limit,will withId,be suppressId,run outputFormat,for columns, encoding, appendeach entry. Output formats: 1 - defaultOtherwise, 2just orthe 4action -specified customby fields,the 3common orparameter 4will -be securityrun. level, 5Available -replacement 4variables plusare time values, 101 - issue keys only, 998 - all except custom, 999 - all getIssueHistoryList - Get issue change historyentry, entry2. Required parameters: issuelist Optional parameters: list2, file, common, dateFormatcontinue, quiet, simulate, columnsclearFileBeforeAppend, encoding getAttachmentList, findReplace, findReplaceRegex runFromIssueList - ListRun attachmentsactions for aneach issue. from an issue list based on a filter or a search. Available replacement variables are project, issue, issueId. Required parameters: issue filter or jql or search or project Optional parameters: filecommon, continue, regexsimulate, dateFormatlimit, columnsclearFileBeforeAppend, encodingfindReplace, appendfindReplaceRegex, outputFormatfile, encoding OutputrunFromProjectList formats:- 1Run -actions default,for 999each -project allwith getCommentListoptional -filtering Listby oflead commentand informationregex (id, dates, ...) for an issue. Required parameters: issue on project key. Available replacement variables are project, projectId. Optional parameters: filelead, dateFormatregex, columnscommon, encodingcontinue, appendsimulate, limit, Output formats: 1 - default, 999clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromVersionList - allRun getWorkListactions -for Geteach listversion ofin a work log entry project. Available replacement variables are project, projectId, version, versionId. Required parameters: issueproject Optional parameters: dateFormatregex, common, filecontinue, columnssimulate, encodinglimit, appendclearFileBeforeAppend, outputFormatfindReplace, findReplaceRegex, Outputfile, formats:encoding 999runFromComponentList - all getVoterList - Get list of users that have voted for an issueRun actions for each component in a project. Available replacement variables are project, projectId, component, componentId. Required parameters: issueproject Optional parameters: appendregex, filecommon, columnscontinue, encodingsimulate, limit, Output formats: 1 - simple, 2clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromAttachmentList - CSVRun getWatcherListactions -for Geta list of users that attachments for an issue. Available replacement variables are watching an issueattachment, attachmentId. Required parameters: issue Optional parameters: appendcommon, continue, simulate, limit, fileregex, columnsclearFileBeforeAppend, encodingfindReplace, findReplaceRegex, Outputfile, formats:encoding 1runFromGroupList - simple,Run 2action -for CSVeach getLinkListgroup -with Listoptional issueregex linksfiltering foron angroup issuename. Available replacement Requiredvariable parameters:is issuegroup. Optional parameters: fileregex, columnslimit, encodingcontinue, appendsimulate, getLinkTypeListclearFileBeforeAppend, -findReplace, GetfindReplaceRegex, afile, listencoding ofrunFromCommentList all issue link types. Optional parameters: file, columns, encoding getCustomFieldList - Get information on all custom fields.- Run action for each comment for an issue with optional regex filtering on the comment body. Available replacement variable is commentId. Required parameters: issue Optional parameters: file regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, appendfindReplaceRegex, columnsfile, encoding getFieldListrunFromRemoteLinkList - GetRun informationaction onfor alleach fields.remote link Optionalfor parameters:an regex,issue file,with append,optional columns,filtering encodingdefined getWorkflowListthe -same Getas listfor ofgetRemoteLinkList. a workflowsRequired matchingparameters: selectionissue criteria. Optional parameters: limitlink, regex, dateFormatregex2, filetargetUser, appendtargetPassword, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, columnsfile, encoding getBoardListrunFromUserList - List Agile boardsRun action for each user with optionalsimilar filtering by regex on name. as getUserList. Available replacement variable is userId. Required parameters: group or name or project and role Optional parameters: regex, limit, includeInactive, continue, filesimulate, clearFileBeforeAppend, findReplace, appendfindReplaceRegex, columnsfile, encoding getIssueTypeListrunFromLinkList - List Run action for each issue types validlink for aan project.issue Ifor projectissues isselected blankby orJQL @all,including allfiltering issuejust typeslike willwith be listedgetLinkList. OptionalRequired parameters: projectissue or jql Optional parameters: limit, fileregex, columnsoptions, encodingcontinue, appendsimulate, getStatusListclearFileBeforeAppend, - List statuses. Optional parameters: findReplace, findReplaceRegex, file, encoding, getProjectList append- getTransitionListList -defined Getprojects availablewith workflowoptional transitionsfiltering forby anlead issue.and regex Requiredon parameters:project issuekey. Optional parameters: lead, regex, outputFormat, file, appendcolumns, encoding Output formats: 1 - basicdefault, 2 - fieldsschemes, getAvailableSteps999 - Deprecatedall getProjectCategoryList - getTransitionListList isdefined recommended. Get available workflow steps for issue. Required parameters: issue project categories. Optional parameters: file, append, columns, encoding getUserListgetVersionList - List usersversions defined fromfor a groupprojects. 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 searchesRequired parameters: project Optional parameters: regex, file, columns, encoding, append, outputFormat Output formats: 1 - default, 2 - description, 999 - all getComponentList - List components defined for a projects. Required parameters: project Optional parameters: limit, regex, file, columns, encoding, append, outputFormat Output formats: 1 - default, 2 - with project, 999 - all getSecurityLevelList - List security levels defined for a projects. Required parameters: group or name or project and role Optional parameters: limit, regex, includeInactive, file, columns, encoding, append, outputFormat Output formats: 1 - basic, 2 - extended attributesdefault, 999 - all getGroupListgetProjectRoleList - Get a list of groups with optional filtering by regex on group nameproject roles. Optional parameters: limitregex, regexfile, fileappend, encodingcolumns, appendencoding createProjectgetProjectRoleActorList - CreateGet ausers newand projectgroups with key provided byfor a project's parameterrole. Required parameters: project, leadrole Optional parameters: namefile, descriptioncolumns, url,encoding defaultAssignee,getProjectRoleByUserList lookup,- template,Get permissionScheme,project notificationScheme,roles issueSecurityScheme,for a workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category updateProject - Update project information. Scheme updates require compatible schemes. Required parameters: project Optional parameters: name, description, lead, url, defaultAssignee, permissionScheme, notificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category cloneProject - Create a new project as a clone of a base project (only issue security, notification, and permission schemes will be copied to clone, some other fields are also not available to be copied to the clone). 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 cloneduser 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. Required parameters: project, toProjectuserId Optional parameters: nameregex, descriptionfile, urlappend, permissionSchemecolumns, notificationScheme,encoding issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category, search, type, continue, copyVersions, copyComponents, copyRoleActors, cloneIssues, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix, jsp deleteProject - Delete a project. Use continue to ignore a not found error. Required parameters: project Optional parameters: continue getProject - Get project information. Required parameters: project Optional parameters: suppressId, file, encoding createBoard - Create an Agile board. Type is any support type like scrum, kanban, or diy. Project is a comma separated list of projects identified by key, name, or id. Required parameters: name, type, project deleteBoard - Delete an Agile board. Use continue to ignore not found errorsgetFilterList - 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. Optional parameters: favorite, regex, limit getIssueList - List issues for a JQL query, filter, search or by project. Required parameters: filter or jql or search or project Optional parameters: file, dateFormat, limit, withId, suppressId, outputFormat, columns, encoding, append Output formats: 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 getIssueHistoryList - Get issue change history. Required parameters: id or boardissue Optional parameters: continue createFilterfile, dateFormat, columns, encoding getAttachmentList - Create a filterList attachments for an issue. Required parameters: name, searchissue Optional parameters: description, favorite updateFilter - Update a filter by id or filter name (if it is a favorite filter) file, limit, regex, dateFormat, columns, encoding, append, outputFormat Output formats: 1 - default, 999 - all getCommentList - List of comment information for an issue with regex filtering on comment body. Required parameters: id of filterissue Optional parameters: namefile, searchregex, descriptionlimit, favoriteoutputFormat, getFilterdateFormat, -columns, Getencoding, informationappend about aOutput filterformats: by1 id- or filter name (if it is a favorite filter)default, 999 - all getWorkList - Get list of a work log entry. Required parameters: id or filter deleteFilter - Delete a filter by id or filter name (if it is a favorite filter). Use continue to ignore not found errorsissue Optional parameters: dateFormat, file, columns, encoding, append, outputFormat Output formats: 999 - all getVoterList - Get list of users that have voted for an issue. Required parameters: idissue or filter Optional parameters: continueoutputFormat, setShareScopeappend, -file, Setcolumns, currentencoding users defaultOutput shareformats: scope1 for- filters.simple, Valid2 values- areCSV, GLOBAL999 and- PRIVATE.all Required parameters: value getVersion getWatcherList - Get informationlist forof ausers projectthat versionare (sincewatching JIRAan 4issue.2). Required parameters: project, versionissue Optional parameters: outputFormat, dateFormatappend, file, columns, encoding addVersion Output formats: 1 - Add a new version to a project. Required parameters: project, version Optional parameters: description, after, date, startDate, dateFormat, replace updateVersion - Update version for a project. Required parameters: project, version Optional parameters: name, description, after, date, startDate, dateFormat, autoVersion copyVersion - Copy a version from one project to the same project or another projectsimple, 2 - CSV, 999 - all getLinkList - List issue links for an issue or issues selected by JQL. Filter by regex pattern matching link name or description. Setting options parameter to one of outward or inward will additionally filter by link direction. Required parameters: issue project,or versionjql Optional parameters: toProjectlimit, nameregex, descriptionoptions, afterfile, datecolumns, startDateencoding, dateFormat,append replacegetLinkTypeList copyVersions - CopyGet alla versionslist fromof oneall projectissue tolink another projecttypes. RequiredOptional parameters: projectfile, toProject Optional parameters: continuecolumns, replaceencoding deleteVersiongetCustomFieldList - DeleteGet ainformation versionon fromall acustom projectfields. Update affectsOptional andparameters: fixfile, versionsappend, forcolumns, issuesencoding bygetFieldList removing- versionGet referenceinformation on or swapping it with versions specifiedall fields. UseFilter continueby toid ignoreor version not found errorname regex. RequiredOptional parameters: projectregex, version Optional parameters: affectsVersionsfile, fixVersionsappend, autoVersioncolumns, continueencoding releaseVersiongetWorkflowList - Get list Releaseof a versionworkflows formatching aselection projectcriteria. Resets releaseOptional dateparameters: 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. Required parameters: project, versionlimit, regex, dateFormat, file, append, columns, encoding getBoardList - List Agile boards with optional filtering by regex on name. Optional parameters: regex, file, append, columns, encoding getIssueTypeList - List issue types valid for a project. If project is blank or @all, all issue types will be listed. Optional parameters: dateproject, dateFormatfile, continuecolumns, unreleaseVersionencoding, -append UnreleasegetStatusList a- versionList forstatuses ain project,their optionally reset release datecustomized order. UseIf continueproject tois ignorespecified, erroronly whenstatuses thefor versionvalid isfor alreadythe inproject thewill correctbe statelisted. RequiredOptional parameters: project, version Optional parameters: datefile, dateFormatencoding, continueappend archiveVersiongetTransitionList - ArchiveGet aavailable workflow versiontransitions for aan project. This hides the version from the UI. Use continue to ignore error when the version is already in the correct stateissue. Required parameters: issue Optional parameters: outputFormat, file, append, encoding Output formats: 1 - basic, 2 - fields getAvailableSteps - Deprecated - getTransitionList is recommended. Get available workflow steps for issue. Required parameters: project, versionissue Optional parameters: continue unarchiveVersion - Unarchivefile, append, encoding getUserList - List users from a versiongroup foror a project.search Thisby makesname thefragment version(userId, visibledisplay againname, in the UIand email). Use name of continue@all to ignoresearch errorfor whenall theusers. versionOr isuse alreadyproject inand therole correctto state.get all Requiredusers parameters:that project,are versionpart of Optionalthe parameters:role continuefor getComponentthe -project Getspecified. informationEmail foronly aworks componentif ofemail avisibiliity project.is on Requiredand parameters:for project,leading componentcharacters only. OptionalInclude parameters:inactive file,only encodingworks addComponentfor -user Add component to a projectname searches. Required parameters: group project, componentor name or project and role Optional parameters: descriptionlimit, leadregex, defaultAssigneeincludeInactive, replacefile, updateComponentcolumns, -encoding, Updateappend, componentoutputFormat for aOutput project.formats: 1 Required parameters: project- basic, component2 - Optional parameters: nameextended attributes, description,999 lead,- defaultAssigneeall deleteComponentgetGroupList - DeleteGet componenta fromlist aof project.groups Usewith continueoptional tofiltering ignoreby componentregex noton foundgroup errorname. RequiredOptional parameters: projectlimit, componentregex, file, Optionalencoding, parameters:append continuecreateProject copyComponent - CopyCreate a component from one new project with key provided by project toparameter. theTo sameshare projectsome or another project. Required parameters:all scheme configurations with an existing project, componentconsider using OptionalcloneProject parameters:or toProject,specifying toComponent,an name,existing description,project lead,on defaultAssignee,the replace copyComponents - Copy all or some components from one project to anothertemplate parameter. Required parameters: project, toProjectlead Optional parameters: componentsname, replacedescription, addProjectRoleActorsurl, -defaultAssignee, Addlookup, userstemplate, orpermissionScheme, groupsnotificationScheme, toissueSecurityScheme, a project role. workflowScheme, Required parameters: projectissueTypeScheme, issueTypeScreenScheme, rolefieldConfigurationScheme, userIdcategory orupdateProject group copyProjectRoleActors - CopyUpdate allproject roleinformation. actorsScheme fromupdates arequire project to another projectcompatible schemes. Required parameters: project, toProject Optional parameters: continuename, removeProjectRoleActorsdescription, -lead, Removeurl, usersdefaultAssignee, or groupspermissionScheme, fromnotificationScheme, aissueSecurityScheme, projectworkflowScheme, role. Required parameters: projectissueTypeScheme, issueTypeScreenScheme, rolefieldConfigurationScheme, userIdcategory orcloneProject group addCustomField - AddCreate a new customproject field.as Typea mustclone beof a validbase customproject field(only typeissue key.security, Optionallynotification, searchand canpermission beschemes awill validbe searchcopied template key. Required parameters: fieldto clone, typesome other Optionalfields parameters:are description,also searchnot removeCustomFieldavailable -to Removebe acopied customto fieldthe by name or id. Use continue to ignore a not defined error. Required parameters: field Optional parameters: continue createIssue - Create a new issue or subtask for a projectclone). 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. Required parameters: project, typetoProject Optional parameters: summaryname, parentdescription, referenceurl, prioritypermissionScheme, reporternotificationScheme, assigneeissueSecurityScheme, description workflowScheme, componentsissueTypeScheme, affectsVersionsissueTypeScreenScheme, fixVersionsfieldConfigurationScheme, environmentcategory, securitysearch, fieldtype, valuecontinue, valuescopyVersions, field2autoVersion, values2copyComponents, asVersionautoComponent, asComponentcopyRoleActors, asCascadeSelectcloneIssues, lookup, datecopyLinks, dateFormatcopyAttachments, customcopyComments, autoVersioncopyWatchers, autoComponentcopySubtasks, copySubtaskEstimates, estimateuseParentVersions, originalEstimate, commentfieldExcludes, group, role, labels, findReplace, findReplaceRegex, file, encoding, deleteIssue propertyPrefix deleteProject - Delete ana issueproject. Use continue to ignore errora ifnot thefound issueerror. does not exist. Required parameters: issueproject Optional parameters: continue cloneIssuegetProject - CreateGet aproject newinformation. issue byRequired copyingparameters: anproject existing issue.Optional Someparameters: advancedsuppressId, optionsfile, requireencoding ClonecreateBoard Plus- forCreate JIRAan beAgile installedboard. [CLIType Issueis Cloning]any hassupport moretype details.like scrum, Requiredkanban, parameters:or issuediy. Project Optionalis parameters:a type,comma summary,separated resolution,list labels,of projects comment,identified group,by rolekey, priorityname, 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 - Clone issues returned from a JQL search. Advanced options require the Clone Plus for JIRA be installed. [CLI Issue Cloning] has more details. or id. Required parameters: name, type, project deleteBoard - Delete an Agile board. Use continue to ignore not found errors. Required parameters: id or board Optional parameters: continue createFilter - Create a filter. Required parameters: name, search Optional parameters: description, favorite updateFilter - Update a filter by id or filter name (if it is a favorite filter). Required parameters: jqlid of filter Optional parameters: projectname, typesearch, continuedescription, favorite copyLinks,getFilter copyAttachments,- copyComments,Get copyWatchers,information copySubtasks,about copySubtaskEstimates,a useParentVersions,filter by autoVersion,id autoComponent,or fieldExcludes,filter propertyPrefix,name jsp(if updateIssueit -is Updatea an existing issuefavorite filter). Use appendTextRequired toparameters: appendid theor parameterfilter valuedeleteFilter to- forDelete thea descriptionfilter andby environmentid fields.or Usefilter appendname to(if modifyit theis fixa versionsfavorite orfilter). affectsUse versionscontinue fieldsto byignore theirnot respectivefound valueserrors. Required parameters: id issueor filter Optional parameters: 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, continue, comment, group, role, , findReplace, findReplaceRegex, file, encoding, updateOrCreateIssue - Experimental. Search for an issue using JQL. If a single issue is found, update it. If no issue is found, create it continue setShareScope - Set current users default share scope for filters. Valid values are GLOBAL and PRIVATE. Required parameters: value getVersion - Get information for a project version (since JIRA 4.2). Required parameters: project, version Optional parameters: dateFormat, file, encoding addVersion - Add a new version to a project. Required parameters: project, version Optional parameters: description, after, date, startDate, dateFormat, replace updateVersion - Update version for a project. Required parameters: jqlproject, version Optional parameters: typename, summarydescription, resolutionafter, labelsdate, prioritystartDate, reporterdateFormat, assignee,autoVersion description,copyVersion components,- affectsVersions,Copy fixVersions,a environment,version from security,one field,project value,to values,the field2,same values2,project asVersion,or asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, , estimate, originalEstimate, append, appendText, continue, comment, group, role, , findReplace, findReplaceRegex, file, encoding, getIssue - Get information about an existing issueanother project. Required parameters: project, version Optional parameters: toProject, name, description, after, date, startDate, dateFormat, replace copyVersions - Copy all versions from one project to another project. Required parameters: issueproject, toProject Optional parameters: filecontinue, dateFormat,replace asVersion,deleteVersion suppressId,- encodingDelete a Outputversion formats:from 1a -project. default,Update 999affects -and allfix assignIssueversions -for Assignissues anby isssueremoving toversion areference userId. Useor @defaultswapping forit userIdwith toversions setspecified. theUse assigneecontinue to theignore projectversion default.not Usefound blankerror. to setRequired theparameters: assigneeproject, toversion null. RequiredOptional parameters: issue affectsVersions, fixVersions, autoVersion, userIdcontinue transitionIssuereleaseVersion - Release Transitiona version issuefor througha workflowproject. Resets Requiredrelease parameters:date issue, transition, continue Optional parameters: type, summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, 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. Required parameters: project, version Optional parameters: date, dateFormat, custom, autoVersion, autoComponent, comment, group, role, , findReplace, findReplaceRegex, file, encoding, progressIssue - Progress (transition) issue through workflow. Deprecated in favor of transitionIssue which uses better terminologydescription, continue unreleaseVersion - Unrelease a version for a project, optionally reset release date. Use continue to ignore error when the version is already in the correct state. Required parameters: project, version Optional parameters: date, dateFormat, description, continue archiveVersion - Archive a version for a project. This hides the version from the UI. Use continue to ignore error when the version is already in the correct state. Required parameters: project, version Optional parameters: description, continue unarchiveVersion - Unarchive a version for a project. This makes the version visible again in the UI. Use continue to ignore error when the version is already in the correct state. Required parameters: project, version Optional parameters: description, continue getComponent - Get information for a component of a project. Required parameters: project, component Optional parameters: file, encoding addComponent - Add component to a project. Required parameters: project, component Optional parameters: description, lead, defaultAssignee, replace updateComponent - Update component for a project. Required parameters: project, component Optional parameters: name, description, lead, defaultAssignee deleteComponent - Delete component from a project. Use continue to ignore component not found error. Required parameters: project, component Optional parameters: continue copyComponent - Copy a component from one project to the same project or another project. Required parameters: project, component Optional parameters: toProject, toComponent, name, description, lead, defaultAssignee, replace copyComponents - Copy all or some components from one project to another. Required parameters: project, toProject Optional parameters: components, replace addProjectRoleActors - Add users or groups to a project role. Required parameters: project, role, userId or group copyProjectRoleActors - Copy all role actors from a project to another project. Required parameters: project, toProject Optional parameters: continue removeProjectRoleActors - Remove users or groups from a project role. Required parameters: project, role, userId or group addCustomField - Add a new custom field. Type must be a valid custom field type key. Optionally, search can be a valid search template key. Required parameters: field, type Optional parameters: description, search removeCustomField - Remove a custom field by name or id. Use continue to ignore a not defined error. Required parameters: field Optional parameters: continue createIssue - Create a new issue for a project or a subtask of a parent issue. Required parameters: issueType or type, project or parent Optional parameters: 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 deleteIssue - Delete an issue. Use continue to ignore error if the issue does not exist. Required parameters: issue Optional parameters: continue cloneIssue - Create a new issue by copying an existing issue. By default, if the issue is a subtask, it will be cloned to the same parent. Specifying the parent parameter will allow a subtask to be cloned to a different parent. Required parameters: issue Optional parameters: 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 cloneIssues - Clone issues returned from a JQL search. [CLI Issue Cloning] has more details. Required parameters: jql Optional parameters: toProject, issueType or type, continue, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, autoVersion, autoComponent, fieldExcludes, propertyPrefix updateIssue - Update an existing issue. Use appendText to append the parameter value to for the description and environment fields. Use append to modify the fix versions or affects versions fields by their respective values. Required parameters: issue Optional parameters: 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 createOrUpdateIssue - Search for an issue using JQL. If a single issue is found, update it. If no issue is found, create it. Formerly known as updateOrCreateIssue (deprecated). Required parameters: jql, issueType or type, project or parent Optional parameters: 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 createOrUpdateIssue - Search for an issue using JQL. If a single issue is found, update it. If no issue is found, create it. Formerly known as updateOrCreateIssue (deprecated). Required parameters: jql, issueType or type, project or parent Optional parameters: 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 getIssue - Get information about an existing issue. Required parameters: issue Optional parameters: file, dateFormat, suppressId, encoding Output formats: 1 - default, 999 - all assignIssue - Assign an isssue to a userId. Use @default for userId to set the assignee to the project default. Use blank to set the assignee to null. Required parameters: issue, userId transitionIssue - Transition issue through workflow. Required parameters: issue, transition, continue Optional parameters: 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 progressIssue - Progress (transition) issue through workflow. Deprecated in favor of transitionIssue which uses better terminology Required parameters: issue, step Optional parameters: 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 addComment - Add a comment to an issue. Required parameters: issue Optional parameters: comment, group, role, findReplace, findReplaceRegex, file, encoding, dateFormat removeComment - Remove a comment by id from an issue. Required parameters: issue, id getComment - Get comment information. Required parameters: issue, id Optional parameters: dateFormat, file, append, encoding updateComment - Update an existing comment to an issue. Use <at:var at:name="commentBody" /> replacement variable if needed when replacing the comment body. Required parameters: issue Optional parameters: comment, group, role, findReplace, findReplaceRegex, file, encoding getComments - Get a formatted string of all comment text for an issue. Required parameters: issue Optional parameters: file, dateFormat, encoding addLabels - Add labels to an issue. Requires labels are available for edit on the issue screen. Required parameters: issue, labels Optional parameters: suppressNotify removeLabels - Remove labels from an issue. Requires labels are available for edit on the issue screen. Required parameters: issue, labels Optional parameters: suppressNotify getFieldValue - Get field value for an issue. Required parameters: issue, field Optional parameters: file, dateFormat, reference, withId, suppressId, encoding setFieldValue - Set field value for an issue. Use appendText to append the value to text field. Use append or subtact to have an array field modified by taking the current value and adding or removing the value specified. Required parameters: issue, field, file or value or values Optional parameters: field2, values2, suppressNotify, appendText, append, subtract, encoding, dateFormat modifyFieldValue - Modify the current field value for an issue with find replace logic. Required parameters: issue, field, findReplace or findReplaceRegex Optional parameters: dateFormat, autoVersion, autoComponent, suppressNotify copyFieldValue - Copy field value from an issue to a field of another issue. Warning: only works for fields that can be updated from their text representation. Required parameters: issue, field, toIssue or field2 Optional parameters: suppressNotify, append, appendText, encoding, dateFormat addAttachment - Add an attachment to an issue. Required parameters: issue, file Optional parameters: findReplace, findReplaceRegex, name, encoding addAttachments - Add multiple attachments to an issue from files in a directory matching a regex pattern. Required parameters: issue, file Optional parameters: recursive, regex, findReplace, findReplaceRegex, name, encoding getAttachment - Get lastest attachment by name or id for an issue. Required parameters: issue, file Optional parameters: name, encoding removeAttachment - Remove an attachment from an issue. A single attachment is removed by id or all attachments matching the file name. Required parameters: issue, name or id copyAttachments - Copy attachments from an issue to another issue. Required parameters: issue, toIssue Optional parameters: name, regex addWatchers - Add watchers to an issue. A comma separated list of user ids can be specified. Required parameters: issue Optional parameters: userId, lookup, continue removeWatchers - Remove watchers from an issue. A comma separated list of user ids can be specified. Required parameters: issue Optional parameters: userId, lookup, continue addVote - Add vote for issue. Required parameters: issue removeVote - Remove vote from issue. Required parameters: issue addWork - Add work log entry. Required parameters: issue, timeSpent Optional parameters: comment, date, dateFormat, estimate, role, group, autoAdjust removeWork - Remove work log entry. Required parameters: id updateWork - Update work log entry. Required parameters: id, issue Optional parameters: timeSpent, comment, date, dateFormat, estimate, role, group, autoAdjust linkIssue - Link an issue to another issue. Required parameters: issue, toIssue, link Optional parameters: comment, group, role, deleteLink - Remove link to another issue. Required parameters: issue, toIssue, link getUser - Get user information. When name is used, the name search must return a single user. Required parameters: userId or userKey or name Optional parameters: file, endcoding addUser - Add a new user. Specify notify to send an email. Required parameters: userId, userEmail Optional parameters: userFullName, userPassword, notify, preserveCase addUserWithFile - Add users from comma separated file. Deprecated - use runFromCsv support with addUser instead. Required parameters: file Optional parameters: notify, preserveCase, encoding updateUser - Update user information or status. Required parameters: userId or userKey Optional parameters: userFullName, userEmail, newUserId, activate, deactivate removeUser - Remove a user. Required parameters: userId removeUserWithFile - Remove users from comma separate file. Deprecated - use runFromCsv support with removeUser instead. Required parameters: file Optional parameters: encoding addGroup - Add a new group. Required parameters: group Optional parameters: preserveCase removeGroup - Remove a group. Required parameters: group Optional parameters: defaultGroup addUserToGroup - Add user to a group. Required parameters: issueuserId, stepgroup Optional parameters: 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, addComment - Add a comment to an issueautoGroup, preserveCase addUserToGroupWithFile - Add users to groups from comma separated file. Deprecated - use runFromCsv support with addUserToGroup instead. Required parameters: file Optional parameters: autoGroup, preserveCase, encoding removeUserFromGroup - Remove user from a group. Required parameters: userId, group removeUserFromGroupWithFile - Remove users from groups from comma separated file. Deprecated - use runFromCsv support with removeUserFromGroup instead. Required parameters: issuefile Optional parameters: comment, group, role, , findReplace, findReplaceRegex, file, encoding, updateUserProperty getComments - GetAdd aor formattedupdate stringa of all comment text for an issueuser's property. Required parameters: issueuserId, name, value Optional parameters: file, dateFormat, encoding addLabels - Add labels to an issue. Requires labels are available for edit on the issue screenlookup removeUserProperty - Remove a user's property. Required parameters: userId, name Optional parameters: lookup getWorkflow - Get workflow information. Required parameters: issue,workflow labels removeLabelsOptional -parameters: RemovedateFormat, labelsfile, fromencoding animportWorkflow issue.- RequiresImport labelsworkflow arefrom availableXML. for editRequired onparameters: theworkflow, issuefile screen. RequiredOptional parameters: issuedescription, labelsfindReplace, getFieldValuefindReplaceRegex, -encoding GetexportWorkflow field- valueExport forworkflow anto issueXML. Required parameters: issue,workflow field Optional parameters: file, dateFormat, asVersion, withId, suppressId, encoding setFieldValuedeleteWorkflow - SetDelete customan field value for an issueinactive workflow. UseInactive appendTextmeans toit appendis thenot valueassociated towith textany fieldproject. Use append or subtact to have an array field modified by taking the current value and adding or removing the value specified. Required parameters: issue, field, file or value or valuesRequired parameters: workflow Optional parameters: continue runFromWorkflowList - Run action for each workflow with regex filtering on workflow name. Available replacement variable is workflow. Optional parameters: field2regex, values2limit, asVersioncontinue, asComponentsimulate, asCascadeSelectclearFileBeforeAppend, appendTextfindReplace, appendfindReplaceRegex, subtractfile, encoding, dateFormatcopyWorkflow copyFieldValue - Copy a workflow fieldto valuea fromnew anworkflow issuewith tothe aname customprovided fieldby ofthe anothername issueparameter. Required Warning: only works for fields that can be updated from their text representation. Required parameters: issue, field, toIssue or field2 Optional parameters: asVersion, asComponent, asCascadeSelect, append, appendText, encoding, dateFormat addAttachment - Add an attachment to an issueparameters: workflow, name Optional parameters: description addTransition - Add a transition to a workflow. Use name for the transition name. Step represents the source step and transition the target step which defaults to step. Transition screen defaults to none. Required parameters: issueworkflow, name, filestep Optional parameters: findReplacedescription, findReplaceRegextransition, name,screen encodingaddTransitionFunction getAttachment- -Add Geta lastesttransition attachmentfunction by(post namefunction or idvalidator fortype) anto issue.a workflow Requiredtransition. parameters: issue,Function fileconfiguration is Optional parameters: name, encoding removeAttachment - Remove an attachment from an issue. A single attachment is removed by id or all attachments matching the file namejust field/values pairs and is provided using the same parameters as for setting custom field configuration - custom and related parameters. Required parameters: issueworkflow, nametransition, orstep, idfunctionKey addWatchers -Optional Addparameters: watcherstype, tocustom, an issue. A comma separated list of user ids can be specifiedfield, values, field2, values2 associateWorkflow - Associate workflow to a workflow scheme. Required parameters: issue Optional parameters: userId, lookup, continue removeWatchers - Remove watchers from an issue. A comma separated list of user ids can be specifiedname, workflowScheme createWorkflowScheme - Create a workflow scheme using a default workflow. Required parameters: name, workflow Optional parameters: description getWorkflowScheme - Get workflow scheme information. Required parameters: issuename Optional parameters: userIdfile, lookup,encoding continuedeleteWorkflowScheme addVote- -Delete Addan voteinactive forworkflow issuescheme. Required parameters: issueid removeVoteor - Remove vote from issue. name RequiredOptional parameters: issuecontinue addWorkgetWorkflowSchemeList - AddGet worklist logof entry.a workflow Requiredschemes parameters:matching issue,selection timeSpentcriteria. Optional parameters: commentlimit, dateregex, dateFormatfile, estimateappend, rolecolumns, group, autoAdjust removeWork - Remove work log entry. Required parameters: id updateWork - Update work log entry. Required parameters: id, issueencoding Output formats: 1 - basic, 2 - detail runFromWorkflowSchemeList - Run action for each workflow scheme with regex filtering on workflow scheme name. Available replacement variables are scheme and schemeId. Optional parameters: timeSpentregex, limit, commentcontinue, datesimulate, dateFormatclearFileBeforeAppend, estimatefindReplace, rolefindReplaceRegex, groupfile, autoAdjustencoding linkIssuegetScreenList - LinkGet ana issuelist toof anotherscreens issue.with optional Requiredregex parameters:filtering issue, toIssue, linkon name. Optional parameters: commentregex, grouplimit, role, deleteLink - Remove link to another issue. Required parameters: issue, toIssue, link getUser - Get user information. When name is used, the name search must return a single user. Required parameters: userId or userKey or namefile, encoding, append, clearFileBeforeAppend getScreenSchemeList - Get a list of screen schemes with optional regex filtering on name. Optional parameters: regex, limit, file, endcoding addUserencoding, append, clearFileBeforeAppend getIssueTypeScreenSchemeList - AddGet a new user. Prior to JIRA 7.0, an email is automatically sent to the user. For JIRA 7.0 and higher, specify notify to send an email. Required parameters: userId, userEmaillist of issue type screen schemes with optional regex filtering on name. Optional parameters: regex, limit, file, encoding, append, clearFileBeforeAppend getIssueTypeSchemeList - Get a list of issue type schemes with optional regex filtering on name. Optional parameters: userFullNameregex, userPasswordlimit, notifyfile, preserveCaseencoding, addUserWithFileappend, -clearFileBeforeAppend AddgetFieldConfigurationSchemeList users- fromGet commaa separated file. Deprecated - use runFromCsv supportlist of field configuration schemes with addUseroptional instead.regex filtering Requiredon parameters:name. file Optional parameters: notifyregex, limit, preserveCasefile, encoding updateUser, append, clearFileBeforeAppend getFieldConfigurationList - Update user information. Required parameters: userId or userKeyGet a list of field configurations with optional regex filtering on name. Optional parameters: regex, userFullNamelimit, userEmailfile, newUserIdencoding, activateappend, deactivateclearFileBeforeAppend removeUsergetPermissionSchemeList - RemoveGet a userlist of permission schemes with optional regex filtering on name. RequiredOptional parameters: userId removeUserWithFile - Remove users from comma separate file. Deprecated - use runFromCsv support with removeUser instead. Required parameters: file Optional parameters: encoding addGroup - Add a new group. Required parameters: group Optional parameters: preserveCase removeGroup - Remove a group. Required parameters: group Optional parameters: defaultGroup addUserToGroup - Add user to a group. Required parameters: userId, group Optional parameters: autoGroup, preserveCase addUserToGroupWithFile - Add users to groups from comma separated file. Deprecated - use runFromCsv support with addUserToGroup instead. Required parameters: file regex, limit, file, encoding, append, clearFileBeforeAppend getNotificationSchemeList - Get a list of notification schemes with optional regex filtering on name. Optional parameters: regex, limit, file, encoding, append, clearFileBeforeAppend getIssueSecuritySchemeList - Get a list of issue security schemes with optional regex filtering on name. Optional parameters: regex, limit, file, encoding, append, clearFileBeforeAppend runFromScreenList - Run action for each screen with optional regex filtering on name. Available replacement variables are screen and screenId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromScreenSchemeList - Run action for each screen scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: autoGroupregex, preserveCaselimit, encodingcontinue, removeUserFromGroupsimulate, -clearFileBeforeAppend, RemovefindReplace, userfindReplaceRegex, fromfile, aencoding group.runFromIssueTypeScreenSchemeList - RequiredRun parameters:action userId,for groupeach removeUserFromGroupWithFileissue -type Removescreen usersscheme fromwith groupsoptional fromregex commafiltering separatedon filename. DeprecatedAvailable -replacement usevariables runFromCsvare supportscheme withand removeUserFromGroup insteadschemeId. Required parameters: file Optional parameters: encoding updateUserProperty - Add or update a user's property. Required parameters: userId, name, value Optional parameters: lookup removeUserProperty - Remove a user's property. Required parameters: userId, name Optional parameters: lookup getWorkflow - Get workflow information. Required parameters: name Optional parameters: dateFormat, file, encoding importWorkflow - Import workflow from XML. Required parameters: name, file Optional parameters: description, findReplace, findReplaceRegex, encoding exportWorkflow - Export workflow to XML. Required parameters: name Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromIssueTypeSchemeList - Run action for each issue type scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromFieldConfigurationSchemeList - Run action for each field configuration scheme with optional regex filtering on name. Available replacement variables are fieldConfiguration and fieldConfigurationId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromFieldConfigurationList - Run action for each field configuration with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding deleteWorkflowrunFromPermissionSchemeList - Delete an inactive workflow. Inactive means it is not associated with any project. Required parameters: nameRun action for each permission scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue runFromWorkflowList, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromNotificationSchemeList - Run action for each workflownotification scheme with optional regex filtering on workflow name. Available replacement variables variableare scheme isand workflowschemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueSecuritySchemeList associateWorkflow- -Run Associateaction workflowfor toeach aissue workflowsecurity scheme. with Requiredoptional parameters:regex name,filtering workflowSchemeon createWorkflowSchemename. -Available Createreplacement avariables workfloware scheme using a default workflowand schemeId. RequiredOptional parameters: name regex, limit, continue, simulate, workflowclearFileBeforeAppend, findReplace, Optional parameters: description getWorkflowSchemefindReplaceRegex, file, encoding deleteScreen - GetDelete a workflowscreen schemeby informationid. Required parameters: nameid Optional parameters: file, encoding deleteWorkflowSchemecontinue deleteScreenScheme - Delete ana screen inactivescheme workflowby schemeid. Required parameters: nameid Optional parameters: continue getWorkflowSchemeListdeleteIssueTypeScreenScheme - GetDelete listan ofissue atype workflowscreen schemesscheme matchingby selection criteriaid. OptionalRequired parameters: limit,id regex, file, append, columns, encoding runFromWorkflowSchemeList - Run action for each workflow scheme with regex filtering on workflow scheme name. Available replacement variable is workflowScheme. Optional parameters: continue deleteIssueTypeScheme - Delete an issue type scheme by id. Required parameters: id Optional parameters: regex, limit, continue, simulate,deleteFieldConfiguration clearFileBeforeAppend,- findReplace,Delete findReplaceRegex,a file,field encoding,configuration by runFromScreenListid. - RunRequired actionparameters: forid each screen with optional regex filtering on name. Available replacement variables are screenId and screenName. JIRA 6.4 and higher.Optional parameters: continue deleteFieldConfigurationScheme - Delete a field configuration scheme by id. Required parameters: id Optional parameters: continue regex,deletePermissionScheme limit,- continue,Delete simulate,a clearFileBeforeAppend,permission findReplace,scheme findReplaceRegex, file, encoding, runFromScreenSchemeList - Run action for each screen scheme with optional regex filtering on name. Available replacement variables are schemeId and schemeName. JIRA 6.4 and higher. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueTypeScreenSchemeList - Run action for each issue type screen scheme with optional regex filtering on name. Available replacement variables are schemeId and schemeName. JIRA 6.4 and higher. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueTypeSchemeList - Run action for each issue type scheme with optional regex filtering on name. Available replacement variables are schemeId and schemeName. JIRA 6.4 and higher. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, deleteScreen - Delete a screen id JIRA 6.4 and higher. Required parameters: id Optional parameters: continue deleteScreenScheme - Delete a screen scheme by id JIRA 6.4 and higher onlyby id. Required parameters: id Optional parameters: continue deleteNotificationScheme - Delete a permission scheme by id. Required parameters: id Optional parameters: continue deleteIssueSecurityScheme - Delete an issue security scheme by id. Required parameters: id Optional parameters: continue addRemoteLink - Add a remote link to an issue. Name is used instead of title from the UI. Specify a reverseLink value to have a reverse link added where supported. Required parameters: issue, name or link Optional parameters: url, toIssue, reverseLink, targetServer, targetUser, targetPassword removeRemoteLink - Remove a remote link to an issue. Name can be an numeric id, global link id, or a name. Required parameters: issue, name getRemoteLinkList - Get list of a remote links for an issue with optional regex filtering on the name or global id. Also filter by a specific link description if needed using link parameter. If specified, regex2 filtering will be appied to the application type specific information column. Required parameters: idissue Optional parameters: continue deleteIssueTypeScreenScheme - Delete an issue type screen scheme by id JIRA 6.4 and higher. Required parameters: id Optional parameters: continue deleteIssueTypeScheme - Delete an issue type scheme by id JIRA 6.4 and higher. Required parameters: id Optional parameters: continue link, limit, regex, regex2, targetUser, targetPassword, outputFormat, file, append, columns, encoding Output formats: 1 - basic, 999 - all getApplicationLinkList - Get list of a application links with optional filtering on application type and regex filtering on the name or url. Example types: jira, confluence. Optional parameters: type, limit, regex, file, append, columns, encoding exportSite - Create a site export. For server, data is put into a file in the JIRA home/export directory. For Cloud, data is put into a JIRA defined file on the associated webdav server - the file can optionally be copied to a local file if the file parameter is specified and permissions allow. Also for Cloud only, use the exportAttachments parameter to request the export contain attachments and similar data. Optional parameters: file, exportAttachments restoreExport - Restore export from file in the JIRA home/import directory. Required parameters: file exportData - Experimental - export project or issue participant data in a CLI compatible format. Required parameters: project or search Optional parameters: file, exportType, dateFormat, encoding, search, limit |