...
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|--loginFromStandardInput] -cookies <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] [--copyLinksexportAttachments] [--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 Property file with mapping information. [--common <common>] default, lib/jdbc is used to automatically load database drivers. Otherwise you can 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 expressionrows. Comma separated list of colon separated pairs. Single quote values [--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>] Comma separated list of entries to Projectpopulate name,the key,entry orreplacement id.variable on runFromList. Single [--toProject <toProject>] 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. [--boardappend] <board>] Append Agilevalues boardto name.existing values for [--issue <issue>] Issue key or id.version fields, components field, and custom fields supporting multiple values. For [--toIssue <toIssue>] Link destination issue key or id some actions using the file parameter, append will append output to the existing file. [--parent <parent>clearFileBeforeAppend] ParentFor issuerun keyactions, orthis id.option will automatically clear [--summary <summary>] an existing file on the first append requested. Summary of issue. (-s|--server) <server> [--priority <priority>] Server URL. Normally the base IssueURL priorityof -the nameserver orand id.the same as how [--reporter <reporter>] the server is accessed from a browser. Issue reporter user id.(-u|--user) <user> [--assignee <assignee>] User name for remote access. (default: automation) Issue assignee user id. In some contexts, use -1 for automatic assignment and "" for unassigned (-p|--password) <password> User password for remote access. [--securityapi <security><api>] Issue security level name or idAPI version. Some requests produce [--environment <environment>] Issue environment. [--component <component>different results based on the api version used. (default: latest) [--service <service>] ProjectService componentaddress name or id.extension. (default: /rest/api) [--toComponentcookies <toComponent><cookies>] ProjectName component name or id. [--components <components>] of file to 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>] AffectsProject versionsname, -key, commaor separatedid namesto orcopy idsto. For cloning [--fixVersions <fixVersions>] issues, either toProject or project can be used. [--name <name>] Fix versions - comma separated names or idsName. [--customdescription <custom><description>] CustomDescription. fields - comma separated key:value pairs. Key can be field name or [--lead <lead>] Project lead user id. Single quote the key:value pair if it contains [--defaultAssignee <defaultAssignee>] Project or compnent adefault commaassignee (,) or line breaks. [--field <field>] for issues. For projects, default is unassigned with options: PROJECT_LEAD or Field name orUNASSIGNED id(blank). For some actions, this parameter must be a custom fieldcomponents, default is PROJECT_DEFAULT with options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or UNASSIGNED (blank). [--field2after <field2><after>] FieldVersion name or id to foradd a customversion fieldafter. Defaults to after [--fieldExcludes <fieldExcludes>] Fields to exclude from cloning - comma separated list of fieldslast version. Use -1 to make it the first version. [--dateboard <date><board>] ReleaseAgile date for version or due date for issueboard name. [--startDateissue <startDate><issue>] DateIssue versionkey wasor startedid. [--typetoIssue <type><toIssue>] Issue type - name Target or id.link Also,destination contentissue typekey foror renderRequestid. [--resolutionparent <resolution><parent>] ResolutionParent issue namekey or id. [--labelssummary <labels><summary>] LabelsSummary orof tagsissue. A blank separated list. [--workflowpriority <workflow><priority>] WorkflowIssue priority - name or id. [--transitionreporter <transition><reporter>] WorkflowIssue transitionreporter -user name or id. [--stepassignee <step><assignee>] Deprecated.Issue Nowassignee calleduser transitionid. In some contexts, [use --comment1 <comment>]for automatic assignment and Comment "" for an issueunassigned. [--filtersecurity <filter><security>] FilterIssue idsecurity orlevel favorite filter name. Use for getIssueList is deprecatedor id. Use JQL instead. [--jqlenvironment <jql><environment>] JQLIssue queryenvironment. Alternate way to search for issues for getIssueList and runFromIssueList - continue to use search parameter for [--component <component>] Project component name or id. [--toComponent <toComponent>] compatibility with previous. [--search <search>] Project component name or id. [--components <components>] Search JQL query using legacy support. Deprecated.Project Usecomponents jql- parametercomma insteadseparated fornames newor supportids. [--regexversion <regex><version>] Project Regularversion name expressionor forid includingor matchingadd-on contentversion. For example, used to subset projects or versions on getProjectList and runFromVersionList [--affectsVersions <affectsVersions>] Affects versions - comma separated names or ids. [--referencefixVersions <reference><fixVersions>] ReferenceFix toversions a- replacementcomma keyseparated valuenames used to remember last created issue keyor ids. [--linkcustom <link><custom>] LinkA description.Therelist are release level API differences on whether the link should be specified as the link type name (likeof custom field key:value pairs. Normally a comma separated list of colon separated pairs. Key can be field name or 'relates') orid. Single quote the directedkey:value namepair (likeif 'relates to'). On later releases (JIRA 5.0+), link type name is the best choice. Theit contains a comma (,) or line breaks and similarly for the colon separator. An alternative is link id can also be used for both linkIssue and deleteLinkto use a JSON formatted string to represent the list of key:value pairs. [--valuefield <value><field>] SingleField fieldname or property value id. For some actions, this parameter must be a custom field. [--valuesfield2 <values><field2>] CommaField separatedname listor ofid fieldfor values.a Single quote values containing commascustom field. [--values2fieldExcludes <values2><fieldExcludes>] CommaFields separatedto listexclude offrom fieldcloning values.- Singlecomma quoteseparated valueslist containingof commasfields. [--timeSpentdate <timeSpent><date>] TimeRelease date spentfor onversion workor using.due Example:date 3hfor 30missue. [--estimatestartDate <estimate><startDate>] EstimateDate ofversion time remaining for an issue. Example: 3h 30mwas started. [--originalEstimateissueType <originalEstimate><issueType>] OriginalIssue estimatetype of- time to complete work for an issue. Example: 3h 30m.name or id. [--type <type>] [--id <id>] Issue type (alternative to issueType), custom field type, Numericlink idtype, oftransition anfunction item.type, application link type, [--propertyPrefix <propertyPrefix>] project type, Prefixboard usedtype, forand accessingcontent propertiestype for custom clone actionsrenderRequest. [--jspresolution <jsp><resolution>] CustomResolution JSP name for clone actions. Deprecatedor id. [--requestlabels <request><labels>] URL fragment for a requestLabels or tags. A blank separated list. [--requestParametersworkflow <requestParameters><workflow>] URLWorkflow request parametersname. [--requestTypetransition <requestType><transition>] TypeWorkflow oftransition a render request like GET- name or POSTid. (default: GET) [--acceptTypestep <acceptType><step>] ContentSource typestep to acceptname for renderRequest if different than typeaddTransition. [--limitscreen <limit><screen>] MaximumTransition number of entries to returnscreen name. (default: 2147483647) [--apifilter <api><filter>] APIFilter version.id Someor requestsfavorite producefilter differentname. resultsUse basedfor ongetIssueList theis apideprecated. versionUse used.JQL Deprecatedinstead. (default: latest) [--rolejql <role><jql>] UserJQL rolequery. inAlternate projectway to search for [--group <group>] Group nameissues for getIssueList and runFromIssueList - continue to use search parameter for compatibility with previous. [--defaultGroupsearch <defaultGroup><search>] Default group to transfer comment and worklog visibility settings to on removeGroupSearch JQL query using legacy support. Deprecated. Use jql parameter instead for new support. [--userIdregex <userId><regex>] UserRegular idexpression for userincluding management and other actionsmatching content. For some actionsexample, aused commato separatedsubset listprojects ofor ids.versions on getProjectList and [--newUserId <newUserId>] runFromVersionList. Used to assign a new user id to an existing user. Since JIRA 6.1. [--userKey <userKey>] Unique internal identifier for user management. Since JIRA 6.1. [--userFullName <userFullName>] User name for user management actions. [--userEmail <userEmail>][--regex2 <regex2>] Regular expression for secondary content matching. In some cases, filtering on a secondary field may be needed. [--link <link>] Link description. Usually link type name for local links and relationship description for remote links.The link id can also be Userused emailfor forboth userlinkIssue managementand actionsdeleteLink. [--userPasswordreverseLink <userPassword><reverseLink>] UserLink passworddescription for user management actionsthe (optional) reverse link for addRemoteLink. [--autoGroupvalue <value>] GroupsSingle arefield automaticallyor added when referenced in add user functionsproperty value. [--permissionSchemevalues <permissionScheme><values>] PermissionComma schemeseparated namelist orof field idvalues. Single (default:quote Defaultvalues Permissioncontaining Scheme)commas. [--notificationSchemevalues2 <notificationScheme><values2>] Comma separated list of field values. NotificationSingle schemequote namevalues orcontaining idcommas. [--issueSecuritySchemetimeSpent <issueSecurityScheme><timeSpent>] Time Issuespent on securitywork schemeusing. nameExample: or3h id30m. [--workflowSchemeestimate <workflowScheme><estimate>] WorkflowEstimate schemeof nametime orremaining id.for Usean blankissue. forExample: default3h scheme30m. [--issueTypeSchemeoriginalEstimate <issueTypeScheme><originalEstimate>] Original estimate Issueof typetime schemeto namecomplete orwork id.for Usean blankissue. forExample: default3h scheme30m. [--issueTypeScreenSchemeid <issueTypeScreenScheme><id>] IssueNumeric typeid screenof scheme name or idan item. Use blank for default scheme. JIRA 5.1 and later only.[--propertyPrefix <propertyPrefix>] [--fieldConfigurationScheme <fieldConfigurationScheme>] Field configuration scheme name or id. Use blank for default schemePrefix used for accessing properties for custom clone actions. Requires Clone Plus for JIRA be installed on the server. [--categoryrequest <category><request>] ProjectURL category.fragment Administratorfor access required to see or use project categoriesa request. [--templaterequestParameters <template><requestParameters>] ProjectURL template.request JIRAparameters 6.3or andpost abovedata.. Project template name to use (case sensitive) as found on the Create project dialog. If a template is not found, a list of valid templates will be shown in the error message[--requestType <requestType>] Type of a render request like GET or POST (default: GET) [--acceptType <acceptType>] Content type to accept for renderRequest if different than type. [--exportTypelimit <exportType><limit>] PROJECTMaximum tonumber exportof projectentries information, PARTICIPANTS to export issue participants. Use comman separated list if more than onereturn. (default: 2147483647) [--role <role>] User role in areproject needed. [--logingroup <login><group>] Login token from previous login requestGroup name. [--autoVersiondefaultGroup <defaultGroup>] AutomaticallyDefault addgroup versionsto usedtransfer in affectsVersionscomment and fixVersions parametersworklog visibility settings to on removeGroup. [--autoComponentuserId <userId>] User Automaticallyid addfor componentsuser usedmanagement inand componentsother parameteractions. For some [--autoAdjust] Auto adjust remaining estimate when adding work entryactions, a comma separated list of ids. [--asVersionnewUserId <newUserId>] InterpretUsed valuesto parameterassign asa versionnew valuesuser andid convert each to thean versionexisting iduser. [--asComponentuserKey <userKey>] InterpretUnique valuesinternal parameteridentifier asfor component values and convert each to the component iduser management. [--asCascadeSelectuserFullName <userFullName>] InterpretUser valuesname parameterfor asuser amanagement cascadeactions. select value ids. [--appendTextuserEmail <userEmail>] AppendUser text to existing value text email for description,user environment, and single and multi-value custom fieldsmanagement actions. [--subtractuserPassword <userPassword>] SubtractUser valuespassword fromfor existinguser values custom fields supporting multiple valuesmanagement actions. [--suppressIdautoGroup] SuppressGroups showingare anautomatically idadded when displayingreferenced issuein fieldsadd onuser getIssuefunctions. [--withIdpermissionScheme <permissionScheme>] DisplayPermission thescheme issue field value including the internal id (if the field has an internal value) using the following format:name or id. (default: Default Permission Scheme) [--notificationScheme <notificationScheme>] Notification scheme valuename (or id). [--copyLinksissueSecurityScheme <issueSecurityScheme>] CopyIssue issuesecurity linksscheme whenname cloningor anid issue. [--copyAttachmentsworkflowScheme <workflowScheme>] Copy attachments when cloning an issueWorkflow scheme name or id. Use blank for default scheme. [--copyCommentsissueTypeScheme <issueTypeScheme>] Copy comments when cloning an issueIssue type scheme name or id. Use blank for default scheme. [--copyWatchersissueTypeScreenScheme <issueTypeScreenScheme>] Copy Watchers when cloning an issueIssue type screen scheme name or id. Use blank for default scheme. [--copySubtasksfieldConfigurationScheme <fieldConfigurationScheme>] Copy subtasks when cloning an issueField configuration scheme name or id. Use blank for default scheme. [--copySubtaskEstimatescategory <category>] CopyProject subtask estimates when cloning an issuecategory. Administrator access required to see or use project categories. [--useParentVersionstemplate <template>] CopyProject parenttemplate versionsor toshared subtaskproject whenkey, cloningname, anor issue.id (createProject action [--cloneIssues] only). Project template names (case sensitive) can Clone issues when cloning a project.be found on [--copyVersions] Copy versions when cloning a project. [--copyComponents] the 'Create project' dialog. If a project template is not found, a list of valid templates will be shown in the Copy components when cloning aerror projectmessage. [--copyRoleActorsexportType <exportType>] CopyPROJECT to export project roleinformation, actorsPARTICIPANTS whento cloningexport aissue projectparticipants. Use comman separated [--replace] list if more than one Replace existingare entityneeded. [--activate]login <login>] Login token from Activateprevious login userrequest. [-l|-deactivate-loginFromStandardInput] Deactivate userGet login token from standard input. [--notifyfunctionKey <functionKey>] NotifyTransition userfunction's afterunique userkey. is added.Example: org.swift.jira.cot:createissue-function [--includeInactivetargetServer <targetServer>] ToTarget includeserver inactiveURL usersfor in a user listcopy requests. [--deleteFiltertargetUser <targetUser>] AttemptTarget toserver deleteuser. theDefaults filterto associated with the boarduser parameter. Filter must be a findable as a favorite filter.[--targetPassword <targetPassword>] [--favorite] Target server user password. Defaults to password parameter. Mark a filter as[--autoVersion] a favorite when creating or updating a filter. Automatically add versions [--lookup]used in affectsVersions and fixVersions parameters. Lookup[--autoComponent] userId via search and validate. An error is reportedAutomatically ifadd searchcomponents doesused notin return a single usercomponents parameter. [--legacyautoAdjust] SomeAuto capabilitiesadjust haveremaining newerestimate impementationswhen (likeadding using newer REST APIs)work entry. In some cases, the older (deprecated) [--asVersion] Deprecated. Ignored implementationon may still be available for a limited number of releases. This switch can be set to use the older JIRA 7.x. [--asComponent] Deprecated. Ignored on JIRA 7.x [--asCascadeSelect] implementation to ease migrationDeprecatated. toIgnored theon newerJIRA support7.x. [--preserveCaseappendText] SomeAppend actionstext (exampleto addUser,existing addGroup)value automaticallytext lowercasefor namesdescription, usuallyenvironment, becauseand thesingle constructand ismulti-value casecustom insensitivefields. [--subtract] Use this switchSubtract tovalues overridefrom theexisting defaultvalues behaviorcustom andfields preservesupporting themultiple casevalues. [--helpsuppressId] PrintsSuppress thisshowing helpan message.id when displaying Validissue actions (case insensitive):fields on getIssue. login [--withId] Login to remote server. Returns login token. Deprecated startingDisplay withthe 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 Output formats: 1 - default, 2 - with project, 999 - all getSecurityLevelList - List security levels defined for a projects. Required parameters: project Optional parameters: file, columns, encoding, append, outputFormat Output formats: 1 - default, 999 - all getProjectRoleList - Get project roles. Optional parameters: regex, file, append, columns, encoding getProjectRoleActorList - Get users and groups for a project's role. Required parameters: project, role Optional parameters: file, columns, encoding getProjectRoleByUserList - Get project roles for a user across projects. By default all projects will be included. Requires JIRA 7.0 or higher. 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: userId Optional parameters: regex, file, append, columns, encoding 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: issue Optional parameters: file, dateFormat, columns, encoding getAttachmentList - List attachments for an issue. Required parameters: issue Optional parameters: file, regex, dateFormat, columns, encoding, append, outputFormat Output formats: 1 - default, 999 - all getCommentList - List of comment information (id, dates, ...) for an issue. Required parameters: issue Optional parameters: file, dateFormat, columns, encoding, append Output formats: 1 - default, 999 - all getWorkList - Get list of a work log entry. Required parameters: issue 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: issue Optional parameters: append, file, columns, encoding Output formats: 1 - simple, 2 - CSV getWatcherList - Get list of users that are watching an issue. Required parameters: issue Optional parameters: append, file, columns, encoding Output formats: 1 - simple, 2 - CSV getLinkList - List issue links for an issue. Required parameters: issue Optional parameters: file, columns, encoding, append getLinkTypeList - Get a list of all issue link types. Optional parameters: file, columns, encoding getCustomFieldList - Get information on all custom fields. Optional parameters: file, append, columns, encoding getFieldList - Get information on all fields. Optional parameters: regex, file, append, columns, encoding getWorkflowList - Get list of a workflows matching selection criteria. Optional parameters: limit, regex, dateFormat, file, append, columns, encoding getBoardList - List Agile boards with optional filtering by regex on nameissue field value including the internal id (if the field has an internal value) using the following format: value (id). [--exportAttachments] Export attachments and similar data for site export. [--copyLinks] Copy issue links when cloning an issue. [--copyAttachments] Copy attachments when cloning an issue. [--copyComments] Copy comments when cloning an 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 - basic, 2 - JVM, 11 - action list, 12 - parameter list 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 or project or issue Optional parameters: requestParameters, requestType, type, acceptType, 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 variables are entry, entry2. Required parameters: list Optional parameters: list2, 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, filelimit, appendcontinue, columnssimulate, encodingclearFileBeforeAppend, getIssueTypeList - List issue types valid for a project. If project is blank or @all, all issue types will be listed. Optional parameters: project, file, columns, encoding, append getStatusList - List statuses. Optional parameters: file, encoding, append getTransitionList - Get available workflow transitions for an issuefindReplace, findReplaceRegex, file, encoding runFromCommentList - 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: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromRemoteLinkList - Run action for each remote link for an issue with optional filtering defined the same as for getRemoteLinkList. Required parameters: issue Optional parameters: outputFormatlink, fileregex, appendregex2, encodingtargetUser, Output formats: 1 - basic, 2 - fields getAvailableSteps - Deprecated - getTransitionList is recommended. Get available workflow steps for issuetargetPassword, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromUserList - Run action for each user with similar filtering as getUserList. Available replacement variable is userId. Required parameters: issuegroup or name or project and role Optional parameters: fileregex, appendlimit, encodingincludeInactive, getUserListcontinue, -simulate, ListclearFileBeforeAppend, usersfindReplace, fromfindReplaceRegex, afile, groupencoding orrunFromLinkList a- searchRun byaction namefor fragmenteach (userId,issue displaylink name,for andan email).issue Useor nameissues ofselected @allby toJQL searchincluding forfiltering alljust users.like Orwith usegetLinkList. project andRequired roleparameters: toissue getor alljql users thatOptional areparameters: partlimit, ofregex, theoptions, rolecontinue, forsimulate, theclearFileBeforeAppend, project specified. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches. Required parameters: group or name or project and role findReplace, findReplaceRegex, file, encoding getProjectList - List defined projects with optional filtering by lead and regex on project key. Optional parameters: limitlead, regex, includeInactiveoutputFormat, file, columns, encoding, append, outputFormat Output formats: 1 - basicdefault, 2 - extended attributesschemes, 999 - all getGroupListgetProjectCategoryList - GetList adefined list of groups with optional filtering by regex on group nameproject categories. Optional parameters: limitfile, regexappend, filecolumns, encoding, append createProjectgetVersionList - CreateList aversions newdefined projectfor with key provided by project parametera projects. Required parameters: project, lead Optional parameters: nameregex, descriptionfile, urlcolumns, defaultAssigneeencoding, lookupappend, outputFormat template, permissionScheme, notificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category updateProject - Update project information. Scheme updates require compatible schemesOutput formats: 1 - default, 2 - description, 999 - all getComponentList - List components defined for a projects. Required parameters: project Optional parameters: namelimit, descriptionregex, leadfile, urlcolumns, defaultAssigneeencoding, permissionSchemeappend, notificationScheme,outputFormat 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 cloned Output formats: 1 - default, 2 - with project, 999 - all getSecurityLevelList - List security levels defined for a projects. Required parameters: project Optional parameters: file, columns, encoding, append, outputFormat Output formats: 1 - default, 999 - all getProjectRoleList - Get project roles. Optional parameters: regex, file, append, columns, encoding getProjectRoleActorList - Get users and groups for a project's role. Required parameters: project, toProjectrole Optional parameters: namefile, descriptioncolumns, url,encoding permissionScheme,getProjectRoleByUserList notificationScheme,- 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 errorsGet project roles for a user across projects. By default all projects will be included. This action can take a long time to complete depending on number of projects and roles! Use userId of @all to product a list for all users. Use a regex pattern to subset projects to be included. Each role defines a column with a Yes or No value that indicates if the user is authorize to the project according to the role. This includes either directly authorized as a user or as a member of a group that is authorized. Use columns to subset the roles you want to display. Required parameters: iduserId or board Optional parameters: continue createFilterregex, file, append, columns, encoding getFilterList - CreateGet 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: id of filter 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: namefavorite, searchregex, description,limit favoritegetIssueList getFilter - GetList informationissues aboutfor a filter by id or filter name (if it is a favorite filter)JQL query, filter, search or by project. Required parameters: idfilter or filterjql deleteFilteror -search Deleteor aproject filter byOptional idparameters: orfile, filterdateFormat, name (if it is a favorite filter). Use continue to ignore not found errors. Required parameters: id or filter Optional parameters: 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).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: project,issue version Optional parameters: file, dateFormat, filecolumns, encoding addVersiongetAttachmentList - AddList aattachments newfor version to a projectan issue. Required parameters: project, versionissue Optional parameters: descriptionfile, afterlimit, dateregex, startDatedateFormat, dateFormatcolumns, replaceencoding, updateVersionappend, -outputFormat 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 projectOutput formats: 1 - default, 999 - all getCommentList - List of comment information for an issue with regex filtering on comment body. Required parameters: project, versionissue Optional parameters: toProjectfile, nameregex, descriptionlimit, afteroutputFormat, datedateFormat, startDatecolumns, dateFormatencoding, replace copyVersions append Output formats: 1 - Copydefault, 999 - all getWorkList versions- Get fromlist oneof projecta towork anotherlog projectentry. Required parameters: project, toProjectissue Optional parameters: continuedateFormat, replacefile, deleteVersioncolumns, -encoding, Deleteappend, aoutputFormat version fromOutput aformats: project.999 Update- affectsall andgetVoterList fix- versionsGet forlist issuesof byusers removingthat versionhave referencevoted for or swapping it with versions specified. Use continue to ignore version not found error. an issue. Required parameters: project, versionissue Optional parameters: affectsVersionsoutputFormat, fixVersionsappend, autoVersionfile, continuecolumns, releaseVersionencoding - ReleaseOutput aformats: version1 for- asimple, project.2 Resets- releaseCSV, date999 if- provided.all DefaultsgetWatcherList to- currentGet serverlist dateof ifusers releasethat dateare watching isan not setissue. Use continueRequired toparameters: ignoreissue error whemOptional thatparameters: theoutputFormat, versionappend, isfile, already in the correct state. Required parameters: project, version Optional parameters: date, dateFormat, 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 statecolumns, encoding Output formats: 1 - simple, 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: project, versionissue or jql Optional parameters: limit, dateregex, dateFormatoptions, continuefile, archiveVersioncolumns, -encoding, Archiveappend agetLinkTypeList version- forGet a project.list Thisof hidesall theissue version from the UIlink types. Use continueOptional toparameters: ignorefile, errorcolumns, whenencoding thegetCustomFieldList version- isGet alreadyinformation inon theall correctcustom statefields. RequiredOptional parameters: projectfile, versionappend, columns, Optionalencoding parameters: continue unarchiveVersion getFieldList - UnarchiveGet ainformation versionon forall a projectfields. ThisFilter makesby theid versionor visiblename againregex. in theOptional UI. Use continue to ignore error when the version is already in the correct stateparameters: regex, file, append, columns, encoding getWorkflowList - Get list of a workflows matching selection criteria. RequiredOptional parameters: projectlimit, regex, versiondateFormat, file, Optional parameters: continue getComponentappend, columns, encoding getBoardList - Get information for a component of a projectList Agile boards with optional filtering by regex on name. RequiredOptional parameters: projectregex, componentfile, Optional parameters: fileappend, columns, encoding addComponentgetIssueTypeList - Add component toList issue types valid for a project. If project is Requiredblank parameters:or project@all, component all issue types will be listed. Optional parameters: descriptionproject, file, leadcolumns, defaultAssigneeencoding, replaceappend updateComponentgetStatusList - Update component for a project. Required parameters: project, componentList statuses in their customized order. If project is specified, only statuses for valid for the project will be listed. Optional parameters: nameproject, descriptionfile, leadencoding, defaultAssigneeappend deleteComponentgetTransitionList - DeleteGet componentavailable fromworkflow atransitions project.for Usean continueissue. to ignoreRequired component not found error.parameters: issue RequiredOptional parameters: projectoutputFormat, file, append, componentencoding OptionalOutput parametersformats: continue copyComponent1 - basic, 2 - Copyfields getAvailableSteps a- componentDeprecated from- onegetTransitionList projectis torecommended. theGet sameavailable projectworkflow orsteps anotherfor projectissue. Required parameters: project, componentissue Optional parameters: toProjectfile, toComponentappend, name,encoding description,getUserList lead,- defaultAssignee,List replaceusers copyComponentsfrom -a Copygroup allor ora somesearch componentsby fromname onefragment project(userId, todisplay another.name, and 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, typeemail). Use name of @all to search for all users. Or use project and role to get all users that are part of the role for the project specified. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches. 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 attributes, 999 - all getGroupList - Get a list of groups with optional filtering by regex on group name. Optional parameters: descriptionlimit, searchregex, removeCustomField file, encoding, append createProject - RemoveCreate a customnew fieldproject bywith namekey orprovided id.by Useproject continueparameter. toTo ignoreshare asome notor definedall error.scheme configurations Requiredwith parameters:an fieldexisting project, Optionalconsider parameters:using continuecloneProject createIssueor -specifying Createan aexisting newproject issueon orthe subtask for a projecttemplate parameter. Required parameters: project, typelead Optional parameters: summaryname, parentdescription, referenceurl, prioritydefaultAssignee, reporterlookup, assigneetemplate, descriptionpermissionScheme, componentsnotificationScheme, affectsVersions, fixVersionsissueSecurityScheme, environment, securityworkflowScheme, fieldissueTypeScheme, valueissueTypeScreenScheme, valuesfieldConfigurationScheme, field2,category values2,updateProject asVersion,- asComponent,Update asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, , estimate, originalEstimate, comment, group, role, labels, findReplace, 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. Some advanced options require Clone Plus for JIRA be installed. [CLI Issue Cloning] has more detailsproject 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). 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: issueproject, toProject Optional parameters: typename, summarydescription, resolutionurl, labelspermissionScheme, notificationScheme, commentissueSecurityScheme, group workflowScheme, roleissueTypeScheme, priorityissueTypeScreenScheme, reporterfieldConfigurationScheme, assigneecategory, descriptionsearch, componentstype, affectsVersionscontinue, fixVersionscopyVersions, environmentautoVersion, copyComponents, securityautoComponent, fieldcopyRoleActors, valuecloneIssues, valuescopyLinks, field2copyAttachments, values2copyComments, asVersioncopyWatchers, asComponentcopySubtasks, asCascadeSelectcopySubtaskEstimates, lookupuseParentVersions, date, dateFormat, custom, autoVersion, autoComponent, , findReplace, findReplaceRegexfieldExcludes, propertyPrefix 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, 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 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 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: id of filter Optional parameters: name, search, description, favorite getFilter - Get information about a filter by id or filter name (if it is a favorite filter). 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 errors. Required parameters: id or filter Optional parameters: 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: project, version Optional parameters: name, description, after, date, startDate, dateFormat, autoVersion copyVersion - Copy a version from one project to the same project or another 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: project, toProject Optional parameters: continue, replace deleteVersion - Delete a version from a project. Update affects and fix versions for issues by removing version reference or swapping it with versions specified. Use continue to ignore version not found error. Required parameters: project, version Optional parameters: affectsVersions, fixVersions, autoVersion, continue releaseVersion - Release a version for a project. Resets release date if provided. Defaults to current server date if release date is not set. Use continue to ignore error whem that the version is already in the correct state. Required parameters: project, version Optional parameters: date, dateFormat, description, 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: 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 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: jqlfile Optional parameters: project,encoding type,updateUserProperty continue,- Add copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, autoVersion, autoComponent, fieldExcludes, propertyPrefix, jsp 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 valuesor 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: issueworkflow Optional parameters: typedateFormat, summaryfile, 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. Required parameters: jqlencoding importWorkflow - Import workflow from XML. Required parameters: workflow, file Optional parameters: description, findReplace, findReplaceRegex, encoding exportWorkflow - Export workflow to XML. Required parameters: workflow Optional parameters: file, encoding deleteWorkflow - Delete an inactive workflow. Inactive means it is not associated with any project. Required parameters: workflow Optional parameters: continue runFromWorkflowList - Run action for each workflow with regex filtering on workflow name. Available replacement variable is workflow. Optional parameters: typeregex, summarylimit, resolutioncontinue, labelssimulate, clearFileBeforeAppend, priorityfindReplace, reporterfindReplaceRegex, 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, getIssue - Get information about an existing issuefile, encoding copyWorkflow - Copy a workflow to a new workflow with the name provided by the name parameter. Required parameters: 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, step Optional parameters: filedescription, dateFormattransition, asVersion,screen suppressId, encoding Output formats: 1 - default, 999 - all assignIssue - Assign an isssueaddTransitionFunction - Add a transition function (post function or validator type) to a userIdworkflow transition. Use @defaultFunction forconfiguration userIdis tojust setfield/values thepairs assigneeand tois the project default. Use blank to set the assignee to null. Required parameters: issue, userId transitionIssue - Transition issue through workflowprovided using the same parameters as for setting custom field configuration - custom and related parameters. Required parameters: issueworkflow, transition, continuestep, functionKey Optional parameters: type, summary, resolution, labels, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, custom, field, value, values, field2, values2, asVersion,associateWorkflow asComponent,- asCascadeSelect,Associate lookup,workflow to date,a 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 terminologyworkflow scheme. Required parameters: name, workflowScheme createWorkflowScheme - Create a workflow scheme using a default workflow. Required parameters: issuename, stepworkflow Optional parameters: type,description summary,getWorkflowScheme resolution,- labels,Get workflow 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 issue. Required parameters: issuescheme information. Required parameters: name Optional parameters: file, encoding deleteWorkflowScheme - Delete an inactive workflow scheme. Required parameters: id or name Optional parameters: continue getWorkflowSchemeList - Get list of a workflow schemes matching selection criteria. Optional parameters: commentlimit, groupregex, rolefile, append, findReplacecolumns, findReplaceRegex,encoding file, encoding,Output formats: getComments1 - Getbasic, a2 formatted- stringdetail ofrunFromWorkflowSchemeList all- commentRun textaction for aneach issue.workflow scheme Requiredwith parameters:regex issuefiltering on Optionalworkflow parameters: file, dateFormat, encoding addLabels - Add labels to an issue. Requires labels are available for edit on the issue screen. Required parameters: issue, labels removeLabels - Remove labels from an issue. Requires labels are available for edit on the issue screen. Required parameters: issue, labels getFieldValue - Get field value for an issue. Required parameters: issue, fieldscheme name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding getScreenList - Get a list of screens with optional regex filtering on name. Optional parameters: regex, limit, file, encoding, append, clearFileBeforeAppend getScreenSchemeList - Get a list of screen schemes with optional regex filtering on name. Optional parameters: fileregex, dateFormatlimit, asVersionfile, withIdencoding, suppressIdappend, encodingclearFileBeforeAppend setFieldValuegetIssueTypeScreenSchemeList - SetGet customa field value for anlist of issue. Usetype appendTextscreen toschemes appendwith theoptional valueregex tofiltering 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 valueson 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: field2regex, values2limit, asVersionfile, asComponentencoding, asCascadeSelect, appendText, append, subtract,clearFileBeforeAppend encoding, dateFormat copyFieldValue getFieldConfigurationSchemeList - CopyGet fielda valuelist fromof anfield issueconfiguration toschemes awith customoptional fieldregex offiltering anotheron issuename. Optional Warningparameters: onlyregex, workslimit, forfile, fieldsencoding, thatappend, canclearFileBeforeAppend begetFieldConfigurationList updated- fromGet theira textlist representation.of field Requiredconfigurations parameters:with issue,optional field,regex toIssuefiltering oron field2name. Optional parameters: asVersionregex, asComponentlimit, asCascadeSelectfile, appendencoding, appendTextappend, encoding,clearFileBeforeAppend dateFormatgetPermissionSchemeList addAttachment- -Get Adda anlist attachmentof topermission anschemes issue.with optional Requiredregex parameters:filtering issue,on filename. Optional parameters: findReplaceregex, findReplaceRegexlimit, namefile, encoding getAttachment, append, clearFileBeforeAppend getNotificationSchemeList - Get a lastestlist of attachmentnotification byschemes namewith oroptional idregex forfiltering anon issuename. RequiredOptional parameters: issueregex, limit, file Optional parameters: name, encoding, removeAttachment - Remove an attachment from an issue. A single attachment is removed by id or all attachments matching the fileappend, clearFileBeforeAppend getIssueSecuritySchemeList - Get a list of issue security schemes with optional regex filtering on name. RequiredOptional parameters: issue regex, limit, file, nameencoding, orappend, idclearFileBeforeAppend addWatchersrunFromScreenList - Add watchers to an issue. A comma separated list of user ids can be specified Run action for each screen with optional regex filtering on name. Available replacement variables are screen and screenId. RequiredOptional 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, issueregex, 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: 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 scheme and schemeId. 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, timeSpentlimit, commentcontinue, datesimulate, dateFormatclearFileBeforeAppend, estimatefindReplace, rolefindReplaceRegex, groupfile, autoAdjustencoding linkIssuerunFromFieldConfigurationSchemeList - Link an issue to another issue. Required parameters: issue, toIssue, linkRun action for each field configuration scheme with optional regex filtering on name. Available replacement variables are fieldConfiguration and fieldConfigurationId. Optional parameters: commentregex, grouplimit, rolecontinue, simulate, deleteLinkclearFileBeforeAppend, - 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 namefindReplace, 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: fileregex, endcodinglimit, addUsercontinue, -simulate, AddclearFileBeforeAppend, afindReplace, 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, userEmailfindReplaceRegex, file, encoding runFromPermissionSchemeList - Run action for each permission scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: userFullNameregex, userPasswordlimit, notifycontinue, preserveCasesimulate, addUserWithFileclearFileBeforeAppend, -findReplace, AddfindReplaceRegex, usersfile, fromencoding commarunFromNotificationSchemeList separated- file.Run Deprecatedaction -for useeach runFromCsvnotification supportscheme with addUser instead. Required parameters: file optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: notify, preserveCase regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding updateUserrunFromIssueSecuritySchemeList - UpdateRun useraction information.for each Requiredissue parameters:security userIdscheme orwith userKeyoptional regex Optionalfiltering parameters: userFullName, userEmail, newUserId, activate, deactivate removeUser - Remove a useron name. Available replacement variables are scheme and schemeId. RequiredOptional parameters: userIdregex, removeUserWithFilelimit, -continue, Removesimulate, usersclearFileBeforeAppend, fromfindReplace, commafindReplaceRegex, separatefile, file.encoding DeprecateddeleteScreen - useDelete runFromCsva supportscreen withby removeUser insteadid. Required parameters: fileid Optional parameters: encodingcontinue addGroupdeleteScreenScheme - AddDelete a new groupscreen scheme by id. Required parameters: groupid Optional parameters: preserveCasecontinue removeGroupdeleteIssueTypeScreenScheme - Remove a groupDelete an issue type screen scheme by id. Required parameters: groupid Optional parameters: defaultGroupcontinue addUserToGroupdeleteIssueTypeScheme - Add user to a groupDelete an issue type scheme by id. Required parameters: userId,id group Optional parameters: autoGroup, preserveCase addUserToGroupWithFile - Add users to groups from comma separated file. Deprecated - use runFromCsv support with addUserToGroup insteadcontinue deleteFieldConfiguration - Delete a field configuration by id. Required parameters: id Optional parameters: continue deleteFieldConfigurationScheme - Delete a field configuration scheme by id. Required parameters: fileid Optional parameters: autoGroup,continue preserveCase,deletePermissionScheme encoding- removeUserFromGroupDelete -a Removepermission userscheme fromby a groupid. Required parameters: userId,id group removeUserFromGroupWithFileOptional -parameters: Remove users from groups from comma separated file. Deprecated - use runFromCsv support with removeUserFromGroup insteadcontinue deleteNotificationScheme - Delete a permission scheme by id. Required parameters: fileid Optional parameters: encodingcontinue updateUserPropertydeleteIssueSecurityScheme - AddDelete an orissue updatesecurity ascheme user'sby propertyid. Required parameters: id Optional parameters: userId, name, value Optional parameters: lookup removeUserProperty - Remove a user's property. Required parameters: userId, name Optional parameters: lookup getWorkflow - Get workflow information 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, dateFormattoIssue, filereverseLink, encodingtargetServer, importWorkflowtargetUser, -targetPassword ImportremoveRemoteLink workflow- fromRemove XML.a remote Requiredlink parameters:to name,an fileissue. Name Optionalcan parameters:be description,an findReplace,numeric findReplaceRegexid, encodingglobal exportWorkflowlink -id, Exportor workflowa to XMLname. Required parameters: issue, name getRemoteLinkList - OptionalGet parameters:list file,of encodinga deleteWorkflowremote -links Deletefor an inactiveissue workflow.with Inactiveoptional meansregex itfiltering ison notthe associatedname withor anyglobal projectid. Also Requiredfilter parameters:by namea specific Optionallink parameters:description continueif runFromWorkflowListneeded -using Runlink actionparameter. forIf eachspecified, workflowregex2 withfiltering regexwill filteringbe onappied workflowto name.the Availableapplication replacementtype variablespecific isinformation workflowcolumn. Required parameters: issue Optional parameters: regexlink, limit, continueregex, simulateregex2, clearFileBeforeAppendtargetUser, findReplacetargetPassword, findReplaceRegexoutputFormat, file, encodingappend, columns, associateWorkflowencoding - Associate workflow to a workflow scheme. Required parameters: name, workflowScheme createWorkflowScheme - Create a workflow scheme using a default workflow. Required parameters: name, workflow Optional parameters: description getWorkflowScheme - Get workflow scheme information. Required parameters: nameOutput 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: filetype, encodinglimit, deleteWorkflowSchemeregex, -file, Deleteappend, ancolumns, inactiveencoding workflowexportSite scheme.- Create Requireda parameters:site nameexport. For Optionalserver, parameters:data continueis getWorkflowSchemeListput - Get list of into a workflowfile schemesin matching selection criteria. Optional parameters: limit, 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: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, exportSite - Create a site export into a file in the JIRA home/export directory. Required parameters: filethe 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 |