...
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>] [--propertyFileafterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--comment <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|--autoVersionloginFromStandardInput] [--autoComponentfunctionKey <functionKey>] [--autoAdjusttargetServer <targetServer>] [--asVersiontargetUser <targetUser>] [--asComponenttargetPassword <targetPassword>] [--asCascadeSelectautoVersion] [--appendTextautoComponent] [--subtractautoAdjust] [--suppressIdasVersion] [--withIdasComponent] [--copyLinksasCascadeSelect] [--copyAttachmentsappendText] [--copyCommentssubtract] [--copyWatcherssuppressId] [--copySubtaskswithId] [--copySubtaskEstimatesexportAttachments] [--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>] PropertyBy file with mapping information. [--common <common>] Common parameter string added to all run actions. [--special <special>] Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parametersdefault, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar [--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>] Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for quotes must bethe doubledtable. [--findReplaceRegex <findReplaceRegex>dbCreateTable] FindDatabase andtable replaceneeds textto withbe acreated regularbefore expression. Comma separated list of colon separated pairsadding rows. Single quote values [--comment <comment>] containing a delimiter. Embedded quotes must be doubledComment text. [--list <list>replace] CommaReplace separatedexisting listentity ofon entries. Single quote values containing a delimiter. Embedded quotes must be doubled. [--continueadd, create, or similar actions. [--propertyFile <propertyFile>] ContinueProperty file processingwith evendatabase afterparameters, errorsfield aremappings, encounteredor forclient runspecific actionsinformation. Also used for some action to ignore certain errors[--common <common>] Common parameter string added liketo notall found errors on remove run actions. [--simulatespecial <special>] SimulateOrdered runninglist actions.of Logalternate thecharacters actionfor thatcomma would( be, taken.), colon ( [--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: ), 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. [--servicereference <service><reference>] ServiceReference addressto 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 APIsa 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. [-l|--loginFromStandardInput-findReplace <findReplace>] GetFind loginand token from standard inputreplace text. OnlyComma worksseparated forlist actionsof basedcolon solely on SOAP based server requestsseparated pairs. ActionsSingle usingquote RESTvalues containing a delimiter. Embedded based server requests require passwordsquotes onmust eachbe actionescaped. [--projectfindReplaceRegex <project><findReplaceRegex>] ProjectFind name,and key, or idreplace text with a regular expression. Comma separated [--toProject <toProject>]list of colon separated pairs. Single quote values Projectcontaining name, key, or id to copy toa delimiter. Embedded quotes must be doubled. [--namelist <name><list>] Name.Comma separated list of [--description <description>] Description. [--lead <lead>]entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded Projectquotes leadmust userbe iddoubled. [--defaultAssigneelist2 <defaultAssignee><list2>] ProjectComma orseparated compnentlist defaultof assigneeentries forto issues.populate Forthe projects,entry2 defaultreplacement isvariable unassignedon withrunFromList. options: PROJECT_LEAD or Single quote values containing a UNASSIGNED (blank)delimiter. For components, default is PROJECT_DEFAULT with options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or UNASSIGNED (blank)Embedded quotes must be doubled. [--options <options>] Comma separated list of support, experimental, or other client or action specific options. [--aftercontinue] <after>] Continue Versionprocessing nameeven orafter iderrors toare addencountered afor versionrun afteractions. DefaultsAlso toused afterfor lastsome version.action Useto -1ignore tocertain makeerrors it the first version. [--board <board>] like not found errors on remove actions. Agile board name.[--simulate] [--issue <issue>] Simulate running actions. Log the action Issuethat keywould orbe idtaken. [--toIssue <toIssue>append] LinkAppend destinationvalues issueto keyexisting orvalues id.for version fields, [--parent <parent>] Parent issue key or id. [--summary <summary>] Summary of issuecomponents field, and custom fields supporting multiple values. For some actions using the file parameter, append will append output to the existing file. [--priority <priority>clearFileBeforeAppend] IssueFor priorityrun -actions, namethis oroption id.will automatically clear an [--reporter <reporter>] existing file on the first append requested. Issue reporter user id.(-s|--server) <server> [--assignee <assignee>] Server URL. Normally the base IssueURL assigneeof userthe id.server Inand somethe contexts,same useas -1how forthe automaticserver assignmentis andaccessed ""from fora unassignedbrowser. [(-u|--security <security>]user) <user> User Issuename securityfor levelremote name or id.access. (default: automation) [(-p|--environment <environment>]password) <password> User password for Issueremote environmentaccess. [--componentapi <component><api>] Project component name or idAPI version. Some requests produce [--toComponent <toComponent>] Project component name or id. [--components <components>different results based on the api version used. (default: latest) [--service <service>] ProjectService componentsaddress - comma separated names or ids. extension. (default: /rest/api) [--versioncookies <version><cookies>] Name of file Project version name or id or add-on version. [--affectsVersions <affectsVersions>] to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session Affects versions -affinity commafor separatedactions namesusing orREST idsAPIs. [--fixVersionsproject <fixVersions><project>] FixProject versions - comma separated names or idsname, key, or id. [--customtoProject <custom><toProject>] CustomProject fieldsname, - comma separated key:value pairs. Key can be field name or id. Single quote the key:value pair if it containskey, or id to copy to. For cloning issues, either toProject or project can be used. [--name <name>] a comma (,) or line breaksName. [--fielddescription <field><description>] Description. Field name or id. For some actions, this parameter must be a custom field[--lead <lead>] Project lead user id. [--field2defaultAssignee <field2><defaultAssignee>] Field nameProject or idcompnent fordefault aassignee customfor fieldissues. For projects, default [--fieldExcludes <fieldExcludes>] is unassigned with options: PROJECT_LEAD or Fields to exclude from cloning - comma separated list of fields. [--date <date>]UNASSIGNED (blank). For components, default is PROJECT_DEFAULT with options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD Release date for version or due date for issueUNASSIGNED (blank). [--startDateafter <startDate><after>] DateVersion versionname wasor started.id to add a [--type <type>] Issue type - name or id. Also, content type for renderRequestversion after. Defaults to after last version. Use -1 to make it the first version. [--resolutionboard <resolution><board>] Agile Resolutionboard name or id. [--labelsissue <labels><issue>] Issue Labelskey or tagsid. A blank separated list. [--workflowtoIssue <workflow><toIssue>] Workflow nameTarget or link destination issue key or id. [--transitionparent <transition><parent>] WorkflowParent transitionissue -key name or id. [--stepsummary <step><summary>] Deprecated.Summary Nowof called transitionissue. [--commentpriority <comment><priority>] Comment for an issueIssue priority - name or id. [--filterreporter <filter><reporter>] FilterIssue idreporter or favorite filter nameuser id. Use for getIssueList is deprecated. Use JQL instead.[--assignee <assignee>] [--jql <jql>] Issue assignee user id. In some contexts, use JQL-1 query.for Alternateautomatic wayassignment toand search"" for issuesunassigned. for getIssueList and runFromIssueList [--security continue<security>] to use search parameter for Issue security level name or compatibility with previousid. [--searchenvironment <search><environment>] Search JQL query using legacy support. Deprecated. Use jql parameter instead for new supportIssue environment. [--regexcomponent <regex><component>] RegularProject expressioncomponent forname includingor matching contentid. For example, used to subset projects or versions on getProjectList and[--toComponent <toComponent>] Project component name or runFromVersionListid. [--referencecomponents <reference><components>] ReferenceProject tocomponents a- replacementcomma keyseparated valuenames used to remember last created issue keyor ids. [--linkversion <link><version>] LinkProject description.Thereversion arename releaseor levelid APIor differences add-on whetherversion. the link should be specified as the link type name (like[--affectsVersions <affectsVersions>] Affects versions - comma separated names 'relates') or the directedids. name (like 'relates to'). On later releases (JIRA 5.0+), link type name is the best choice. The link id can also be used for both linkIssue and deleteLink. [--value <value>] Single field or property value. [--values <values>] Comma separated list of field values. Single quote values containing commas. [--values2 <values2>] Comma separated list of field values. Single quote values containing commas [--fixVersions <fixVersions>] Fix versions - comma separated names or ids. [--custom <custom>] A list of custom field key:value pairs. Normally a comma separated list of colon separated pairs. Key can be field name or id. Single quote the key:value pair if it contains a comma (,) or line breaks and similarly for the colon separator. An alternative is to use a JSON formatted string to represent the list of key:value pairs. [--timeSpentfield <timeSpent><field>] Field name Time spent on work using. Example: 3h 30mor id. For some actions, this parameter must be a custom field. [--estimatefield2 <estimate><field2>] EstimateField ofname timeor remainingid for ana issue. Example: 3h 30mcustom field. [--originalEstimatefieldExcludes <originalEstimate><fieldExcludes>] Original estimate of time Fields to completeexclude workfrom for an issue. Example: 3h 30m. [--id <id>] Numeric id of an itemcloning - comma separated list of fields. [--propertyPrefixdate <propertyPrefix><date>] PrefixRelease useddate for accessingversion propertiesor fordue customdate clonefor actionsissue. [--jspstartDate <jsp><startDate>] CustomDate JSPversion name for clone actionswas started. Deprecated. [--requestissueType <request><issueType>] Issue URLtype fragment- forname aor requestid. [--requestParameterstype <requestParameters><type>] URLIssue requesttype parameters.(alternative to issueType), custom [--requestType <requestType>] Type of a render request like GET or POST (default: GET) [--acceptType <acceptType>] Content type to accept for renderRequest if different than typefield type, link type, transition function type, application link type, project type, board type, and content type for renderRequest. [--resolution <resolution>] Resolution name or id. [--limitlabels <limit><labels>] Maximum number of entries to return. (default: 2147483647)Labels or tags. A blank separated list. [--apiworkflow <api><workflow>] APIWorkflow versionname. Some requests produce different results based on the api version used. Deprecated. (default: latest) [--role <role>][--transition <transition>] Workflow transition - name or id. [--step <step>] Source Userstep rolename infor projectaddTransition. [--groupscreen <group><screen>] Transition Groupscreen name. [--defaultGroupfilter <defaultGroup><filter>] Default group to transfer comment and worklog visibility settings to on removeGroupFilter id or favorite filter name. Use for getIssueList is deprecated. Use JQL instead. [--userIdjql <userId><jql>] JQL query. Alternate way Userto idsearch for issues userfor managementgetIssueList and other actions. For some actions, a comma separated list of idsrunFromIssueList - continue to use search parameter for compatibility with previous. [--newUserIdsearch <newUserId><search>] UsedSearch toJQL assignquery ausing newlegacy usersupport. idDeprecated. toUse anjql existingparameter user.instead Sincefor JIRAnew 6support.1. [--userKeyregex <userKey><regex>] UniqueRegular internalexpression identifierfor forincluding usermatching managementcontent. SinceFor JIRA 6.1. [--userFullName <userFullName>] example, used to subset projects or versions on getProjectList and User name for user management actionsrunFromVersionList. [--userEmailregex2 <userEmail><regex2>] UserRegular emailexpression for usersecondary managementcontent actionsmatching. In some [--userPassword <userPassword>] User password for user management actionscases, filtering on a secondary field may be needed. [--autoGrouplink <link>] GroupsLink aredescription. automaticallyUsually addedlink whentype referencedname infor add user functions. [--permissionScheme <permissionScheme>] local links and relationship description for remote links.The link id can also Permission scheme namebe orused id. (default: Default Permission Scheme)for both linkIssue and deleteLink. [--notificationSchemereverseLink <notificationScheme><reverseLink>] Link description for Notification scheme name or idthe (optional) reverse link for addRemoteLink. [--issueSecuritySchemevalue <issueSecurityScheme><value>] IssueSingle securityfield schemeor name or idproperty value. [--workflowSchemevalues <workflowScheme><values>] WorkflowComma separated schemelist nameof orfield idvalues. UseSingle blankquote forvalues defaultcontaining schemecommas. [--issueTypeSchemevalues2 <issueTypeScheme><values2>] IssueComma typeseparated schemelist nameof orfield idvalues. UseSingle blankquote forvalues defaultcontaining schemecommas. [--issueTypeScreenSchemetimeSpent <issueTypeScreenScheme><timeSpent>] IssueTime typespent screenon scheme name or idwork using. UseExample: blank for default scheme3h 30m. JIRA 5.1 and later only. [--fieldConfigurationSchemeestimate <fieldConfigurationScheme><estimate>] Estimate Fieldof configurationtime schemeremaining namefor oran idissue. UseExample: blank for default scheme3h 30m. [--categoryoriginalEstimate <category><originalEstimate>] Original estimate Projectof category.time Administratorto accesscomplete requiredwork tofor seean orissue. useExample: project3h categories30m. [--templateid <template><id>] Project template. JIRA 6.3 and above. Project template to use, default is JIRA Default Schemes. If a template is not found, a list of valid templates will be shown in the error messageNumeric id of an item. [--propertyPrefix <propertyPrefix>] Prefix used for accessing properties for custom clone actions. Requires Clone Plus for JIRA be installed on the server. [--exportTyperequest <exportType><request>] PROJECTURL tofragment exportfor projecta information,request. PARTICIPANTS to export issue participants. Use comman separated list if more than one[--requestParameters <requestParameters>] URL request parameters or are neededpost data.. [--loginrequestType <login><requestType>] Login token from previous login request.Type of a render request like GET or POST (default: GET) [--autoVersionacceptType <acceptType>] AutomaticallyContent addtype versionsto usedaccept infor affectsVersionsrenderRequest andif different fixVersionsthan parameterstype. [--autoComponentlimit <limit>] AutomaticallyMaximum number addof componentsentries usedto in components parameter.return. (default: 2147483647) [--autoAdjustrole <role>] AutoUser adjustrole remaining estimate when adding work entry.in project [--asVersiongroup <group>] Interpret values parameter as version values and convert each to the version idGroup name. [--asComponentdefaultGroup <defaultGroup>] InterpretDefault valuesgroup parameterto astransfer componentcomment valuesand andworklog convertvisibility eachsettings to theon component idremoveGroup. [--asCascadeSelectuserId <userId>] InterpretUser valuesid parameterfor asuser amanagement cascadeand selectother value idsactions. For some actions, a comma separated list of ids. [--appendTextnewUserId <newUserId>] AppendUsed text to existingassign valuea textnew foruser description,id environment,to andan single and multi-value custom fieldsexisting user. [--subtractuserKey <userKey>] SubtractUnique valuesinternal fromidentifier existingfor values custom fields supporting multiple valuesuser management. [--suppressIduserFullName <userFullName>] SuppressUser showingname anfor iduser when displaying issue fields on getIssuemanagement actions. [--withIduserEmail <userEmail>] DisplayUser theemail issuefor fielduser valuemanagement includingactions. the internal id (if the field has an internal value) using the following format: value (id) [--userPassword <userPassword>] User password for user management actions. [--copyLinksautoGroup] CopyGroups are issueautomatically linksadded when cloning an issuereferenced in add user functions. [--copyAttachmentspermissionScheme <permissionScheme>] Copy attachments when cloning an issue.Permission scheme name or id. (default: Default Permission Scheme) [--copyCommentsnotificationScheme <notificationScheme>] CopyNotification commentsscheme whenname cloningor an issueid. [--copyWatchersissueSecurityScheme <issueSecurityScheme>] CopyIssue Watcherssecurity whenscheme cloningname anor issue.id [--copySubtasksworkflowScheme <workflowScheme>] Workflow Copy subtasks when cloning an issuescheme name or id. Use blank for default scheme. [--copySubtaskEstimatesissueTypeScheme <issueTypeScheme>] CopyIssue subtasktype estimatesscheme whenname cloningor an issueid. Use blank for default scheme. [--useParentVersionsissueTypeScreenScheme <issueTypeScreenScheme>] Copy parent versions to subtask when cloning an issueIssue type screen scheme name or id. Use blank for default scheme. [--cloneIssuesfieldConfigurationScheme <fieldConfigurationScheme>] Field configuration scheme name or Cloneid. issuesUse whenblank cloningfor adefault projectscheme. [--copyVersionscategory <category>] Project category. Administrator access Copyrequired versionsto whensee cloningor ause project categories. [--copyComponentstemplate <template>] CopyProject componentstemplate whenor cloningshared a project. key, name, or [--copyRoleActors] Copy project role actors when cloning a project. [--replace] Replace existing entity. [--activate]id (createProject action only). Project template names (case sensitive) can be found on the 'Create project' dialog. If a project template is not found, a list of valid templates will be shown in the error Activate usermessage. [--deactivateexportType <exportType>] PROJECT to export project information, PARTICIPANTS to export Deactivateissue userparticipants. Use comman separated [--notify]list if more than one Notify user after user isare addedneeded. [--includeInactivelogin <login>] ToLogin includetoken inactivefrom usersprevious in a user listlogin request. [-l|--deleteFilterloginFromStandardInput] AttemptGet tologin deletetoken thefrom filterstandard 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 filterinput. [--functionKey <functionKey>] Transition function's unique key. Example: org.swift.jira.cot:createissue-function [--targetServer <targetServer>] Target server URL for copy requests. [--lookuptargetUser <targetUser>] Target Lookupserver userIduser. viaDefaults searchto anduser validateparameter. An error is reported if search does not return a single user [--targetPassword <targetPassword>] Target server user password. Defaults to password parameter. [--legacyautoVersion] SomeAutomatically capabilitiesadd haveversions newerused 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 in affectsVersions and fixVersions parameters. [--autoComponent] Automatically add components used in components parameter. [--autoAdjust] Auto adjust remaining estimate when adding work entry. [--asVersion] implementation to ease migrationDeprecated. toIgnored theon newerJIRA support7.x. [--preserveCaseasComponent] SomeDeprecated. actionsIgnored (exampleon addUser, addGroup) automatically lowercase names usually because the construct is case insensitive. Use this switch to override the default behavior and preserve the caseJIRA 7.x [--asCascadeSelect] Deprecatated. Ignored on JIRA 7.x. [--appendText] Append text to existing value text for description, environment, and single and multi-value custom fields. [--helpsubtract] Subtract Printsvalues thisfrom helpexisting message.values custom fields Validsupporting actionsmultiple (case insensitive):values. login [--suppressId] Login to remote server. Returns login token. Deprecated startingSuppress withshowing 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 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 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, outputFormatan id when displaying issue fields on getIssue. [--withId] Display the issue 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 - defaultbasic, 9992 - alldetail getCommentListvalidateLicense - ListValidates the ofCLI commentConnector informationis (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 entryenabled 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: issue file or standard input Optional parameters: dateFormatcommon, continue, filesimulate, columnsclearFileBeforeAppend, encoding, appendfindReplace, outputFormatfindReplaceRegex runFromSql Output- formats:Run 999actions -generated allby getVoterListSQL -provided Getby listthe ofsql usersparameter, thata havefile, votedor forstandard aninput issue. Required parameters: issue sql or file or standard input Optional parameters: appendcommon, driver, filedatabase, columnshost, encodingport, url, Output formats: 1 - simple, 2 - CSV getWatcherList - Get list of users that are watching an issuedbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromCsv - Run actions generated from a CSV file. Required parameters: issuefile Optional parameters: appendcommon, filepropertyFile, columnscontinue, encodingquiet, simulate, Output formats: 1 - simple, 2 - CSV getLinkList - List issue links for an issueclearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromList - Run actions for each entry in a list. RequiredWhen parameters:file issueis provided, Optionaleach parameters:action file,in columns,the encoding,file appendaugmented getLinkTypeListby -the Getcommon aparameter listwill ofbe allrun issuefor linkeach typesentry. OptionalOtherwise, parameters:just file,the columns,action encodingspecified getCustomFieldListby -the Getcommon informationparameter onwill allbe custom fieldsrun. OptionalAvailable parameters:replacement file,variables append,are columnsentry, encodingentry2. getFieldList -Required Getparameters: information on all fields. list Optional parameters: regexlist2, file, appendcommon, columnscontinue, encodingquiet, getWorkflowListsimulate, -clearFileBeforeAppend, Getencoding, listfindReplace, offindReplaceRegex arunFromIssueList workflows- matchingRun selectionactions criteria.for each Optional parameters: limit, regex, dateFormat, file, append, columns, encoding getBoardList - List Agile boards with optional filtering by regex on name.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: regex common, continue, simulate, limit, clearFileBeforeAppend, filefindReplace, appendfindReplaceRegex, columnsfile, encoding getIssueTypeListrunFromProjectList - List issue types valid for a project. If project is blank or @all, all issue types will be listedRun actions for each project with optional filtering by lead and regex on project key. Available replacement variables are project, projectId. Optional parameters: projectlead, fileregex, common, continue, simulate, limit, clearFileBeforeAppend, findReplace, columnsfindReplaceRegex, encodingfile, appendencoding getStatusListrunFromVersionList - ListRun statuses.actions for Optionaleach parameters:version file,in encoding,a appendproject. getTransitionListAvailable -replacement Getvariables availableare workflowproject, transitionsprojectId, for an issueversion, versionId. Required parameters: issueproject Optional parameters: outputFormatregex, filecommon, appendcontinue, encodingsimulate, limit, Output formats: 1 - basic, 2clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromComponentList - fieldsRun getAvailableStepsactions -for Deprecatedeach -component getTransitionListin isa recommendedproject. Available replacement Getvariables availableare workflowproject, stepsprojectId, forcomponent, issuecomponentId. Required parameters: issueproject Optional parameters: fileregex, appendcommon, encodingcontinue, getUserListsimulate, -limit, ListclearFileBeforeAppend, users from a group or a search by name fragment (userId, display name, and email). Use name of @all to retrieve all users. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searchesfindReplace, findReplaceRegex, file, encoding runFromAttachmentList - Run actions for a list of attachments for an issue. Available replacement variables are attachment, attachmentId. Required parameters: group orissue name Optional parameters: limitcommon, regexcontinue, includeInactivesimulate, filelimit, columnsregex, encodingclearFileBeforeAppend, appendfindReplace, outputFormatfindReplaceRegex, file, Outputencoding formats:runFromGroupList 1 - basic,Run 2action -for extendedeach attributes,group 999with -optional allregex getGroupListfiltering -on Getgroup aname. listAvailable ofreplacement groupsvariable with optional filtering by regex on group nameis group. Optional parameters: regex, limit, regexcontinue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, append createProject - Create a new project with key provided by project parameter runFromCommentList - Run action for each comment for an issue with optional regex filtering on the comment body. Available replacement variable is commentId. Required parameters: project, leadissue Optional parameters: nameregex, descriptionlimit, urlcontinue, defaultAssigneesimulate, lookupclearFileBeforeAppend, templatefindReplace, permissionSchemefindReplaceRegex, notificationSchemefile, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category updateProject - Update project information. Scheme updates require compatible schemesencoding runFromRemoteLinkList - Run action for each remote link for an issue with optional filtering defined the same as for getRemoteLinkList. Required parameters: projectissue Optional parameters: namelink, descriptionregex, leadregex2, urltargetUser, defaultAssigneetargetPassword, permissionSchemelimit, notificationSchemecontinue, issueSecuritySchemesimulate, workflowSchemeclearFileBeforeAppend, issueTypeSchemefindReplace, issueTypeScreenSchemefindReplaceRegex, fieldConfigurationSchemefile, categoryencoding cloneProjectrunFromUserList - CreateRun aaction newfor projecteach asuser awith clonesimilar offiltering aas basegetUserList. projectAvailable (onlyreplacement issuevariable 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 clonedis userId. Required parameters: group or name or project and role Optional parameters: regex, limit, includeInactive, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromLinkList - Run action for each issue link for an issue or issues selected by JQL including filtering just like with getLinkList. Required parameters: issue project,or toProjectjql Optional parameters: namelimit, descriptionregex, urloptions, permissionSchemecontinue, notificationSchemesimulate, issueSecuritySchemeclearFileBeforeAppend, workflowSchemefindReplace, issueTypeSchemefindReplaceRegex, issueTypeScreenSchemefile, fieldConfigurationScheme,encoding category,getProjectList - search,List type,defined 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 informationprojects 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: suppressIdregex, file, columns, encoding, createBoardappend, -outputFormat Create anOutput Agileformats: board.1 Type- isdefault, any2 support type like scrum- description, kanban,999 or- diy.all ProjectgetComponentList is- aList commacomponents separateddefined listfor ofa projects. identified byRequired key, name, or id. Requiredparameters: project Optional parameters: namelimit, typeregex, projectfile, deleteBoardcolumns, -encoding, Deleteappend, anoutputFormat Agile board.Output Useformats: continue1 to- ignoredefault, not2 found- errors.with project, Required999 parameters:- idall orgetSecurityLevelList board- List Optionalsecurity parameters:levels continue createFilter - Createdefined for a filterprojects. Required parameters: name,project search Optional parameters: descriptionfile, favoritecolumns, updateFilterencoding, - Update a filter by id or filter name (if it is a favorite filter)append, outputFormat Output formats: 1 - default, 999 - all getProjectRoleList - Get project roles. RequiredOptional parameters: id of filter Optional parameters: name, search, description, favorite getFilterregex, file, append, columns, encoding getProjectRoleActorList - Get informationusers aboutand agroups filterfor bya id or filter name (if it is a favorite filter). Requiredproject's role. Required parameters: project, role Optional parameters: idfile, orcolumns, filterencoding deleteFiltergetProjectRoleByUserList - DeleteGet aproject filterroles byfor ida oruser filteracross nameprojects. (ifBy itdefault isall aprojects favorite filter)will be included. UseThis continueaction tocan ignoretake nota foundlong errors.time to Requiredcomplete parameters:depending idon ornumber filterof projects Optionaland parameters:roles! continueUse setShareScopeuserId -of Set@all currentto usersproduct defaulta sharelist scopefor forall filtersusers. Use Valida valuesregex arepattern GLOBALto andsubset PRIVATE.projects to Requiredbe parameters:included. valueEach getVersionrole -defines Geta informationcolumn forwith a projectYes versionor (sinceNo 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 projectvalue that indicates if the user is authorize to the project according to the role. This includes either directly authorized as a user or as a member of a group that is authorized. Use columns to subset the roles you want to display. Required parameters: project, versionuserId Optional parameters: nameregex, descriptionfile, afterappend, datecolumns, startDate,encoding dateFormat, autoVersion copyVersion getFilterList - CopyGet a versionlist fromof onefilters projectfor to the samecurrent projectuser. orOn anotherServer project.or if Requiredfavorite parameters:is projectspecified, versionthe current Optionalusers parameters: toProject, name, description, after, date, startDate, dateFormat, replace copyVersions - Copy all versions from one project to another project. Required parameters: project, toProjectfavorite filters will be listed. Otherwise, the filters owned by the current user will be listed. Subset the list by regex pattern on the filter name. Optional parameters: favorite, continueregex, replacelimit deleteVersiongetIssueList - DeleteList aissues version fromfor a project.JQL Updatequery, affectsfilter, andsearch fixor versionsby forproject. issues byRequired removingparameters: versionfilter referenceor jql or swappingsearch itor withproject versions specified.Optional Useparameters: continuefile, todateFormat, ignorelimit, versionwithId, notsuppressId, found error. Required parameters: project, versionoutputFormat, columns, encoding, append OptionalOutput parametersformats: affectsVersions, fixVersions1 - default, autoVersion,2 continueor releaseVersion4 - Releasecustom afields, version3 foror a4 project.- Resetssecurity releaselevel, date5 if- provided.4 Defaultsplus totime currentvalues, server101 date- ifissue releasekeys dateonly, 998 is- notall set.except Usecustom, continue999 to- ignoreall errorgetIssueHistoryList whem- thatGet theissue version is already in the correct statechange history. Required parameters: project,issue version Optional parameters: datefile, dateFormat, continue unreleaseVersioncolumns, encoding getAttachmentList - UnreleaseList aattachments version for a project, optionally reset release date. Use continue to ignore error when the version is already in the correct state. an issue. Required parameters: project, versionissue Optional parameters: datefile, dateFormatlimit, continueregex, archiveVersiondateFormat, -columns, Archiveencoding, aappend, versionoutputFormat for aOutput project.formats: This1 hides- thedefault, version999 from- theall UI.getCommentList Use- continueList toof ignorecomment errorinformation whenfor thean versionissue iswith alreadyregex infiltering theon correctcomment statebody. Required parameters: project,issue version Optional parameters: continuefile, unarchiveVersionregex, -limit, UnarchiveoutputFormat, adateFormat, versioncolumns, forencoding, aappend project. ThisOutput makesformats: the1 version- visibledefault, again999 in- theall UI.getWorkList Use- continueGet tolist ignoreof errora whenwork thelog versionentry. is alreadyRequired in the correct state.parameters: issue RequiredOptional parameters: project dateFormat, file, columns, encoding, append, versionoutputFormat OptionalOutput parametersformats: continue getComponent999 - all getVoterList - Get list of informationusers forthat ahave componentvoted offor aan projectissue. Required parameters: project, componentissue Optional parameters: outputFormat, append, file, columns, encoding addComponent -Output Addformats: component1 to- asimple, project.2 Required parameters: project- CSV, component999 - Optionalall parameters:getWatcherList description,- lead,Get defaultAssignee,list replaceof updateComponentusers -that Updateare componentwatching foran a projectissue. Required parameters: project,issue component Optional parameters: nameoutputFormat, descriptionappend, leadfile, defaultAssigneecolumns, deleteComponentencoding - DeleteOutput componentformats: from1 a- project.simple, Use2 continue- toCSV, ignore999 component- notall foundgetLinkList error.- List Requiredissue parameters:links project,for componentan issue Optionalor parameters:issues continueselected copyComponentby -JQL. CopyFilter aby componentregex frompattern one projectmatching link name or description. Setting options parameter to theone sameof projectoutward or another projectinward will additionally filter by link direction. Required parameters: project, componentissue or jql Optional parameters: toProjectlimit, toComponentregex, nameoptions, descriptionfile, leadcolumns, defaultAssigneeencoding, replaceappend copyComponentsgetLinkTypeList - CopyGet alla orlist someof componentsall fromissue one project to anotherlink types. RequiredOptional parameters: projectfile, toProject Optional parameters: componentscolumns, replaceencoding addProjectRoleActorsgetCustomFieldList - AddGet usersinformation oron groupsall to a project rolecustom fields. RequiredOptional parameters: file, projectappend, rolecolumns, userIdencoding orgetFieldList group- copyProjectRoleActorsGet -information Copyon all rolefields. actorsFilter fromby aid projector toname another projectregex. RequiredOptional parameters: projectregex, toProjectfile, append, Optionalcolumns, parameters: continue removeProjectRoleActorsencoding getWorkflowList - RemoveGet userslist orof groupsa fromworkflows amatching projectselection rolecriteria. RequiredOptional parameters: project limit, regex, dateFormat, rolefile, userIdappend, orcolumns, groupencoding addCustomFieldgetBoardList - 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, typeList Agile boards with optional filtering by regex on name. Optional parameters: regex, file, append, columns, encoding getIssueTypeList - List issue types valid for a project. If project is blank or @all, all issue types will be listed. Optional parameters: descriptionproject, file, columns, encoding, searchappend removeCustomFieldgetStatusList - RemoveList astatuses customin fieldtheir bycustomized nameorder. orIf id.project Useis continuespecified, toonly ignorestatuses afor notvalid definedfor error.the project Requiredwill parameters:be fieldlisted. Optional parameters: continue createIssue - Create a new issue or subtask for a projectproject, file, encoding, append getTransitionList - Get available workflow transitions for an issue. Required parameters: project, typeissue Optional parameters: summaryoutputFormat, parentfile, referenceappend, encoding priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, , estimate, originalEstimate, comment, group, role, labels, findReplace, findReplaceRegex, file, encoding, 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 detailsOutput formats: 1 - basic, 2 - fields getAvailableSteps - Deprecated - getTransitionList is recommended. Get available workflow steps for issue. Required parameters: issue Optional parameters: file, append, encoding getUserList - List users from a group or a search by name fragment (userId, display name, and email). Use name of @all to search for all users. Or use project and role to get all users that are part of the role for the project specified. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches. Required parameters: issuegroup or name or project and role Optional parameters: typelimit, summaryregex, resolutionincludeInactive, labelsfile, commentcolumns, groupencoding, roleappend, priority,outputFormat reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, , findReplace, findReplaceRegex, file, encoding, project, reference, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix, jsp cloneIssues - Clone issues returned from a JQL search. Advanced options require the Clone Plus for JIRA be installed. [CLI Issue Cloning] has more detailsOutput formats: 1 - basic, 2 - extended attributes, 999 - all getGroupList - Get a list of groups with optional filtering by regex on group name. Optional parameters: limit, regex, file, encoding, append createProject - Create a new project with key provided by project parameter. To share some or all scheme configurations with an existing project, consider using cloneProject or specifying an existing project on the template parameter. Required parameters: project, jqllead Optional parameters: projectname, typedescription, continueurl, copyLinksdefaultAssignee, copyAttachmentslookup, copyCommentstemplate, copyWatcherspermissionScheme, copySubtasksnotificationScheme, copySubtaskEstimatesissueSecurityScheme, useParentVersions, autoVersionworkflowScheme, autoComponentissueTypeScheme, fieldExcludesissueTypeScreenScheme, propertyPrefixfieldConfigurationScheme, jspcategory updateIssueupdateProject - Update anproject existing issueinformation. UseScheme appendTextupdates torequire 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. compatible schemes. Required parameters: issueproject Optional parameters: typename, summarydescription, resolutionlead, labelsurl, defaultAssignee, prioritypermissionScheme, reporternotificationScheme, assigneeissueSecurityScheme, descriptionworkflowScheme, components, affectsVersionsissueTypeScheme, fixVersionsissueTypeScreenScheme, environmentfieldConfigurationScheme, category security,cloneProject field,- value,Create values,a field2,new values2,project asVersion,as asComponent,a asCascadeSelect,clone lookup,of a date,base 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 itproject (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: project, jqltoProject Optional parameters: typename, summarydescription, resolutionurl, labelspermissionScheme, prioritynotificationScheme, reporterissueSecurityScheme, assignee workflowScheme, descriptionissueTypeScheme, componentsissueTypeScreenScheme, affectsVersionsfieldConfigurationScheme, fixVersionscategory, environment, securitysearch, fieldtype, valuecontinue, valuescopyVersions, field2autoVersion, values2copyComponents, asVersionautoComponent, asComponentcopyRoleActors, asCascadeSelect, lookupcloneIssues, datecopyLinks, dateFormatcopyAttachments, customcopyComments, autoVersioncopyWatchers, autoComponentcopySubtasks, copySubtaskEstimates, estimateuseParentVersions, originalEstimate, append, appendText, continue, comment, group, role, , findReplace, findReplaceRegex, file, encoding, getIssue - Get information about an existing issue. Required parameters: issuefieldExcludes, 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 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: file Optional parameters: encoding updateUserProperty - Add or update a user's property. Required parameters: userId, name, value Optional parameters: lookup removeUserProperty - Remove a user's property. Required parameters: userId, name Optional parameters: lookup getWorkflow - Get workflow information. Required parameters: workflow Optional parameters: dateFormat, file, encoding 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: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, 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: workflow, name, step Optional parameters: filedescription, dateFormattransition, asVersion, suppressId, encoding Output formats: 1 - default, 999 - all assignIssue - Assign an isssuescreen addTransitionFunction - Add a transition function (post function or validator type) to a userIdworkflow transition. Use @defaultFunction forconfiguration userIdis tojust setfield/values thepairs assigneeand tois theprovided project default. Use blank to set using the assigneesame toparameters null.as for Requiredsetting parameters:custom issue, userId transitionIssuefield configuration - Transitioncustom issueand throughrelated workflowparameters. 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 texton fieldname. 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: 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, asComponent, asCascadeSelect, appendTextencoding, append, subtract, encoding, dateFormat copyFieldValue clearFileBeforeAppend getFieldConfigurationSchemeList - CopyGet fielda valuelist fromof anfield issueconfiguration toschemes awith customoptional fieldregex offiltering anotheron issuename. WarningOptional parameters: 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: timeSpentregex, limit, commentcontinue, datesimulate, dateFormatclearFileBeforeAppend, estimatefindReplace, rolefindReplaceRegex, groupfile, autoAdjustencoding linkIssuerunFromFieldConfigurationSchemeList - Link an issue to another issue. Required parameters: issue, toIssue, link Run 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, -findReplace, RemovefindReplaceRegex, linkfile, toencoding 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. Required parameters: userId, userEmailrunFromFieldConfigurationList - Run action for each field configuration with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding 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, - Add users from comma separated file. Required parameters: file Optional parameters: notify, preserveCase, encoding updateUser - Update user information. Required parameters: userId or userKeyfindReplace, findReplaceRegex, file, encoding runFromNotificationSchemeList - Run action for each notification scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. Optional parameters: userFullNameregex, limit, continue, simulate, clearFileBeforeAppend, userEmailfindReplace, newUserIdfindReplaceRegex, activatefile, deactivateencoding removeUserrunFromIssueSecuritySchemeList - Remove a user. Required parameters: userId removeUserWithFile - Remove users from comma separate file Run action for each issue security scheme with optional regex filtering on name. Available replacement variables are scheme and schemeId. RequiredOptional parameters: file Optional parameters:regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding addGroupdeleteScreen - AddDelete a newscreen by groupid. Required parameters: groupid Optional parameters: preserveCasecontinue removeGroupdeleteScreenScheme - RemoveDelete a groupscreen scheme by id. Required parameters: groupid Optional parameters: defaultGroupcontinue addUserToGroupdeleteIssueTypeScreenScheme - Add user to a groupDelete an issue type screen scheme by id. Required parameters: userId, groupid Optional parameters: autoGroup, preserveCase addUserToGroupWithFilecontinue deleteIssueTypeScheme - AddDelete usersan toissue groupstype fromscheme commaby separated fileid. Required parameters: fileid Optional parameters: autoGroup,continue preserveCase,deleteFieldConfiguration encoding- removeUserFromGroupDelete -a Removefield userconfiguration fromby a groupid. Required parameters: userId, group removeUserFromGroupWithFileid Optional parameters: continue deleteFieldConfigurationScheme - RemoveDelete usersa fromfield groupsconfiguration fromscheme commaby separated fileid. Required parameters: fileid Optional parameters: encodingcontinue updateUserPropertydeletePermissionScheme - AddDelete ora updatepermission ascheme user'sby propertyid. Required parameters: userId, name, value id Optional parameters: lookupcontinue removeUserPropertydeleteNotificationScheme - RemoveDelete a user's propertypermission scheme by id. Required parameters: userId, nameid Optional parameters: lookupcontinue getWorkflowdeleteIssueSecurityScheme - Get workflow informationDelete an issue security scheme by id. Required parameters: nameid Optional parameters: continue dateFormat,addRemoteLink file,- encodingAdd importWorkflowa -remote Importlink workflowto froman XMLissue. Required parameters: name, file Optional parameters: description, findReplace, findReplaceRegex, encoding exportWorkflow - Export workflow to XMLName 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: fileurl, toIssue, reverseLink, targetServer, targetUser, encodingtargetPassword deleteWorkflowremoveRemoteLink - DeleteRemove a remote link to an inactive workflow. Inactive means it is not associated with any projectissue. Name can be an numeric id, global link id, or a name. Required parameters: issue, name runFromWorkflowListgetRemoteLinkList - Run action Get list of a remote links for eachan workflowissue with optional regex filtering on workflowthe name. Availableor replacement variable is workflow. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, createWorkflowScheme - Create a workflow scheme using a default workflow. Required parameters: name, workflow Optional parameters: description getWorkflowScheme - Get workflow scheme informationglobal id. Also filter by a specific link description if needed using link parameter. If specified, regex2 filtering will be appied to the application type specific information column. Required parameters: nameissue Optional parameters: filelink, limit, regex, encodingregex2, deleteWorkflowSchemetargetUser, -targetPassword, DeleteoutputFormat, anfile, inactiveappend, workflowcolumns, scheme.encoding RequiredOutput parametersformats: name getWorkflowSchemeList1 - basic, 999 - all getApplicationLinkList - Get list of a workflow schemes matching selection criteria application links with optional filtering on application type and regex filtering on the name or url. Example types: jira, confluence. Optional parameters: type, limit, regex, file, append, columns, encoding exportSite - Create a site export. For server, data is put into a file in the JIRA home/export directory. For Cloud, data is put into a JIRA defined file on the associated webdav server - the file can optionally be copied to a local file if the file parameter is specified and permissions allow. Also for Cloud Requiredonly, 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 |