...
Related information for
...
6.
...
6.0
Help Text
No Format |
---|
Usage: jira (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>] [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--dbJar <dbJar>] [--afterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--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><labels>] [--workflow <workflow>] [--transition <transition>] [--step <step>] [--commentscreen <comment><screen>] [--filter <filter>] [--jql <jql>] [--search <search>] [--regex <regex>] [--regex2 <regex2>] [--reference <reference>] [--link <link>] [--reverseLink <reverseLink>] [--value <value>] [--values <values>] [--values2 <values2>] [--timeSpent <timeSpent>] [--estimate <estimate>] [--originalEstimate <originalEstimate>] [--id <id>] [--propertyPrefix <propertyPrefix>] [--jsp <jsp><propertyPrefix>] [--request <request>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType <acceptType>] [--limit <limit>] [--api <api>] [--role <role>] [--group <group>] [--defaultGroup <defaultGroup>] [--userId <userId>] [--newUserId <newUserId>] [--userKey <userKey>] [--userFullName <userFullName>] [--userEmail <userEmail>] [--userPassword <userPassword>] [--autoGroup] [--permissionScheme <permissionScheme>] [--notificationScheme <notificationScheme>] [--issueSecurityScheme <issueSecurityScheme>] [--workflowScheme <workflowScheme>] [--issueTypeScheme <issueTypeScheme>] [--issueTypeScreenScheme <issueTypeScreenScheme>] [--fieldConfigurationScheme <fieldConfigurationScheme>] [--category <category>] [--template <template>] [--exportType <exportType>] [--login <login>] [-l|--loginFromStandardInput] [--loginfunctionKey <login><functionKey>] [--targetServer <targetServer>] [--targetUser <targetUser>] [--targetPassword <targetPassword>] [--autoVersion] [--autoComponent] [--autoAdjust] [--asVersion] [--asComponent] [--asCascadeSelect] [--appendText] [--subtract] [--suppressId] [--withId] [--exportAttachments] [--copyLinks] [--copyAttachments] [--copyComments] [--copyWatchers] [--copySubtasks] [--copySubtaskEstimates] [--useParentVersions] [--cloneIssues] [--copyVersions] [--copyComponents] [--copyRoleActors] [--replaceactivate] [--activatedeactivate] [--deactivatenotify] [--notifysuppressNotify] [--includeInactive] [--deleteFilter] [--favorite] [--lookup] [--legacy] [--preserveCase] [--helprecursive] [--helpText <helpText>] Provides capability to make requests to a[--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. [--dbJar <dbJar>] By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar [--propertyFileafterSql <propertyFile>]<afterSql>] SQL to run after a successful action. Limited to Propertyspecific fileactions withat mappingthis informationtime. [--commondbTable <common><dbTable>] Common parameter string added to all run actionsDatabase table name when creating or updating a database from list output. [--specialdbTableKeys <special><dbTableKeys>] OrderedComma separated list of alternatecolumn charactersnames forused commato (access ,existing ),rows colonfor (update. :Normally ),this atdefines (a @primary ),key quoteset (for ' ), and double quote ( " ) charactersthe table. [--dbCreateTable] used for specialized processing of someDatabase specifictable parameters.needs to be created [--dateFormat <dateFormat>] before adding rows. [--comment <comment>] Format string for date in Java SimpleDateFormat, default is client date formatComment text. [--findReplace <findReplace>]replace] Replace existing entity Findon andadd, replacecreate, text.or Commasimilar separatedactions. list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped[--propertyFile <propertyFile>] Property file with database parameters, field mappings, or client specific information. [--findReplaceRegexcommon <findReplaceRegex><common>] FindCommon andparameter replacestring textadded withto aall regularrun expressionactions. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. [--list <list>] Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled [--special <special>] Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. [--continuedateFormat <dateFormat>] Format Continuestring processingfor evendates afterin errorsJava areSimpleDateFormat. encounteredDefault for runoutput actions.is Alsoclient useddate for some action to ignore certain errors like not found errors on remove actionsformat. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format. [--simulatedateFormat2 <dateFormat2>] SimulateAlternate runningformat actions.string Logfor thedates actionin that would be takenJava SimpleDateFormat. Use specific [--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>(may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd. [--reference <reference>] Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key. [--findReplace <findReplace>] Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded Userquotes passwordmust forbe remote accessescaped. [--servicefindReplaceRegex <service><findReplaceRegex>] ServiceFind addressand 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 sessionreplace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. [--list <list>] affinityComma forseparated actionslist usingof RESTentries APIs.to populate the [-l|--loginFromStandardInput] Get login token from standard input. Only works for actions based solely on SOAP based server requests. Actions using REST based server requests require passwords on each action. [--project <project>]entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. [--list2 <list2>] Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. ProjectEmbedded name,quotes key,must orbe iddoubled. [--toProjectoptions <toProject><options>] Project nameComma separated list of support, keyexperimental, or idother to copy to. For cloning issues, either toProject or project can be usedclient or action specific options. [--name <name>continue] Name.Continue processing even after [--description <description>] Description. [--lead <lead>]errors are encountered for run actions. Also used for some action to ignore certain errors like not found Projecterrors leadon userremove idactions. [--defaultAssignee <defaultAssignee>simulate] ProjectSimulate or compnent default assignee for issuesrunning actions. ForLog projects,the defaultaction isthat unassignedwould withbe options: PROJECT_LEAD or taken. [--append] UNASSIGNED (blank). ForAppend components,values defaultto isexisting PROJECT_DEFAULTvalues withfor options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or UNASSIGNED (blank). [--after <after>] Version name or id to add a version after. Defaults to after last version. Use -1 to make it the first version. [--board <board>] Agile board name. [--issue <issue>]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> Issue key or idServer URL. Normally the base [--toIssue <toIssue>] Target or link destination issue key or idURL of the server and the same as how the server is accessed from a browser. [(-u|--parentuser) <parent>]<user> ParentUser issuename keyfor orremote idaccess. (default: automation) [ (-p|--summary <summary>]password) <password> User password Summaryfor ofremote issueaccess. [--priorityapi <priority>]<api>] API version. Some requests produce different results Issuebased priorityon -the nameapi orversion id.used. (default: latest) [--reporterservice <reporter><service>] Issue reporter user id.Service address extension. (default: /rest/api) [--assigneecookies <assignee><cookies>] IssueName assigneeof userfile id.to Inrestore someand contexts,persist usecookies -1across forinvocations automaticof assignmentCLI andactions. ""Can forbe unassigned.used to provide Data [--security <security>]Center session Issueaffinity securityfor levelactions nameusing orREST idAPIs. [--environmentproject <environment><project>] Issue environment Project name, key, or id. [--componenttoProject <component><toProject>] Project componentname, namekey, or id. to copy [--toComponent <toComponent>] Project component name or idto. For cloning issues, either toProject or project can be used. [--componentsname <components><name>] Project components - comma separated names or idsName. [--versiondescription <version><description>] Project version name or id or add-on versionDescription. [--affectsVersionslead <affectsVersions><lead>] AffectsProject versionslead - comma separated names or idsuser id. [--fixVersionsdefaultAssignee <fixVersions><defaultAssignee>] FixProject versionsor -compnent commadefault separatedassignee namesfor or idsissues. For projects, default [--custom <custom>] is unassigned with options: PROJECT_LEAD or Custom fields - comma separated key:value pairsUNASSIGNED (blank). KeyFor cancomponents, bedefault fieldis namePROJECT_DEFAULT or id. Single quote the key:value pair if it containswith options: PROJECT_LEAD, PROJECT_DEFAULT, COMPONENT_LEAD or aUNASSIGNED comma (,) or line breaksblank). [--fieldafter <field><after>] FieldVersion name or id. For some actions, this parameter must be a custom field to add a version after. Defaults to after last version. Use -1 to make it the first version. [--field2board <field2><board>] FieldAgile name or id for a custom fieldboard name. [--fieldExcludesissue <fieldExcludes><issue>] FieldsIssue tokey exclude from cloning - comma separated list of fieldsor id. [--datetoIssue <date><toIssue>] ReleaseTarget dateor forlink versiondestination orissue duekey dateor for issueid. [--startDateparent <startDate><parent>] DateParent issue versionkey wasor startedid. [--typesummary <type><summary>] IssueSummary type - name or id. Also, content type for renderRequest and application type. of issue. [--resolutionpriority <resolution><priority>] Issue priority Resolution- name or id. [--labelsreporter <labels><reporter>] LabelsIssue orreporter tags. A blank separated listuser id. [--workflowassignee <workflow><assignee>] Workflow nameIssue assignee user id. In some contexts, use -1 for automatic assignment and "" for unassigned. [--transitionsecurity <transition><security>] WorkflowIssue transitionsecurity -level name or id. [--stepenvironment <step><environment>] Deprecated. Now called transitionIssue environment. [--commentcomponent <comment><component>] Project Commentcomponent forname anor issueid. [--filtertoComponent <filter><toComponent>] FilterProject id or favorite filter name. Use for getIssueList is deprecated. Use JQL insteadcomponent name or id. [--jqlcomponents <jql><components>] JQLProject query.components Alternate- waycomma toseparated searchnames foror issuesids. for getIssueList and runFromIssueList [--version continue<version>] to use search parameter for Project version name or id compatibilityor withadd-on previousversion. [--searchaffectsVersions <search><affectsVersions>] SearchAffects JQLversions query- usingcomma legacyseparated support.names Deprecated. Use jql parameter instead for new supportor ids. [--regexfixVersions <regex><fixVersions>] Fix versions Regular- expressioncomma forseparated includingnames matchingor contentids. For example, used to subset projects or versions on getProjectList and[--custom <custom>] A list of custom field key:value runFromVersionListpairs. Normally a comma [--regex2 <regex2>] Regular expression for secondary content matching. In some cases, filtering on a secondary field may be needed. [--reference <reference>]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 Referenceis to use a replacementJSON keyformatted valuestring used to rememberrepresent lastthe createdlist issueof key:value pairs. [--linkfield <link><field>] Link descriptionField name or id. UsuallyFor linksome typeactions, namethis forparameter localmust linksbe anda relationshipcustom descriptionfield. for remote links.The link id can also [--field2 <field2>] Field name beor usedid for botha linkIssuecustom and deleteLinkfield. [--reverseLinkfieldExcludes <reverseLink><fieldExcludes>] LinkFields descriptionto forexclude thefrom (optional) reverse link for addRemoteLinkcloning - comma separated list of fields. [--valuedate <value><date>] Release date Singlefor fieldversion or due date propertyfor valueissue. [--valuesstartDate <values><startDate>] CommaDate separatedversion list of field values. Single quote values containing commaswas started. [--values2issueType <values2><issueType>] CommaIssue separatedtype list- ofname field values. Single quote values containing commasor id. [--timeSpenttype <timeSpent><type>] TimeIssue spenttype on(alternative work using. Example: 3h 30m. [--estimate <estimate>] to issueType), custom field type, link type, transition function type, application link type, Estimate of time remainingproject fortype, an issue. Example: 3h 30mboard type, and content type for renderRequest. [--originalEstimateresolution <originalEstimate><resolution>] OriginalResolution estimatename of time to complete work for an issue. Example: 3h 30m. or id. [--idlabels <id><labels>] Numeric id of an itemLabels or tags. A blank separated list. [--propertyPrefixworkflow <propertyPrefix><workflow>] Prefix used for accessing properties for custom clone actionsWorkflow name. [--jsptransition <jsp><transition>] Workflow Customtransition JSP- name foror clone actionsid. Deprecated. [--requeststep <request><step>] URLSource step fragmentname for a requestaddTransition. [--requestParametersscreen <requestParameters><screen>] URLTransition requestscreen parametersname. [--requestTypefilter <requestType><filter>] TypeFilter ofid aor renderfavorite request like GET or POST (default: GET)filter name. Use for getIssueList is deprecated. Use JQL instead. [--acceptTypejql <acceptType><jql>] JQL Content typequery. Alternate way to acceptsearch for renderRequestissues iffor differentgetIssueList thanand type.runFromIssueList - continue to [--limit <limit>] use search parameter for Maximum number of entriescompatibility towith returnprevious. (default: 2147483647) [--apisearch <api><search>] APISearch version.JQL Somequery requestsusing producelegacy differentsupport. resultsDeprecated. basedUse onjql theparameter apiinstead versionfor used.new Deprecatedsupport. (default: latest) [--roleregex <role><regex>] UserRegular expression rolefor inincluding projectmatching content. For [--group <group>] example, used to subset projects or versions on getProjectList and Group namerunFromVersionList. [--defaultGroupregex2 <defaultGroup><regex2>] DefaultRegular groupexpression tofor transfersecondary commentcontent andmatching. worklogIn visibilitysome settingscases, tofiltering on removeGroup a secondary field may be needed. [--userIdlink <userId><link>] User idLink description. Usually link type name for userlocal managementlinks and relationship otherdescription actions.for Forremote some actions, a comma separated list of ids.links.The link id can also [--newUserId <newUserId>] be used for both linkIssue and deleteLink. Used to assign a new user id to an existing user. Since JIRA 6.1[--reverseLink <reverseLink>] Link description for the (optional) reverse link for addRemoteLink. [--userKeyvalue <userKey><value>] UniqueSingle internalfield identifieror for user management. Since JIRA 6.1property value. [--userFullNamevalues <userFullName><values>] Comma separated list of field Uservalues. nameSingle forquote uservalues managementcontaining actionscommas. [--userEmailvalues2 <userEmail><values2>] Comma separated list of field Uservalues. emailSingle forquote uservalues managementcontaining actionscommas. [--userPasswordtimeSpent <userPassword><timeSpent>] User password for user management actionsTime spent on work using. Example: 3h 30m. [--autoGroupestimate <estimate>] GroupsEstimate areof automaticallytime addedremaining whenfor referencedan inissue. addExample: user3h functions30m. [--permissionSchemeoriginalEstimate <permissionScheme><originalEstimate>] Original Permission scheme name or id. (default: Default Permission Scheme)estimate of time to complete work for an issue. Example: 3h 30m. [--notificationSchemeid <notificationScheme><id>] NotificationNumeric schemeid nameof oran iditem. [--issueSecuritySchemepropertyPrefix <issueSecurityScheme><propertyPrefix>] IssuePrefix securityused schemefor nameaccessing orproperties idfor custom clone [--workflowScheme <workflowScheme>] Workflow scheme name or id. Use blank for default scheme. [--issueTypeScheme <issueTypeScheme>actions. Requires Clone Plus for JIRA be installed on the server. [--request <request>] IssueURL type scheme name or id. Use blank fragment for defaulta schemerequest. [--issueTypeScreenSchemerequestParameters <issueTypeScreenScheme><requestParameters>] IssueURL typerequest screenparameters scheme name or id. Use blank for default scheme. JIRA 5.1 and later onlypost data.. [--fieldConfigurationSchemerequestType <fieldConfigurationScheme><requestType>] FieldType configurationof schemea namerender orrequest id.like UseGET blankor forPOST (default: scheme.GET) [--categoryacceptType <category><acceptType>] ProjectContent category.type Administratorto accessaccept requiredfor torenderRequest seeif ordifferent usethan project categoriestype. [--templatelimit <template><limit>] ProjectMaximum template.number JIRAof 6.3entries andto abovereturn. Project template name to use (case sensitive(default: 2147483647) as found on the Create project dialog.[--role <role>] User role Ifin aproject template is not found, a list of valid templates will be shown in the error message [--group <group>] Group name. [--exportTypedefaultGroup <exportType><defaultGroup>] Default PROJECTgroup to export project information, PARTICIPANTS to export issue participants. Use comman separated list if more than one are neededtransfer comment and worklog visibility settings to on removeGroup. [--userId <userId>] User id for user management and other actions. For some actions, a comma separated list of ids. [--loginnewUserId <login><newUserId>] Login token from previous login requestUsed to assign a new user id to an existing user. [--targetServeruserKey <targetServer><userKey>] TargetUnique serverinternal URLidentifier for copyuser requestsmanagement. [--targetUseruserFullName <targetUser><userFullName>] TargetUser servername for user. Defaultsmanagement to useractions. [--targetPassworduserEmail <targetPassword><userEmail>] User Targetemail serverfor user password. Defaults to passwordmanagement actions. [--autoVersionuserPassword <userPassword>] AutomaticallyUser addpassword versionsfor useduser in affectsVersions and fixVersions parametersmanagement actions. [--autoComponentautoGroup] Groups Automaticallyare automatically addadded componentswhen usedreferenced in componentsadd user parameterfunctions. [--autoAdjustpermissionScheme <permissionScheme>] AutoPermission scheme adjustname remainingor estimate when adding work entry.id. (default: Default Permission Scheme) [--asVersionnotificationScheme <notificationScheme>] InterpretNotification valuesscheme parameter as version values and convert each to the version name or id. [--asComponentissueSecurityScheme <issueSecurityScheme>] InterpretIssue valuessecurity parameterscheme asname componentor values and convert each to the component id. id [--asCascadeSelectworkflowScheme <workflowScheme>] InterpretWorkflow scheme valuesname parameteror asid. aUse cascadeblank selectfor valuedefault idsscheme. [--appendTextissueTypeScheme <issueTypeScheme>] AppendIssue texttype toscheme existingname valueor textid. forUse description,blank environment,for and single and multi-value custom fieldsdefault scheme. [--subtractissueTypeScreenScheme <issueTypeScreenScheme>] Subtract values from existing values custom fields supporting multiple valuesIssue type screen scheme name or id. Use blank for default scheme. [--suppressIdfieldConfigurationScheme <fieldConfigurationScheme>] Suppress showing anField configuration scheme name or id. whenUse displayingblank issuefor fieldsdefault on getIssuescheme. [--withIdcategory <category>] DisplayProject thecategory. issueAdministrator fieldaccess valuerequired includingto thesee internalor iduse (ifproject thecategories. field has an internal value) using the following format:[--template <template>] Project template or shared value (id). [--exportAttachments] Export attachments and similar data for site export. [--copyLinks] Copy issue links when cloning an issue. [--copyAttachments] project key, name, or id (createProject action only). Project template names (case sensitive) can be found on the 'Create project' dialog. If a project template is not found, a list of valid templates will be shown in the Copy attachments when cloning an issueerror message. [--copyCommentsexportType <exportType>] Copy comments when cloning an issue. [--copyWatchers] PROJECT to export project information, PARTICIPANTS to export issue participants. Use comman separated list if more than one Copy Watchers when cloning anare issueneeded. [--copySubtaskslogin <login>] CopyLogin subtaskstoken whenfrom cloningprevious anlogin issuerequest. [-l|-copySubtaskEstimates-loginFromStandardInput] CopyGet subtasklogin estimatestoken whenfrom cloningstandard an issueinput. [--useParentVersionsfunctionKey <functionKey>] CopyTransition parentfunction's versionsunique tokey. subtask when cloning an issue.Example: org.swift.jira.cot:createissue-function [--cloneIssuestargetServer <targetServer>] CloneTarget issuesserver whenURL cloningfor acopy projectrequests. [--copyVersionstargetUser <targetUser>] CopyTarget versionsserver whenuser. cloningDefaults ato projectuser parameter. [--copyComponentstargetPassword <targetPassword>] Target server Copyuser componentspassword. whenDefaults cloningto apassword projectparameter. [--copyRoleActorsautoVersion] Automatically Copyadd projectversions roleused actorsin whenaffectsVersions cloningand afixVersions projectparameters. [--replaceautoComponent] Replace existing entityAutomatically add components used in components parameter. [--activateautoAdjust] Auto Activate useradjust remaining estimate when adding work entry. [--deactivateasVersion] Deprecated. Ignored Deactivate useron JIRA 7.x. [--notifyasComponent] NotifyDeprecated. userIgnored afteron userJIRA is added7.x [--includeInactiveasCascadeSelect] ToDeprecatated. includeIgnored inactiveon users in a user listJIRA 7.x. [--deleteFilterappendText] AttemptAppend text to deleteexisting thevalue filtertext associatedfor withdescription, theenvironment, board.and Filtersingle mustand bemulti-value a findable as a favorite filtercustom fields. [--favoritesubtract] MarkSubtract avalues filterfrom asexisting avalues favoritecustom whenfields creatingsupporting or updating a filtermultiple values. [--lookupsuppressId] LookupSuppress userIdshowing viaan searchid andwhen validate.displaying Anissue errorfields is reported if search does not return a single useron getIssue. [--legacywithId] SomeDisplay capabilitiesthe haveissue newerfield impementationsvalue (likeincluding usingthe newerinternal REST APIs). In some cases, the older (deprecated) id (if the field has an internal value) using the following format: 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 casevalue (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. [--helpcopyWatchers] Prints this help messageCopy Watchers when cloning an issue. Valid actions (case insensitive): login - Login to remote server. Returns login token. Deprecated starting with 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 or project or issue Optional parameters: requestParameters, requestType, type, acceptType, findReplace, findReplaceRegex, file, encoding, run - Run actions from a file or standard input. Required parameters: file or standard input Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input Required parameters: sql or file or standard input Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromCsv - Run actions generated from a CSV file. Required parameters: file Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromList - Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement 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, runFromCommentList - Run action for each comment for an issue with optional regex filtering on the comment body. Available replacement variable is commentId. Required parameters: issue Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromRemoteLinkList - Run action for each remote link for an issue with optional filtering defined the same as for getRemoteLinkList[--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: issuepassword Optional parameters: link,user regex,logout regex2,- targetUser,Logout targetPassword,of limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, getProjectList - List defined projects with optional filtering by lead and regex on project keyremote server. getLoginInfo - Get login information for the current logged in user. getClientInfo - Get information about the this client tool. Optional parameters: leadoutputFormat, regexfile, outputFormatappend, file, columns, encoding Output formats: 1 - defaultbasic, 2 - schemesJVM, 99911 - all getProjectCategoryListaction list, 12 - Listparameter defined project categories. Optional parameters: file, append, columns, encoding getVersionList - List versions defined for a projects. Required parameters: project list getServerInfo - Get information about the JIRA server. Optional parameters: regexoutputFormat, filedateFormat, columnsfile, encoding, append, outputFormatencoding Output formats: 1 - defaultbasic, 2 - description,detail 999validateLicense - Validates the allCLI getComponentListConnector -is Listenabled componentsand definedlicensed foron athe projectsserver. renderRequest Required- parameters:Render projecturl based Optionalrequest. parameters:The limit,response regex,data file,modified columns,by encoding, append, outputFormatfindReplace processing is returned. OutputRequired formats: 1 - default, 2 - with project, 999 - all getSecurityLevelList - List security levels defined for a projectsparameters: 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: projectfile or standard input Optional parameters: file common, continue, simulate, columnsclearFileBeforeAppend, encoding, appendfindReplace, outputFormat Output formats: 1 - default, 999 - all getProjectRoleList - Get project roles. Optional parameters: regex, file, append, columns, encoding getProjectRoleActorList - Get users and groups for a project's role. Required parameters: project, role Optional parameters: file, columns, encoding getProjectRoleByUserList - Get project roles for a user across projects. By default all projects will be included. This action can take a long time to complete depending on number of projects and roles! Requires JIRA 7.0 or higher. Use userId of @all to product a list for all users. Use a regex pattern to subset projects to be included. Each role defines a column with a Yes or No value that indicates if the user is authorize to the project according to the role. This includes either directly authorized as a user or as a member of a group that is authorized. Use columns to subset the roles you want to display findReplaceRegex runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input Required parameters: sql or file or standard input Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromCsv - Run actions generated from a CSV file. Required parameters: file Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromList - Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variables are entry, entry2. Required parameters: list Optional parameters: list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromIssueList - Run actions for each issue from an issue list based on a filter or a search. Available replacement variables are project, issue, issueId. Required parameters: userId filter or jql or search or project Optional parameters: regex common, continue, simulate, limit, clearFileBeforeAppend, filefindReplace, appendfindReplaceRegex, columnsfile, encoding getIssueListrunFromProjectList - ListRun issuesactions for aeach JQLproject query,with filter, search oroptional filtering by project.lead and Requiredregex parameters:on filterproject orkey. jqlAvailable orreplacement searchvariables orare project, projectId. Optional parameters: filelead, dateFormatregex, limitcommon, withIdcontinue, suppressIdsimulate, outputFormatlimit, columnsclearFileBeforeAppend, encodingfindReplace, 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 historyfindReplaceRegex, 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: issueproject Optional parameters: fileregex, dateFormatcommon, columnscontinue, encoding getAttachmentList - Listsimulate, 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: filecommon, regexcontinue, dateFormatsimulate, columnslimit, encodingregex, appendclearFileBeforeAppend, outputFormatfindReplace, Output formats: 1 - default, 999 - all getCommentListfindReplaceRegex, file, encoding runFromGroupList - List of comment informationRun action for aneach issuegroup with optional regex filtering on (JIRAgroup 6name.4 andAvailable abovereplacement only)variable onis comment bodygroup. Required parameters: issue Optional parameters: file, regex, limit, outputFormatcontinue, dateFormatsimulate, columnsclearFileBeforeAppend, encodingfindReplace, append Output formats: 1 - default, 999 - all getWorkList - Get list of a work log entryfindReplaceRegex, file, encoding runFromCommentList - Run action for each comment for an issue with optional regex filtering on the comment body. Available replacement variable is commentId. Required parameters: issue Optional parameters: dateFormatregex, filelimit, columnscontinue, encodingsimulate, appendclearFileBeforeAppend, outputFormatfindReplace, findReplaceRegex, Outputfile, formats:encoding 999runFromRemoteLinkList - all getVoterList - Get list of users that have voted for an issue Run action for each remote link for an issue with optional filtering defined the same as for getRemoteLinkList. Required parameters: issue Optional parameters: outputFormatlink, appendregex, fileregex2, columnstargetUser, encodingtargetPassword, limit, Output formats: 1 - simple, 2 - CSV getWatcherList - Get list of users that are watching an issuecontinue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromUserList - Run action for each user with similar filtering as getUserList. Available replacement variable is userId. Required parameters: issue group or name or project and role Optional parameters: outputFormatregex, appendlimit, fileincludeInactive, columnscontinue, encodingsimulate, clearFileBeforeAppend, Output formats: 1 - simple, 2findReplace, findReplaceRegex, file, encoding runFromLinkList - CSVRun getLinkListaction -for Listeach issue linkslink for an issue or issues selected by JQL including filtering just like with getLinkList. Required parameters: issue or jql Optional parameters: filelimit, columnsregex, encodingoptions, appendcontinue, getLinkTypeListsimulate, -clearFileBeforeAppend, GetfindReplace, afindReplaceRegex, listfile, ofencoding allgetProjectList issue- linkList types.defined projects Optionalwith parameters:optional file,filtering columns,by encodinglead getCustomFieldListand -regex Get information on allproject custom fieldskey. Optional parameters: filelead, regex, outputFormat, appendfile, columns, encoding getFieldList -Output Getformats: information1 on all fields. Optional parameters: regex, file, append, columns, encoding getWorkflowList - Get list of a workflows matching selection criteria- default, 2 - schemes, 999 - all getProjectCategoryList - List defined project categories. Optional parameters: limit, regex, dateFormat, file, append, columns, encoding getBoardListgetVersionList - List Agileversions boardsdefined withfor optionala filteringprojects. by regexRequired onparameters: name.project Optional parameters: regex, file, append, columns, encoding, getIssueTypeListappend, -outputFormat List issue types valid for a project. If project is blank or @all, all issue types will be listed. Output formats: 1 - default, 2 - description, 999 - all getComponentList - List components defined for a projects. Required parameters: project Optional parameters: limit, projectregex, file, columns, encoding, append getStatusList, outputFormat Output formats: 1 - Listdefault, statuses.2 - Optionalwith parameters: file, encoding, append getTransitionListproject, 999 - all getSecurityLevelList - GetList availablesecurity workflowlevels transitionsdefined for ana issueprojects. Required parameters: issueproject Optional parameters: outputFormatfile, columns, fileencoding, append, encodingoutputFormat Output formats: 1 - basicdefault, 2999 - fieldsall getAvailableStepsgetProjectRoleList - DeprecatedGet - getTransitionList is recommendedproject roles. Get availableOptional workflow steps for issueparameters: regex, file, append, columns, encoding getProjectRoleActorList - Get users and groups for a project's role. Required parameters: project, issuerole Optional parameters: file, appendcolumns, encoding getUserListgetProjectRoleByUserList - Get Listproject usersroles fromfor a group or a search by name fragment (userId, display name, and email). Use name user across projects. By default all projects will be included. This action can take a long time to complete depending on number of projects and roles! Use userId of @all to searchproduct a list for all users. OrUse usea projectregex andpattern role to getsubset allprojects usersto thatbe areincluded. partEach ofrole thedefines role for the project specified. Email only works if email visibiliity is on and for leading characters only. Include inactive only works for user name searches. Required parameters: group or name or project and role Optional parameters: limit, regex, includeInactive, file, columns, encoding, append, outputFormat Output formats: 1 - basic, 2 - extended attributes, 999 - all getGroupLista column with a Yes or No value that indicates if the user is authorize to the project according to the role. This includes either directly authorized as a user or as a member of a group that is authorized. Use columns to subset the roles you want to display. Required parameters: userId Optional parameters: regex, file, append, columns, encoding getFilterList - Get a list of groups with optional filteringfilters for the current user. On Server or if favorite is specified, the current users favorite filters will be listed. Otherwise, the filters owned by the current user will be listed. Subset the list by regex pattern on groupthe filter name. Optional parameters: limitfavorite, regex, file,limit encoding,getIssueList append- createProjectList -issues Createfor a newJQL projectquery, withfilter, keysearch providedor by project parameter. Required parameters: filter project, lead or jql or search or project Optional parameters: namefile, descriptiondateFormat, urllimit, defaultAssigneewithId, lookupsuppressId, templateoutputFormat, permissionSchemecolumns, notificationSchemeencoding, issueSecurityScheme, append workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category updateProject - Update project information. Scheme updates require compatible schemes. Required parameters: project Optional parameters: name, description, lead, url, defaultAssignee, permissionScheme, notificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category cloneProject - Create a new project as a clone of a base project (only issue security, notification, and permission schemes will be copied to clone, some other fields are also not available to be copied to the clone). Optionally copy versions, components, role actors, and issues to new project. Depending on parameters used, issue cloning may require Clone Plus for JIRA - see [CLI Issue Cloning] has more details. Provide a search parameter to subset the issues to be clonedOutput 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, limit, regex, dateFormat, columns, encoding, append, outputFormat Output formats: 1 - default, 999 - all getCommentList - List of comment information for an issue with regex filtering on comment body. Required parameters: project, toProjectissue Optional parameters: namefile, descriptionregex, urllimit, permissionSchemeoutputFormat, notificationSchemedateFormat, columns, issueSecuritySchemeencoding, append workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category, search, type, continue, copyVersions, autoVersion, copyComponents, autoComponent, copyRoleActors, cloneIssues, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix, jsp deleteProject - Delete a project. Use continue to ignore a not found error Output formats: 1 - default, 999 - all getWorkList - Get list of a work log entry. Required parameters: issue Optional parameters: dateFormat, file, columns, encoding, append, outputFormat Output formats: 999 - all getVoterList - Get list of users that have voted for an issue. Required parameters: projectissue Optional parameters: continueoutputFormat, getProjectappend, -file, Getcolumns, projectencoding information. Output Required parametersformats: project1 - Optionalsimple, parameters:2 suppressId,- fileCSV, encoding createBoard999 - Createall angetWatcherList Agile- board.Get Typelist isof anyusers supportthat typeare likewatching scrum, kanban, or diyan issue. Project isRequired aparameters: commaissue separated listOptional ofparameters: projectsoutputFormat, identified by keyappend, file, namecolumns, or id.encoding RequiredOutput parametersformats: name, type1 - simple, project2 deleteBoard - DeleteCSV, an999 Agile- board.all UsegetLinkList continue- toList ignoreissue notlinks foundfor errors.an issue Requiredor parameters:issues idselected or board Optional parameters: continue createFilter - Create a filterby JQL. Filter by regex pattern matching link name or description. Setting options parameter to one of outward or inward will additionally filter by link direction. Required parameters: name, searchissue or jql Optional parameters: descriptionlimit, favoriteregex, updateFilteroptions, -file, Updatecolumns, aencoding, filterappend bygetLinkTypeList id- orGet filtera namelist (ifof itall isissue a favorite filter)link types. RequiredOptional parameters: id of filterfile, columns, encoding getCustomFieldList - Get information on all custom fields. Optional parameters: namefile, searchappend, descriptioncolumns, favoriteencoding getFiltergetFieldList - Get information abouton aall filterfields. Filter by id or filter name (if it is a favorite filter)regex. RequiredOptional 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 filterregex, file, append, columns, encoding getWorkflowList - Get list of a workflows matching selection criteria. Optional parameters: limit, regex, dateFormat, file, append, columns, encoding getBoardList - List Agile boards with optional filtering by regex on name. 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, versionregex, 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: project, file, columns, encoding, append getStatusList - List statuses in their customized order. If project is specified, only statuses for valid for the project will be listed. Optional parameters: dateFormatproject, file, encoding, append addVersiongetTransitionList - AddGet aavailable newworkflow versiontransitions tofor aan projectissue. Required parameters: project,issue version Optional parameters: descriptionoutputFormat, afterfile, dateappend, encoding startDate, dateFormat,Output replaceformats: updateVersion1 - Updatebasic, version2 for- afields project.getAvailableSteps Required parameters: project, version- Deprecated - getTransitionList is recommended. Get available workflow steps for issue. OptionalRequired parameters: name,issue description, after, date, startDateOptional parameters: file, dateFormatappend, autoVersionencoding copyVersiongetUserList - CopyList a versionusers 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 errora 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: group or name or project, and versionrole Optional parameters: affectsVersionslimit, fixVersionsregex, autoVersionincludeInactive, continuefile, releaseVersioncolumns, -encoding, Releaseappend, aoutputFormat version forOutput aformats: project.1 Resets- releasebasic, date2 if- provided.extended Defaultsattributes, to999 current- serverall dategetGroupList if- releaseGet datea list isof notgroups set.with Useoptional continuefiltering toby ignoreregex erroron whem that the version is already in the correct stategroup name. RequiredOptional parameters: projectlimit, version Optional parameters: dateregex, dateFormatfile, descriptionencoding, continueappend unreleaseVersioncreateProject - UnreleaseCreate a version for a project, optionally reset release date. Use continue to ignore error when the version is already in the correct state 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, versionlead Optional parameters: datename, dateFormatdescription, descriptionurl, defaultAssignee, continuelookup, archiveVersiontemplate, -permissionScheme, ArchivenotificationScheme, aissueSecurityScheme, 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 workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category updateProject - Update project information. Scheme updates require compatible schemes. Required parameters: project, version Optional parameters: name, description, continuelead, unarchiveVersionurl, -defaultAssignee, Unarchive apermissionScheme, versionnotificationScheme, forissueSecurityScheme, aworkflowScheme, project. ThisissueTypeScheme, makesissueTypeScreenScheme, thefieldConfigurationScheme, versioncategory visiblecloneProject again- inCreate thea UI.new Useproject continueas toa ignoreclone errorof whena the version is already in the correct state. Required parameters: project, version Optional parameters: description, continue getComponent - Get information for a component of abase project (only issue security, notification, and permission schemes will be copied to clone, some other fields are also not available to be copied to the clone). Parameters specified will override the setting copied from the base project. Required parameters: project, componentOptionally copy versions, components, role actors, and issues to new project. OptionalProvide parameters:a file,search encodingparameter addComponentto -subset Addthe componentissues to abe projectcloned. Required parameters: project, componenttoProject Optional parameters: name, description, leadurl, defaultAssigneepermissionScheme, replace updateComponent - Update component for a project. Required parameters: project, component Optional parameters: name, description, lead, defaultAssignee deleteComponentnotificationScheme, issueSecurityScheme, workflowScheme, issueTypeScheme, issueTypeScreenScheme, fieldConfigurationScheme, category, search, type, continue, copyVersions, autoVersion, copyComponents, autoComponent, copyRoleActors, cloneIssues, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix deleteProject - Delete component from a project. Use continue to ignore componenta not found error. Required parameters: project, component Optional parameters: continue copyComponentgetProject - Copy a component from one project to the same project or another projectGet project information. Required parameters: project, component Optional parameters: toProjectsuppressId, toComponentfile, name,encoding description,createBoard lead,- defaultAssignee,Create replacean copyComponentsAgile -board. CopyType allis orany somesupport componentstype fromlike onescrum, projectkanban, toor anotherdiy. Project Requiredis parameters:a project,comma toProjectseparated list Optionalof parameters:projects components,identified replaceby addProjectRoleActors - Add users or groups to a project rolekey, name, or id. Required parameters: projectname, roletype, userIdproject ordeleteBoard group- copyProjectRoleActorsDelete -an CopyAgile allboard. roleUse actorscontinue fromto aignore projectnot tofound another projecterrors. Required parameters: project, toProjectid or board Optional parameters: continue removeProjectRoleActorscreateFilter - Remove users or groups from a project roleCreate a filter. Required parameters: projectname, role, userId or group addCustomFieldsearch Optional parameters: description, favorite updateFilter - AddUpdate a newfilter customby field.id Typeor mustfilter bename a(if valid custom field type key. Optionally, search can be a valid search template keyit is a favorite filter). Required parameters: field, typeid of filter Optional parameters: name, search, description, searchfavorite removeCustomFieldgetFilter - RemoveGet information about a customfilter field by nameid or id.filter Usename continue(if toit ignoreis a not defined errorfavorite filter). Required parameters: field Optional parameters: continue createIssue - Create a new issue for a project or a subtask of a parent issue 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: type,id project or parentfilter Optional parameters: summary, reference, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, estimate, originalEstimate, comment, group, role, labels, findReplace, findReplaceRegex, file, encoding, deleteIssue - Delete an issue. Use continue to ignore error if the issue does not exist 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, issueversion 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. On JIRA 7.0 and higher, specifying the parent parameter will allow a subtask to be cloned to a different parent. Some advanced options require Clone Plus for JIRA be installed. [CLI Issue Cloning] has more detailsdescription, 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: issueproject, toProject Optional parameters: parentcontinue, type,replace summary,deleteVersion resolution,- labels,Delete a comment,version group,from role, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, 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, toProject, reference, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, fieldExcludes, propertyPrefix, jsp cloneIssues - Clone issues returned from a JQL search. Advanced options may require the Clone Plus for JIRA be installed. [CLI Issue Cloning] has more details 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: jqlissue, labels Optional parameters: toProject, type, continue, copyLinks, copyAttachments, copyComments, copyWatchers, copySubtasks, copySubtaskEstimates, useParentVersions, autoVersion, autoComponent, fieldExcludes, propertyPrefix, jsp updateIssue - Update an existing 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 parameter value to for the description and environment fields. Use append to modify the fix versions or affects versions fields by their respective values 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: typefield2, summaryvalues2, resolutionsuppressNotify, labelsappendText, priorityappend, reportersubtract, assigneeencoding, description,dateFormat components,modifyFieldValue affectsVersions,- fixVersions,Modify environment, security,the current field, value, values,for field2,an values2,issue asVersion,with asComponent,find asCascadeSelect, lookup,replace logic. date Required parameters: issue, dateFormatfield, custom,findReplace autoVersion,or autoComponent,findReplaceRegex , estimate, originalEstimate, appendOptional parameters: dateFormat, appendTextautoVersion, continueautoComponent, comment,suppressNotify group,copyFieldValue role,- ,Copy findReplace,field findReplaceRegex,value file,from encoding,an issue updateOrCreateIssueto -a Searchfield forof ananother issue using JQL. If a Warning: singleonly issueworks isfor found,fields updatethat it.can Ifbe noupdated issuefrom istheir found, create ittext representation. Required parameters: jqlissue, typefield, projecttoIssue or parentfield2 Optional parameters: summarysuppressNotify, resolutionappend, labelsappendText, priority, reporter, assignee, description, components, affectsVersions, fixVersions, environment, security, field, value, values, field2, values2, asVersion, asComponent, asCascadeSelect, lookup, date, dateFormat, custom, autoVersion, autoComponent, estimate, originalEstimate, append, appendText, continue, comment, group, role, 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, filename, encoding, getAttachment getIssue - Get information about lastest attachment by name or id for an existing issue. Required parameters: issue, file Optional parameters: filename, dateFormat,encoding asVersion,removeAttachment suppressId,- encodingRemove an Outputattachment formats:from 1an -issue. default,A 999single -attachment allis assignIssueremoved -by Assignid anor isssueall toattachments amatching userId.the Usefile @defaultname. for userIdRequired toparameters: setissue, thename assigneeor toid the project default. Use blank to set the assignee to nullcopyAttachments - Copy attachments from an issue to another issue. Required parameters: issue, toIssue Optional parameters: name, userIdregex transitionIssueaddWatchers - Transition issue through workflow Add watchers to an issue. A comma separated list of user ids can be specified. Required parameters: issue, transition, continue Optional parameters: typeuserId, summarylookup, resolution,continue labels,removeWatchers - priority,Remove reporter,watchers assignee,from 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, progressIssue - Progress (transition) issue through workflow. Deprecated in favor of transitionIssue which uses better terminologyan 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, steptimeSpent Optional parameters: typecomment, summarydate, resolutiondateFormat, labelsestimate, role, prioritygroup, reporter,autoAdjust assignee,removeWork description,- components,Remove affectsVersions,work fixVersions, environment,log entry. 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 anRequired 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, , findReplace, findReplaceRegex, file, encoding, getComment deleteLink - Remove link to another issue. Required parameters: issue, toIssue, link getUser - Get commentuser information. When Requiredname parameters:is issueused, 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 bodythe 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, issueuserEmail Optional parameters: commentuserFullName, groupuserPassword, rolenotify, ,preserveCase findReplace,addUserWithFile findReplaceRegex,- file,Add encoding,users from getCommentscomma -separated Getfile. aDeprecated formatted- stringuse ofrunFromCsv allsupport commentwith text for an issueaddUser instead. Required parameters: issuefile Optional parameters: filenotify, dateFormatpreserveCase, encoding addLabelsupdateUser - AddUpdate labelsuser toinformation anor issue. Requires labels are available for edit on the issue screenstatus. Required parameters: userId or userKey Optional parameters: userFullName, userEmail, newUserId, activate, deactivate removeUser - Remove a user. Required parameters: issue,userId labelsremoveUserWithFile removeLabels - Remove labelsusers from ancomma separate issuefile. RequiresDeprecated labels- areuse availablerunFromCsv forsupport editwith on the issue screenremoveUser instead. Required parameters: issue, labels getFieldValue - Get field value for an issuefile Optional parameters: encoding addGroup - Add a new group. Required parameters: issue,group field Optional parameters: file, dateFormat, asVersion, 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 specifiedpreserveCase removeGroup - Remove a group. Required parameters: group Optional parameters: defaultGroup addUserToGroup - Add user to a group. Required parameters: issueuserId, field, file or value or valuesgroup Optional parameters: field2autoGroup, values2,preserveCase asVersion,addUserToGroupWithFile asComponent,- asCascadeSelect,Add appendText,users append,to subtract,groups encoding,from dateFormatcomma modifyFieldValueseparated -file. ModifyDeprecated the- currntuse fieldrunFromCsv valuesupport forwith anaddUserToGroup issueinstead. with findRequired replaceparameters: logic.file RequiredOptional parameters: issueautoGroup, fieldpreserveCase, findReplace or findReplaceRegexencoding removeUserFromGroup - Remove user from a group. OptionalRequired parameters: dateFormatuserId, autoVersion, autoComponent copyFieldValue - Copy field value from an issue to a custom field of another issue. Warning: only works for fields that can be updated from their text representation 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: issueuserId, fieldname, toIssue orvalue field2 Optional parameters: asVersion, asComponent, asCascadeSelect, append, appendText, encoding, dateFormat addAttachment - Add an attachment to an issuelookup removeUserProperty - Remove a user's property. Required parameters: userId, name Optional parameters: lookup getWorkflow - Get workflow information. Required parameters: issue,workflow file Optional parameters: findReplacedateFormat, findReplaceRegexfile, name, encoding getAttachmentimportWorkflow - Get lastest attachment by name or id for an issue Import workflow from XML. Required parameters: issueworkflow, file Optional parameters: namedescription, findReplace, findReplaceRegex, encoding removeAttachmentexportWorkflow - RemoveExport anworkflow attachment from an issueto XML. A singleRequired attachmentparameters: isworkflow removed by id or all attachments matching the file name. Required parameters: issue, name or id copyAttachments - Copy attachments from an issue to another issueOptional parameters: file, encoding deleteWorkflow - Delete an inactive workflow. Inactive means it is not associated with any project. Required parameters: issue,workflow toIssue Optional parameters: name,continue regexrunFromWorkflowList addWatchers- -Run Addaction watchersfor toeach anworkflow issue.with Aregex commafiltering separatedon listworkflow ofname. userAvailable idsreplacement canvariable beis specifiedworkflow. RequiredOptional parameters: issue Optional parameters: userId, lookup, continue removeWatchers - Remove watchers from an issue. A comma separated list of user ids can be specified 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: issueworkflow, name 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 entrydescription addTransition - Add a transition to a workflow. Use name for the transition name. Step represents the source step and transition the target step which defaults to step. Transition screen defaults to none. Required parameters: issueworkflow, name, timeSpentstep Optional parameters: commentdescription, datetransition, 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 issuescreen addTransitionFunction - Add a transition function (post function or validator type) to a workflow transition. Function configuration is just field/values pairs and is provided using the same parameters as for setting custom field configuration - custom and related parameters. Required parameters: issueworkflow, transition, toIssuestep, linkfunctionKey Optional parameters: commenttype, custom, field, groupvalues, rolefield2, values2 deleteLinkassociateWorkflow - RemoveAssociate linkworkflow to anothera workflow issuescheme. Required parameters: issue, toIssue, link getUser - Get user information. When name is used, the name search must return a single username, workflowScheme createWorkflowScheme - Create a workflow scheme using a default workflow. Required parameters: name, workflow Optional parameters: description getWorkflowScheme - Get workflow scheme information. Required parameters: userId or userKey or name Optional parameters: file, endcodingencoding addUserdeleteWorkflowScheme - AddDelete aan newinactive user. Prior to JIRA 7.0, an email is automatically sent to the user. For JIRA 7.0 and higher, specify notify to send an email. Required parameters: userId, userEmailworkflow scheme. Required parameters: id or name Optional parameters: continue getWorkflowSchemeList - Get list of a workflow schemes matching selection criteria. Optional parameters: userFullNamelimit, userPasswordregex, notifyfile, preserveCaseappend, addUserWithFilecolumns, -encoding Add usersOutput fromformats: comma1 separated- file.basic, Deprecated2 - usedetail runFromCsvrunFromWorkflowSchemeList support- withRun addUseraction instead.for each Requiredworkflow parameters:scheme filewith regex Optionalfiltering parameters:on notify,workflow preserveCase,scheme encodingname. updateUserAvailable -replacement Updatevariables userare informationscheme orand statusschemeId. RequiredOptional parameters: userIdregex, orlimit, userKeycontinue, simulate, Optional parameters: userFullNameclearFileBeforeAppend, findReplace, findReplaceRegex, userEmailfile, newUserId, activate, deactivate removeUser - Remove a userencoding getScreenList - Get a list of screens with optional regex filtering on name. RequiredOptional parameters: userIdregex, removeUserWithFilelimit, -file, Removeencoding, usersappend, fromclearFileBeforeAppend commagetScreenSchemeList separate- file.Get Deprecateda -list useof runFromCsvscreen supportschemes with removeUser instead optional regex filtering on name. RequiredOptional parameters: regex, limit, file, encoding, Optionalappend, parameters:clearFileBeforeAppend encodinggetIssueTypeScreenSchemeList addGroup - AddGet a new group. Required parameters: group list of issue type screen schemes with optional regex filtering on name. Optional parameters: preserveCaseregex, removeGrouplimit, -file, Removeencoding, aappend, group.clearFileBeforeAppend getIssueTypeSchemeList Required- parameters:Get groupa list Optionalof parameters:issue defaultGrouptype addUserToGroupschemes -with Addoptional userregex tofiltering aon groupname. RequiredOptional parameters: userIdregex, grouplimit, file, Optional parameters: autoGroupencoding, append, preserveCaseclearFileBeforeAppend addUserToGroupWithFilegetFieldConfigurationSchemeList - AddGet usersa tolist groupsof fromfield commaconfiguration separatedschemes file.with Deprecatedoptional -regex usefiltering runFromCsv support with addUserToGroup insteadon name. RequiredOptional parameters: fileregex, limit, Optional parameters: autoGroupfile, encoding, preserveCaseappend, encodingclearFileBeforeAppend removeUserFromGroupgetFieldConfigurationList - Remove user from a group Get a list of field configurations with optional regex filtering on name. RequiredOptional parameters: userIdregex, grouplimit, removeUserFromGroupWithFilefile, -encoding, Removeappend, usersclearFileBeforeAppend fromgetPermissionSchemeList groups- fromGet commaa separatedlist file.of Deprecatedpermission -schemes usewith runFromCsvoptional supportregex withfiltering removeUserFromGroupon insteadname. RequiredOptional parameters: regex, limit, file Optional parameters: encoding updateUserProperty - Add or update a user's property, encoding, append, clearFileBeforeAppend getNotificationSchemeList - Get a list of notification schemes with optional regex filtering on name. RequiredOptional parameters: userIdregex, namelimit, valuefile, encoding, Optionalappend, parameters:clearFileBeforeAppend lookupgetIssueSecuritySchemeList removeUserProperty - RemoveGet a user's property list of issue security schemes with optional regex filtering on name. RequiredOptional parameters: userIdregex, namelimit, file, Optional parameters: lookup getWorkflowencoding, append, clearFileBeforeAppend runFromScreenList - GetRun workflow information. Required parameters: name Optional parameters: dateFormat, file, encoding importWorkflow - Import workflow from XMLaction for each screen with optional regex filtering on name. Available replacement variables are screen and screenId. RequiredOptional parameters: nameregex, filelimit, continue, Optional parameters: descriptionsimulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding exportWorkflowrunFromScreenSchemeList - ExportRun workflowaction tofor XML.each screen Requiredscheme parameters:with nameoptional regex Optionalfiltering parameters: file, encoding deleteWorkflow - Delete an inactive workflow. Inactive means it is not associated with any project. Required parameters: name Optional parameters: continue runFromWorkflowListon name. Available replacement variables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding runFromIssueTypeScreenSchemeList - Run action for each workflow issue type screen scheme with optional regex filtering on workflow name. Available replacement variable is workflowvariables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueTypeSchemeList associateWorkflow- -Run Associateaction workflowfor toeach aissue workflowtype scheme. with Requiredoptional parameters:regex name,filtering workflowSchemeon createWorkflowSchemename. -Available Createreplacement avariables workfloware scheme using a default workflowand schemeId. RequiredOptional parameters: name regex, limit, continue, simulate, workflowclearFileBeforeAppend, findReplace, Optional parameters: description getWorkflowScheme - Get workflow scheme information. Required parameters: namefindReplaceRegex, file, encoding runFromFieldConfigurationSchemeList - Run action for each field configuration scheme with optional regex filtering on name. Available replacement variables are fieldConfiguration and fieldConfigurationId. Optional parameters: file regex, limit, continue, encodingsimulate, deleteWorkflowSchemeclearFileBeforeAppend, -findReplace, DeletefindReplaceRegex, anfile, inactiveencoding workflowrunFromFieldConfigurationList scheme.- Run Requiredaction parameters:for nameeach field Optionalconfiguration parameters:with continueoptional getWorkflowSchemeListregex -filtering Geton listname. ofAvailable areplacement workflowvariables schemesare matchingscheme selectionand criteriaschemeId. Optional parameters: regex, limit, continue, regexsimulate, clearFileBeforeAppend, filefindReplace, appendfindReplaceRegex, columnsfile, encoding runFromWorkflowSchemeListrunFromPermissionSchemeList - Run action for each workflowpermission scheme with optional regex filtering on workflow scheme name. Available replacement variable is workflowSchemevariables are scheme and schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromScreenListrunFromNotificationSchemeList - Run action for each notification screenscheme with optional regex filtering on name. Available replacement variables are screenIdscheme and screenNameschemeId. JIRA 6.4 and higher. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromScreenSchemeListrunFromIssueSecuritySchemeList - Run action for each issue screensecurity scheme with optional regex filtering on name. Available replacement variables are schemeIdscheme and schemeName. JIRA 6.4 and higher. schemeId. Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueTypeScreenSchemeListdeleteScreen - RunDelete actiona forscreen eachby issueid. type screenRequired schemeparameters: withid optional regexOptional filteringparameters: oncontinue name.deleteScreenScheme Available- replacementDelete variablesa arescreen schemeIdscheme andby schemeNameid. JIRA 6.4 and higher.Required parameters: id Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, runFromIssueTypeSchemeList - Run action for each issue type scheme with optional regex filtering on name. Available replacement variables are schemeId and schemeName. JIRA 6.4 and higher. continue deleteIssueTypeScreenScheme - Delete an issue type screen scheme by id. Required parameters: id Optional parameters: continue deleteIssueTypeScheme - Delete an issue type scheme by id. Required parameters: id Optional parameters: continue deleteFieldConfiguration - Delete a field configuration by id. Required parameters: id Optional parameters: regex, limit, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding, deleteScreen deleteFieldConfigurationScheme - Delete a screenfield idconfiguration JIRAscheme 6.4 and higherby id. Required parameters: id Optional parameters: continue deleteScreenSchemedeletePermissionScheme - Delete a screenpermission scheme by id JIRA 6.4 and higher only. Required parameters: id Optional parameters: continue deleteIssueTypeScreenSchemedeleteNotificationScheme - Delete ana issuepermission type screen scheme by id JIRA 6.4 and higher. Required parameters: id Optional parameters: continue deleteIssueTypeSchemedeleteIssueSecurityScheme - Delete an issue typesecurity scheme by id JIRA 6.4 and higher. Required parameters: id Optional parameters: continue addRemoteLink - Add a remote link to an issue. Name is used instead of title from the UI. Specify a reverseLink value to have a reverse link added where supported. Required parameters: issue, name or link Optional parameters: url, toIssue, reversLinkreverseLink, targetServer, targetUser, targetPassword removeRemoteLink - Remove a remote link to an issue. Name can be an numeric id, global link id, or a name. Required parameters: issue, name getRemoteLinkList - Get list of a remote links for an issue with optional regex filtering on the name or global id. Also filter by a specific link description if needed using link parameter. If specified, regex2 filtering will be appied to the application type specific information column. Required parameters: issue Optional parameters: link, limit, regex, regex2, targetUser, targetPassword, outputFormat, file, append, columns, encoding Output formats: 1 - basebasic, 999 - all getApplicationLinkList - Get list of a application links with optional filtering on application type and regex filtering on the name or url. Example types: jira, confluence. Optional parameters: type, limit, regex, file, append, columns, encoding exportSite - Create a site export. For server, data is put into a file in the JIRA home/export directory. For Cloud, data is put into a JIRA defined file on the associated webdav server - the file can optionally be copied to a local file if the file parameter is specified and permissions allow. Also for Cloud only, use the exportAttachments parameter to request the export contain attachments and similar data. Optional parameters: file, exportAttachments restoreExport - Restore export from file in the JIRA home/import directory. Required parameters: file exportData - Experimental - export project or issue participant data in a CLI compatible format. Required parameters: project or search Optional parameters: file, exportType, dateFormat, encoding, search, limit |