SYNOPSIS

PROPERTIES

openapi

ua

server

METHODS

`getBanner`

my $res = $client->getBanner()->get;

Get announcement banner configuration

Parameters

Returns a JIRA::API::AnnouncementBannerConfiguration. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`setBanner`

my $res = $client->setBanner()->get;

Update announcement banner configuration

Parameters

Options

isDismissible: Flag indicating if the announcement banner can be dismissed by the user.
isEnabled: Flag indicating if the announcement banner is enabled or not.
message: The text on the announcement banner.
visibility: Visibility of the announcement banner. Can be public or private.

Returns a ">>. Returns a . Returns a . Returns a ."

`updateMultipleCustomFieldValues`

my $res = $client->updateMultipleCustomFieldValues()->get;

Update custom fields

Parameters

generateChangelog: Whether to generate a changelog for this update.

Options

updates

Returns a >>.

`getCustomFieldConfiguration`

my $res = $client->getCustomFieldConfiguration()->get;

Get custom field configurations

Parameters

fieldIdOrKey: The ID or key of the custom field, for example customfield_10000.
id: The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.
fieldContextId: The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.
issueId: The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.
projectKeyOrId: The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
issueTypeId: The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanContextualConfiguration.

`updateCustomFieldConfiguration`

my $res = $client->updateCustomFieldConfiguration()->get;

Update custom field configurations

Parameters

fieldIdOrKey: The ID or key of the custom field, for example customfield_10000.

Options

configurations: The list of custom field configuration details.

Returns a >>.

`updateCustomFieldValue`

my $res = $client->updateCustomFieldValue()->get;

Update custom field value

Parameters

fieldIdOrKey: The ID or key of the custom field. For example, customfield_10010.
generateChangelog: Whether to generate a changelog for this update.

Options

updates: The list of custom field update details.

Returns a >>.

`getApplicationProperty`

my $res = $client->getApplicationProperty()->get;

Get application property

Parameters

key: The key of the application property.
permissionLevel: The permission level of all items being returned in the list.
keyFilter: When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with jira.lf..

Returns an array of JIRA::API::ApplicationProperty.

`getAdvancedSettings`

my $res = $client->getAdvancedSettings()->get;

Get advanced settings

Parameters

Returns an array of JIRA::API::ApplicationProperty.

`setApplicationProperty`

my $res = $client->setApplicationProperty()->get;

Set application property

Parameters

id: The key of the application property to update.

Options

id: The ID of the application property.
value: The new value.

Returns a JIRA::API::ApplicationProperty.

`getAllApplicationRoles`

my $res = $client->getAllApplicationRoles()->get;

Get all application roles

Parameters

Returns an array of JIRA::API::ApplicationRole.

`getApplicationRole`

my $res = $client->getApplicationRole()->get;

Get application role

Parameters

key: The key of the application role. Use the Get all application roles operation to get the key for each application role.

Returns a JIRA::API::ApplicationRole.

`getAttachmentContent`

my $res = $client->getAttachmentContent()->get;

Get attachment content

Parameters

id: The ID of the attachment.
redirect: Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment.

Returns a object.

`getAttachmentMeta`

my $res = $client->getAttachmentMeta()->get;

Get Jira attachment settings

Parameters

Returns a JIRA::API::AttachmentSettings.

`getAttachmentThumbnail`

my $res = $client->getAttachmentThumbnail()->get;

Get attachment thumbnail

Parameters

id: The ID of the attachment.
redirect: Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to false to avoid making multiple requests to download the attachment.
fallbackToDefault: Whether a default thumbnail is returned when the requested thumbnail is not found.
width: The maximum width to scale the thumbnail to.
height: The maximum height to scale the thumbnail to.

Returns a object.

`removeAttachment`

my $res = $client->removeAttachment()->get;

Delete attachment

Parameters

id: The ID of the attachment.

`getAttachment`

my $res = $client->getAttachment()->get;

Get attachment metadata

Parameters

id: The ID of the attachment.

Returns a JIRA::API::AttachmentMetadata.

`expandAttachmentForHumans`

my $res = $client->expandAttachmentForHumans()->get;

Get all metadata for an expanded attachment

Parameters

id: The ID of the attachment.

Returns a JIRA::API::AttachmentArchiveMetadataReadable.

`expandAttachmentForMachines`

my $res = $client->expandAttachmentForMachines()->get;

Get contents metadata for an expanded attachment

Parameters

id: The ID of the attachment.

Returns a JIRA::API::AttachmentArchiveImpl.

`getAuditRecords`

my $res = $client->getAuditRecords()->get;

Get audit records

Parameters

offset: The number of records to skip before returning the first result.
limit: The maximum number of results to return.
filter: The strings to match with audit field content, space separated.
from: The date and time on or after which returned audit records must have been created. If to is provided from must be before to or no audit records are returned.
to: The date and time on or before which returned audit results must have been created. If from is provided to must be after from or no audit records are returned.

Returns a JIRA::API::AuditRecords.

`getAllSystemAvatars`

my $res = $client->getAllSystemAvatars()->get;

Get system avatars by type

Parameters

type: The avatar type.

Returns a JIRA::API::SystemAvatars.

`getCommentsByIds`

my $res = $client->getCommentsByIds()->get;

Get comments by IDs

Parameters

expand

Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:

renderedBody Returns the comment body rendered in HTML.
properties Returns the comment's properties.

Options

ids: The list of comment IDs. A maximum of 1000 IDs can be specified.

Returns a JIRA::API::PageBeanComment.

`getCommentPropertyKeys`

my $res = $client->getCommentPropertyKeys()->get;

Get comment property keys

Parameters

commentId: The ID of the comment.

Returns a JIRA::API::PropertyKeys.

`deleteCommentProperty`

my $res = $client->deleteCommentProperty()->get;

Delete comment property

Parameters

commentId: The ID of the comment.
propertyKey: The key of the property.

`getCommentProperty`

my $res = $client->getCommentProperty()->get;

Get comment property

Parameters

commentId: The ID of the comment.
propertyKey: The key of the property.

Returns a JIRA::API::EntityProperty.

`setCommentProperty`

my $res = $client->setCommentProperty()->get;

Set comment property

Parameters

commentId: The ID of the comment.
propertyKey: The key of the property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`createComponent`

my $res = $client->createComponent()->get;

Create component

Parameters

Options

assignee

The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.

assigneeType

The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:

PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.
COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.
UNASSIGNED an assignee is not set for issues created with this component.
PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.

Default value: PROJECT_DEFAULT.

Optional when creating or updating a component.

description

The description for the component. Optional when creating or updating a component.

id

The unique identifier for the component.

isAssigneeTypeValid

Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.

lead

The user details for the component's lead user.

leadAccountId

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

leadUserName

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

name

The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

project

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectId

The ID of the project the component is assigned to.

realAssignee

The user assigned to issues created with this component, when assigneeType does not identify a valid assignee.

realAssigneeType

The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:

PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.
COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.
PROJECT_DEFAULT when none of the preceding cases are true.

self

The URL of the component.

Returns a JIRA::API::ProjectComponent.

`deleteComponent`

my $res = $client->deleteComponent()->get;

Delete component

Parameters

id: The ID of the component.
moveIssuesTo: The ID of the component to replace the deleted component. If this value is null no replacement is made.

`getComponent`

my $res = $client->getComponent()->get;

Get component

Parameters

id: The ID of the component.

Returns a JIRA::API::ProjectComponent.

`updateComponent`

my $res = $client->updateComponent()->get;

Update component

Parameters

id: The ID of the component.

Options

assignee

The details of the user associated with assigneeType, if any. See realAssignee for details of the user assigned to issues created with this component.

assigneeType

PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.
COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.
UNASSIGNED an assignee is not set for issues created with this component.
PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.

Default value: PROJECT_DEFAULT.

Optional when creating or updating a component.

description

The description for the component. Optional when creating or updating a component.

id

The unique identifier for the component.

isAssigneeTypeValid

Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.

lead

The user details for the component's lead user.

leadAccountId

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

leadUserName

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

name

The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.

project

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectId

The ID of the project the component is assigned to.

realAssignee

The user assigned to issues created with this component, when assigneeType does not identify a valid assignee.

realAssigneeType

PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.
COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.
PROJECT_DEFAULT when none of the preceding cases are true.

self

The URL of the component.

Returns a JIRA::API::ProjectComponent.

`getComponentRelatedIssues`

my $res = $client->getComponentRelatedIssues()->get;

Get component issues count

Parameters

id: The ID of the component.

Returns a JIRA::API::ComponentIssuesCount.

`getConfiguration`

my $res = $client->getConfiguration()->get;

Get global settings

Parameters

Returns a JIRA::API::Configuration.

`getSelectedTimeTrackingImplementation`

my $res = $client->getSelectedTimeTrackingImplementation()->get;

Get selected time tracking provider

Parameters

Returns a JIRA::API::TimeTrackingProvider. Returns a >>.

`selectTimeTrackingImplementation`

my $res = $client->selectTimeTrackingImplementation()->get;

Select time tracking provider

Parameters

Options

key: The key for the time tracking provider. For example, JIRA.
name: The name of the time tracking provider. For example, JIRA provided time tracking.
url: The URL of the configuration page for the time tracking provider app. For example, /example/config/url. This property is only returned if the adminPageKey property is set in the module descriptor of the time tracking provider app.

Returns a >>.

`getAvailableTimeTrackingImplementations`

my $res = $client->getAvailableTimeTrackingImplementations()->get;

Get all time tracking providers

Parameters

Returns an array of JIRA::API::TimeTrackingProvider.

`getSharedTimeTrackingConfiguration`

my $res = $client->getSharedTimeTrackingConfiguration()->get;

Get time tracking settings

Parameters

Returns a JIRA::API::TimeTrackingConfiguration.

`setSharedTimeTrackingConfiguration`

my $res = $client->setSharedTimeTrackingConfiguration()->get;

Set time tracking settings

Parameters

Options

defaultUnit: The default unit of time applied to logged time.
timeFormat: The format that will appear on an issue's Time Spent field.
workingDaysPerWeek: The number of days in a working week.
workingHoursPerDay: The number of hours in a working day.

Returns a JIRA::API::TimeTrackingConfiguration.

`getCustomFieldOption`

my $res = $client->getCustomFieldOption()->get;

Get custom field option

Parameters

id: The ID of the custom field option.

Returns a JIRA::API::CustomFieldOption.

`getAllDashboards`

my $res = $client->getAllDashboards()->get;

Get all dashboards

Parameters

filter

The filter applied to the list of dashboards. Valid values are:

favourite Returns dashboards the user has marked as favorite.
my Returns dashboards owned by the user.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

Returns a JIRA::API::PageOfDashboards. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`createDashboard`

my $res = $client->createDashboard()->get;

Create dashboard

Parameters

Options

description: The description of the dashboard.
editPermissions: The edit permissions for the dashboard.
name: The name of the dashboard.
sharePermissions: The share permissions for the dashboard.

Returns a JIRA::API::Dashboard. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAllAvailableDashboardGadgets`

my $res = $client->getAllAvailableDashboardGadgets()->get;

Get available gadgets

Parameters

Returns a JIRA::API::AvailableDashboardGadgetsResponse. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getDashboardsPaginated`

my $res = $client->getDashboardsPaginated()->get;

Search for dashboards

Parameters

dashboardName

String used to perform a case-insensitive partial match with name.

accountId

User account ID used to return dashboards with the matching owner.accountId. This parameter cannot be used with the owner parameter.

owner

This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return dashboards with the matching owner.name. This parameter cannot be used with the accountId parameter.

groupname

As a group's name can change, use of groupId is recommended. Group name used to return dashboards that are shared with a group that matches sharePermissions.group.name. This parameter cannot be used with the groupId parameter.

groupId

Group ID used to return dashboards that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.

projectId

Project ID used to returns dashboards that are shared with a project that matches sharePermissions.project.id.

orderBy

Order the results by a field:

description Sorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.
favourite_count Sorts by dashboard popularity.
id Sorts by dashboard ID.
is_favourite Sorts by whether the dashboard is marked as a favorite.
name Sorts by dashboard name.
owner Sorts by dashboard owner name.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

status

The status to filter by. It may be active, archived or deleted.

expand

Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:

description Returns the description of the dashboard.
owner Returns the owner of the dashboard.
viewUrl Returns the URL that is used to view the dashboard.
favourite Returns isFavourite, an indicator of whether the user has set the dashboard as a favorite.
favouritedCount Returns popularity, a count of how many users have set this dashboard as a favorite.
sharePermissions Returns details of the share permissions defined for the dashboard.
editPermissions Returns details of the edit permissions defined for the dashboard.
isWritable Returns whether the current user has permission to edit the dashboard.

Returns a JIRA::API::PageBeanDashboard. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAllGadgets`

my $res = $client->getAllGadgets()->get;

Get gadgets

Parameters

dashboardId: The ID of the dashboard.
moduleKey: The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand: moduleKey=key:one&moduleKey=key:two.
uri: The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: uri=/rest/example/uri/1&uri=/rest/example/uri/2.
gadgetId: The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: gadgetId=10000&gadgetId=10001.

Returns a JIRA::API::DashboardGadgetResponse. Returns a JIRA::API::ErrorCollection.

`addGadget`

my $res = $client->addGadget()->get;

Add gadget to dashboard

Parameters

dashboardId: The ID of the dashboard.

Options

color: The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.
ignoreUriAndModuleKeyValidation: Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.
moduleKey: The module key of the gadget type. Can't be provided with uri.
position: The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it.
title: The title of the gadget.
uri: The URI of the gadget type. Can't be provided with moduleKey.

Returns a JIRA::API::DashboardGadget. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`removeGadget`

my $res = $client->removeGadget()->get;

Remove gadget from dashboard

Parameters

dashboardId: The ID of the dashboard.
gadgetId: The ID of the gadget.

Returns a ">>. Returns a ."

`updateGadget`

my $res = $client->updateGadget()->get;

Update gadget on dashboard

Parameters

dashboardId: The ID of the dashboard.
gadgetId: The ID of the gadget.

Options

color: The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.
position: The position of the gadget.
title: The title of the gadget.

Returns a ">>. Returns a . Returns a ."

`getDashboardItemPropertyKeys`

my $res = $client->getDashboardItemPropertyKeys()->get;

Get dashboard item property keys

Parameters

dashboardId: The ID of the dashboard.
itemId: The ID of the dashboard item.

Returns a JIRA::API::PropertyKeys.

`deleteDashboardItemProperty`

my $res = $client->deleteDashboardItemProperty()->get;

Delete dashboard item property

Parameters

dashboardId: The ID of the dashboard.
itemId: The ID of the dashboard item.
propertyKey: The key of the dashboard item property.

`getDashboardItemProperty`

my $res = $client->getDashboardItemProperty()->get;

Get dashboard item property

Parameters

dashboardId: The ID of the dashboard.
itemId: The ID of the dashboard item.
propertyKey: The key of the dashboard item property.

Returns a JIRA::API::EntityProperty.

`setDashboardItemProperty`

my $res = $client->setDashboardItemProperty()->get;

Set dashboard item property

Parameters

dashboardId: The ID of the dashboard.
itemId: The ID of the dashboard item.
propertyKey: The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an object with all keys and values as strings.

Returns a ">>. Returns a "

`deleteDashboard`

my $res = $client->deleteDashboard()->get;

Delete dashboard

Parameters

id: The ID of the dashboard.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getDashboard`

my $res = $client->getDashboard()->get;

Get dashboard

Parameters

id: The ID of the dashboard.

Returns a JIRA::API::Dashboard. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`updateDashboard`

my $res = $client->updateDashboard()->get;

Update dashboard

Parameters

id: The ID of the dashboard to update.

Options

description: The description of the dashboard.
editPermissions: The edit permissions for the dashboard.
name: The name of the dashboard.
sharePermissions: The share permissions for the dashboard.

Returns a JIRA::API::Dashboard. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`copyDashboard`

my $res = $client->copyDashboard()->get;

Copy dashboard

Parameters

id

Options

description: The description of the dashboard.
editPermissions: The edit permissions for the dashboard.
name: The name of the dashboard.
sharePermissions: The share permissions for the dashboard.

Returns a JIRA::API::Dashboard. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getEvents`

my $res = $client->getEvents()->get;

Get events

Parameters

Returns an array of JIRA::API::IssueEvent.

`analyseExpression`

my $res = $client->analyseExpression()->get;

Analyse Jira expression

Parameters

check

The check to perform:

syntax Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length.
type EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check.
complexity EXPERIMENTAL. Determines the formulae for how many expensive operations each expression may execute.

Options

contextVariables: Context variables and their types. The type checker assumes that common context variables, such as issue or project, are available in context and sets their type. Use this property to override the default types or provide details of new variables.
expressions: The list of Jira expressions to analyse.

Returns a JIRA::API::JiraExpressionsAnalysis. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`evaluateJiraExpression`

my $res = $client->evaluateJiraExpression()->get;

Evaluate Jira expression

Parameters

expand: Use expand to include additional information in the response. This parameter accepts meta.complexity that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions.

Options

context: The context in which the Jira expression is evaluated.
expression: The Jira expression to evaluate.

Returns a JIRA::API::JiraExpressionResult. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getFields`

my $res = $client->getFields()->get;

Get fields

Parameters

Returns an array of JIRA::API::FieldDetails.

`createCustomField`

my $res = $client->createCustomField()->get;

Create custom field

Parameters

Options

description

The description of the custom field, which is displayed in Jira.

name

The name of the custom field, which is displayed in Jira. This is not the unique identifier.

searcherKey

The searcher defines the way the field is searched in Jira. For example, com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher.

The search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):

cascadingselect: cascadingselectsearcher
datepicker: daterange
datetime: datetimerange
float: exactnumber or numberrange
grouppicker: grouppickersearcher
importid: exactnumber or numberrange
labels: labelsearcher
multicheckboxes: multiselectsearcher
multigrouppicker: multiselectsearcher
multiselect: multiselectsearcher
multiuserpicker: userpickergroupsearcher
multiversion: versionsearcher
project: projectsearcher
radiobuttons: multiselectsearcher
readonlyfield: textsearcher
select: multiselectsearcher
textarea: textsearcher
textfield: textsearcher
url: exacttextsearcher
userpicker: userpickergroupsearcher
version: versionsearcher

If no searcher is provided, the field isn't searchable. However, Forge custom fields have a searcher set automatically, so are always searchable.

type

The type of the custom field. These built-in custom field types are available:

cascadingselect: Enables values to be selected from two levels of select lists (value: com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect)
datepicker: Stores a date using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:datepicker)
datetime: Stores a date with a time component (value: com.atlassian.jira.plugin.system.customfieldtypes:datetime)
float: Stores and validates a numeric (floating point) input (value: com.atlassian.jira.plugin.system.customfieldtypes:float)
grouppicker: Stores a user group using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:grouppicker)
importid: A read-only field that stores the ID the issue had in the system it was imported from (value: com.atlassian.jira.plugin.system.customfieldtypes:importid)
labels: Stores labels (value: com.atlassian.jira.plugin.system.customfieldtypes:labels)
multicheckboxes: Stores multiple values using checkboxes (value: ``)
multigrouppicker: Stores multiple user groups using a picker control (value: ``)
multiselect: Stores multiple values using a select list (value: com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes)
multiuserpicker: Stores multiple users using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker)
multiversion: Stores multiple versions from the versions available in a project using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:multiversion)
project: Stores a project from a list of projects that the user is permitted to view (value: com.atlassian.jira.plugin.system.customfieldtypes:project)
radiobuttons: Stores a value using radio buttons (value: com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons)
readonlyfield: Stores a read-only text value, which can only be populated via the API (value: com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield)
select: Stores a value from a configurable list of options (value: com.atlassian.jira.plugin.system.customfieldtypes:select)
textarea: Stores a long text string using a multiline text area (value: com.atlassian.jira.plugin.system.customfieldtypes:textarea)
textfield: Stores a text string using a single-line text box (value: com.atlassian.jira.plugin.system.customfieldtypes:textfield)
url: Stores a URL (value: com.atlassian.jira.plugin.system.customfieldtypes:url)
userpicker: Stores a user using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:userpicker)
version: Stores a version using a picker control (value: com.atlassian.jira.plugin.system.customfieldtypes:version)

To create a field based on a Forge custom field type, use the ID of the Forge custom field type as the value. For example, ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key.

Returns a JIRA::API::FieldDetails.

`getFieldsPaginated`

my $res = $client->getFieldsPaginated()->get;

Get fields paginated

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

type

The type of fields to search.

id

The IDs of the custom fields to return or, where query is specified, filter.

query

String used to perform a case-insensitive partial match with field names or descriptions.

orderBy

Order the results by a field:

contextsCount sorts by the number of contexts related to a field
lastUsed sorts by the date when the value of the field last changed
name sorts by the field name
screensCount sorts by the number of screens related to a field

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

key returns the key for each field
lastUsed returns the date when the value of the field last changed
screensCount returns the number of screens related to a field
contextsCount returns the number of contexts related to a field
isLocked returns information about whether the field is locked
searcherKey returns the searcher key for each custom field

Returns a JIRA::API::PageBeanField. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getTrashedFieldsPaginated`

my $res = $client->getTrashedFieldsPaginated()->get;

Get fields in trash paginated

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

query

String used to perform a case-insensitive partial match with field names or descriptions.

expand

orderBy

Order the results by a field:

name sorts by the field name
trashDate sorts by the date the field was moved to the trash
plannedDeletionDate sorts by the planned deletion date

Returns a JIRA::API::PageBeanField. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`updateCustomField`

my $res = $client->updateCustomField()->get;

Update custom field

Parameters

fieldId: The ID of the custom field.

Options

description

The description of the custom field. The maximum length is 40000 characters.

name

The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters.

searcherKey

The searcher that defines the way the field is searched in Jira. It can be set to null, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):

cascadingselect: cascadingselectsearcher
datepicker: daterange
datetime: datetimerange
float: exactnumber or numberrange
grouppicker: grouppickersearcher
importid: exactnumber or numberrange
labels: labelsearcher
multicheckboxes: multiselectsearcher
multigrouppicker: multiselectsearcher
multiselect: multiselectsearcher
multiuserpicker: userpickergroupsearcher
multiversion: versionsearcher
project: projectsearcher
radiobuttons: multiselectsearcher
readonlyfield: textsearcher
select: multiselectsearcher
textarea: textsearcher
textfield: textsearcher
url: exacttextsearcher
userpicker: userpickergroupsearcher
version: versionsearcher

Returns a >>.

`getContextsForField`

my $res = $client->getContextsForField()->get;

Get custom field contexts

Parameters

fieldId: The ID of the custom field.
isAnyIssueType: Whether to return contexts that apply to all issue types.
isGlobalContext: Whether to return contexts that apply to all projects.
contextId: The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanCustomFieldContext.

`createCustomFieldContext`

my $res = $client->createCustomFieldContext()->get;

Create custom field context

Parameters

fieldId: The ID of the custom field.

Options

description: The description of the context.
id: The ID of the context.
issueTypeIds: The list of issue types IDs for the context. If the list is empty, the context refers to all issue types.
name: The name of the context.
projectIds: The list of project IDs associated with the context. If the list is empty, the context is global.

Returns a JIRA::API::CreateCustomFieldContext.

`getDefaultValues`

my $res = $client->getDefaultValues()->get;

Get custom field contexts default values

Parameters

fieldId: The ID of the custom field, for example customfield\_10000.
contextId: The IDs of the contexts.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanCustomFieldContextDefaultValue.

`setDefaultValues`

my $res = $client->setDefaultValues()->get;

Set custom field contexts default values

Parameters

fieldId: The ID of the custom field.

Options

defaultValues

Returns a >>.

`getIssueTypeMappingsForContexts`

my $res = $client->getIssueTypeMappingsForContexts()->get;

Get issue types for custom field context

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, contextId=10001&contextId=10002.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanIssueTypeToContextMapping.

`getCustomFieldContextsForProjectsAndIssueTypes`

my $res = $client->getCustomFieldContextsForProjectsAndIssueTypes()->get;

Get custom field contexts for projects and issue types

Parameters

fieldId: The ID of the custom field.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Options

mappings: The project and issue type mappings.

Returns a JIRA::API::PageBeanContextForProjectAndIssueType.

`getProjectContextMapping`

my $res = $client->getProjectContextMapping()->get;

Get project mappings for custom field context

Parameters

fieldId: The ID of the custom field, for example customfield\_10000.
contextId: The list of context IDs. To include multiple context, separate IDs with ampersand: contextId=10000&contextId=10001.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanCustomFieldContextProjectMapping.

`deleteCustomFieldContext`

my $res = $client->deleteCustomFieldContext()->get;

Delete custom field context

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Returns a >>.

`updateCustomFieldContext`

my $res = $client->updateCustomFieldContext()->get;

Update custom field context

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

description: The description of the custom field context. The maximum length is 255 characters.
name: The name of the custom field context. The name must be unique. The maximum length is 255 characters.

Returns a >>.

`addIssueTypesToContext`

my $res = $client->addIssueTypesToContext()->get;

Add issue types to context

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

issueTypeIds: The list of issue type IDs.

Returns a >>.

`removeIssueTypesFromContext`

my $res = $client->removeIssueTypesFromContext()->get;

Remove issue types from context

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

issueTypeIds: The list of issue type IDs.

Returns a >>.

`getOptionsForContext`

my $res = $client->getOptionsForContext()->get;

Get custom field options (context)

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.
optionId: The ID of the option.
onlyOptions: Whether only options are returned.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanCustomFieldContextOption.

`createCustomFieldOption`

my $res = $client->createCustomFieldOption()->get;

Create custom field options (context)

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

options: Details of options to create.

Returns a JIRA::API::CustomFieldCreatedContextOptionsList.

`updateCustomFieldOption`

my $res = $client->updateCustomFieldOption()->get;

Update custom field options (context)

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

options: Details of the options to update.

Returns a JIRA::API::CustomFieldUpdatedContextOptionsList.

`reorderCustomFieldOptions`

my $res = $client->reorderCustomFieldOptions()->get;

Reorder custom field options (context)

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

after: The ID of the custom field option or cascading option to place the moved options after. Required if position isn't provided.
customFieldOptionIds: A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both.
position: The position the custom field options should be moved to. Required if after isn't provided.

Returns a >>.

`deleteCustomFieldOption`

my $res = $client->deleteCustomFieldOption()->get;

Delete custom field options (context)

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context from which an option should be deleted.
optionId: The ID of the option to delete.

`assignProjectsToCustomFieldContext`

my $res = $client->assignProjectsToCustomFieldContext()->get;

Assign custom field context to projects

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

projectIds: The IDs of projects.

Returns a >>.

`removeCustomFieldContextFromProjects`

my $res = $client->removeCustomFieldContextFromProjects()->get;

Remove custom field context from projects

Parameters

fieldId: The ID of the custom field.
contextId: The ID of the context.

Options

projectIds: The IDs of projects.

Returns a >>.

`getContextsForFieldDeprecated`

my $res = $client->getContextsForFieldDeprecated()->get;

Get contexts for a field

Parameters

fieldId: The ID of the field to return contexts for.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanContext.

`getScreensForField`

my $res = $client->getScreensForField()->get;

Get screens for a field

Parameters

fieldId: The ID of the field to return screens for.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
expand: Use expand to include additional information about screens in the response. This parameter accepts tab which returns details about the screen tabs the field is used in.

Returns a JIRA::API::PageBeanScreenWithTab.

`getAllIssueFieldOptions`

my $res = $client->getAllIssueFieldOptions()->get;

Get all issue field options

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Returns a JIRA::API::PageBeanIssueFieldOption.

`createIssueFieldOption`

my $res = $client->createIssueFieldOption()->get;

Create issue field option

Parameters

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Options

config: Details of the projects the option is available in.
properties: The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.
value: The option's name, which is displayed in Jira.

Returns a JIRA::API::IssueFieldOption.

`getSelectableIssueFieldOptions`

my $res = $client->getSelectableIssueFieldOptions()->get;

Get selectable issue field options

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

projectId

Filters the results to options that are only available in the specified project.

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Returns a JIRA::API::PageBeanIssueFieldOption.

`getVisibleIssueFieldOptions`

my $res = $client->getVisibleIssueFieldOptions()->get;

Get visible issue field options

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

projectId

Filters the results to options that are only available in the specified project.

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Returns a JIRA::API::PageBeanIssueFieldOption.

`deleteIssueFieldOption`

my $res = $client->deleteIssueFieldOption()->get;

Delete issue field option

Parameters

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

The ID of the option to be deleted.

Returns a >>.

`getIssueFieldOption`

my $res = $client->getIssueFieldOption()->get;

Get issue field option

Parameters

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

The ID of the option to be returned.

Returns a JIRA::API::IssueFieldOption.

`updateIssueFieldOption`

my $res = $client->updateIssueFieldOption()->get;

Update issue field option

Parameters

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

The ID of the option to be updated.

Options

config: Details of the projects the option is available in.
id: The unique identifier for the option. This is only unique within the select field's set of options.
properties: The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module.
value: The option's name, which is displayed in Jira.

Returns a JIRA::API::IssueFieldOption.

`replaceIssueFieldOption`

my $res = $client->replaceIssueFieldOption()->get;

Replace issue field option

Parameters

replaceWith

The ID of the option that will replace the currently selected option.

jql

A JQL query that specifies the issues to be updated. For example, project=10000.

overrideScreenSecurity

Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission.

overrideEditableFlag

Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission.

fieldKey

The field key is specified in the following format: $(app-key)__$(field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.
run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

optionId

The ID of the option to be deselected.

Returns a JIRA::API::TaskProgressBeanRemoveOptionFromIssuesResult.

`deleteCustomField`

my $res = $client->deleteCustomField()->get;

Delete custom field

Parameters

id: The ID of a custom field.

Returns a JIRA::API::TaskProgressBeanObject. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`restoreCustomField`

my $res = $client->restoreCustomField()->get;

Restore custom field from trash

Parameters

id: The ID of a custom field.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`trashCustomField`

my $res = $client->trashCustomField()->get;

Move custom field to trash

Parameters

id: The ID of a custom field.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`getAllFieldConfigurations`

my $res = $client->getAllFieldConfigurations()->get;

Get all field configurations

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
id: The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
isDefault: If true returns default field configurations only.
query: The query string used to match against field configuration names and descriptions.

Returns a JIRA::API::PageBeanFieldConfigurationDetails.

`createFieldConfiguration`

my $res = $client->createFieldConfiguration()->get;

Create field configuration

Parameters

Options

description: The description of the field configuration.
name: The name of the field configuration. Must be unique.

Returns a JIRA::API::FieldConfiguration.

`deleteFieldConfiguration`

my $res = $client->deleteFieldConfiguration()->get;

Delete field configuration

Parameters

id: The ID of the field configuration.

Returns a >>.

`updateFieldConfiguration`

my $res = $client->updateFieldConfiguration()->get;

Update field configuration

Parameters

id: The ID of the field configuration.

Options

description: The description of the field configuration.
name: The name of the field configuration. Must be unique.

Returns a >>.

`getFieldConfigurationItems`

my $res = $client->getFieldConfigurationItems()->get;

Get field configuration items

Parameters

id: The ID of the field configuration.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanFieldConfigurationItem.

`updateFieldConfigurationItems`

my $res = $client->updateFieldConfigurationItems()->get;

Update field configuration items

Parameters

id: The ID of the field configuration.

Options

fieldConfigurationItems: Details of fields in a field configuration.

Returns a >>.

`getAllFieldConfigurationSchemes`

my $res = $client->getAllFieldConfigurationSchemes()->get;

Get all field configuration schemes

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
id: The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

Returns a JIRA::API::PageBeanFieldConfigurationScheme.

`createFieldConfigurationScheme`

my $res = $client->createFieldConfigurationScheme()->get;

Create field configuration scheme

Parameters

Options

description: The description of the field configuration scheme.
name: The name of the field configuration scheme. The name must be unique.

Returns a JIRA::API::FieldConfigurationScheme.

`getFieldConfigurationSchemeMappings`

my $res = $client->getFieldConfigurationSchemeMappings()->get;

Get field configuration issue type items

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
fieldConfigurationSchemeId: The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001.

Returns a JIRA::API::PageBeanFieldConfigurationIssueTypeItem.

`getFieldConfigurationSchemeProjectMapping`

my $res = $client->getFieldConfigurationSchemeProjectMapping()->get;

Get field configuration schemes for projects

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
projectId: The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.

Returns a JIRA::API::PageBeanFieldConfigurationSchemeProjects.

`assignFieldConfigurationSchemeToProject`

my $res = $client->assignFieldConfigurationSchemeToProject()->get;

Assign field configuration scheme to project

Parameters

Options

fieldConfigurationSchemeId: The ID of the field configuration scheme. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme.
projectId: The ID of the project.

Returns a >>.

`deleteFieldConfigurationScheme`

my $res = $client->deleteFieldConfigurationScheme()->get;

Delete field configuration scheme

Parameters

id: The ID of the field configuration scheme.

Returns a >>.

`updateFieldConfigurationScheme`

my $res = $client->updateFieldConfigurationScheme()->get;

Update field configuration scheme

Parameters

id: The ID of the field configuration scheme.

Options

description: The description of the field configuration scheme.
name: The name of the field configuration scheme. The name must be unique.

Returns a >>.

`setFieldConfigurationSchemeMapping`

my $res = $client->setFieldConfigurationSchemeMapping()->get;

Assign issue types to field configurations

Parameters

id: The ID of the field configuration scheme.

Options

mappings: Field configuration to issue type mappings.

Returns a >>.

`removeIssueTypesFromGlobalFieldConfigurationScheme`

my $res = $client->removeIssueTypesFromGlobalFieldConfigurationScheme()->get;

Remove issue types from field configuration scheme

Parameters

id: The ID of the field configuration scheme.

Options

issueTypeIds: The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`getFilters`

my $res = $client->getFilters()->get;

Get filters

Parameters

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

Returns an array of JIRA::API::Filter.

`createFilter`

my $res = $client->createFilter()->get;

Create filter

Parameters

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

overrideSharePermissions

EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.

Options

description: A description of the filter.
editPermissions: The groups and projects that can edit the filter.
favourite: Whether the filter is selected as a favorite.
favouritedCount: The count of how many users have selected this filter as a favorite, including the filter owner.
id: The unique identifier for the filter.
jql: The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
name: The name of the filter. Must be unique.
owner: The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.
searchUrl: A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
self: The URL of the filter.
sharePermissions: The groups and projects that the filter is shared with.
sharedUsers: A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.
subscriptions: A paginated list of the users that are subscribed to the filter.
viewUrl: A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

Returns a JIRA::API::Filter.

`getDefaultShareScope`

my $res = $client->getDefaultShareScope()->get;

Get default share scope

Parameters

Returns a JIRA::API::DefaultShareScope.

`setDefaultShareScope`

my $res = $client->setDefaultShareScope()->get;

Set default share scope

Parameters

Options

scope

The scope of the default sharing for new filters and dashboards:

AUTHENTICATED Shared with all logged-in users.
GLOBAL Shared with all logged-in users. This shows as AUTHENTICATED in the response.
PRIVATE Not shared with any users.

Returns a JIRA::API::DefaultShareScope.

`getFavouriteFilters`

my $res = $client->getFavouriteFilters()->get;

Get favorite filters

Parameters

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

Returns an array of JIRA::API::Filter.

`getMyFilters`

my $res = $client->getMyFilters()->get;

Get my filters

Parameters

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

includeFavourites

Include the user's favorite filters in the response.

Returns an array of JIRA::API::Filter.

`getFiltersPaginated`

my $res = $client->getFiltersPaginated()->get;

Search for filters

Parameters

filterName

String used to perform a case-insensitive partial match with name.

accountId

User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.

owner

This parameter is deprecated because of privacy changes. Use accountId instead. See the migration guide for details. User name used to return filters with the matching owner.name. This parameter cannot be used with accountId.

groupname

As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter.

groupId

Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.

projectId

Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.

id

The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs.

orderBy

Order the results by a field:

description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.
favourite_count Sorts by the count of how many users have this filter as a favorite.
is_favourite Sorts by whether the filter is marked as a favorite.
id Sorts by filter ID.
name Sorts by filter name.
owner Sorts by the ID of the filter owner.
is_shared Sorts by whether the filter is shared.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

description Returns the description of the filter.
favourite Returns an indicator of whether the user has set the filter as a favorite.
favouritedCount Returns a count of how many users have set this filter as a favorite.
jql Returns the JQL query that the filter uses.
owner Returns the owner of the filter.
searchUrl Returns a URL to perform the filter's JQL query.
sharePermissions Returns the share permissions defined for the filter.
editPermissions Returns the edit permissions defined for the filter.
isWritable Returns whether the current user has permission to edit the filter.
subscriptions Returns the users that are subscribed to the filter.
viewUrl Returns a URL to view the filter.

overrideSharePermissions

EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.

Returns a JIRA::API::PageBeanFilterDetails. Returns a JIRA::API::ErrorCollection.

`deleteFilter`

my $res = $client->deleteFilter()->get;

Delete filter

Parameters

id: The ID of the filter to delete.

`getFilter`

my $res = $client->getFilter()->get;

Get filter

Parameters

id

The ID of the filter to return.

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

overrideSharePermissions

EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.

Returns a JIRA::API::Filter.

`updateFilter`

my $res = $client->updateFilter()->get;

Update filter

Parameters

id

The ID of the filter to update.

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

overrideSharePermissions

EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with Administer Jira global permission.

Options

description: A description of the filter.
editPermissions: The groups and projects that can edit the filter.
favourite: Whether the filter is selected as a favorite.
favouritedCount: The count of how many users have selected this filter as a favorite, including the filter owner.
id: The unique identifier for the filter.
jql: The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
name: The name of the filter. Must be unique.
owner: The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings.
searchUrl: A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug.
self: The URL of the filter.
sharePermissions: The groups and projects that the filter is shared with.
sharedUsers: A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with.
subscriptions: A paginated list of the users that are subscribed to the filter.
viewUrl: A URL to view the filter results in Jira, using the ID of the filter. For example, https://your-domain.atlassian.net/issues/?filter=10100.

Returns a JIRA::API::Filter.

`resetColumns`

my $res = $client->resetColumns()->get;

Reset columns

Parameters

id: The ID of the filter.

`getColumns`

my $res = $client->getColumns()->get;

Get columns

Parameters

id: The ID of the filter.

Returns an array of JIRA::API::ColumnItem.

`setColumns`

my $res = $client->setColumns()->get;

Set columns

Parameters

id: The ID of the filter.

Returns a >>.

`deleteFavouriteForFilter`

my $res = $client->deleteFavouriteForFilter()->get;

Remove filter as favorite

Parameters

id

The ID of the filter.

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

Returns a JIRA::API::Filter.

`setFavouriteForFilter`

my $res = $client->setFavouriteForFilter()->get;

Add filter as favorite

Parameters

id

The ID of the filter.

expand

Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:

sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append [start-index:end-index] to the expand request. For example, to access the next 1000 users, use ?expand=sharedUsers[1001:2000].
subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].

Returns a JIRA::API::Filter.

`changeFilterOwner`

my $res = $client->changeFilterOwner()->get;

Change filter owner

Parameters

id: The ID of the filter to update.

Options

accountId: The account ID of the new owner.

Returns a >>.

`getSharePermissions`

my $res = $client->getSharePermissions()->get;

Get share permissions

Parameters

id: The ID of the filter.

Returns an array of JIRA::API::SharePermission.

`addSharePermission`

my $res = $client->addSharePermission()->get;

Add share permission

Parameters

id: The ID of the filter.

Options

accountId

The user account ID that the filter is shared with. For a request, specify the accountId property for the user.

groupId

The ID of the group, which uniquely identifies the group across all Atlassian products.For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2. Cannot be provided with groupname.

groupname

The name of the group to share the filter with. Set type to group. Please note that the name of a group is mutable, to reliably identify a group use groupId.

projectId

The ID of the project to share the filter with. Set type to project.

projectRoleId

The ID of the project role to share the filter with. Set type to projectRole and the projectId for the project that the role is in.

rights

The rights for the share permission.

type

The type of the share permission.Specify the type as follows:

user Share with a user.
group Share with a group. Specify groupname as well.
project Share with a project. Specify projectId as well.
projectRole Share with a project role in a project. Specify projectId and projectRoleId as well.
global Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.
authenticated Share with all logged-in users. This shows as loggedin in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.

Returns an array of JIRA::API::SharePermission.

`deleteSharePermission`

my $res = $client->deleteSharePermission()->get;

Delete share permission

Parameters

id: The ID of the filter.
permissionId: The ID of the share permission.

`getSharePermission`

my $res = $client->getSharePermission()->get;

Get share permission

Parameters

id: The ID of the filter.
permissionId: The ID of the share permission.

Returns a JIRA::API::SharePermission.

`removeGroup`

my $res = $client->removeGroup()->get;

Remove group

Parameters

groupname

groupId

The ID of the group. This parameter cannot be used with the groupname parameter.

swapGroup

As a group's name can change, use of swapGroupId is recommended to identify a group.

The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroupId parameter.

swapGroupId

The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the swapGroup parameter.

`getGroup`

my $res = $client->getGroup()->get;

Get group

Parameters

groupname

As a group's name can change, use of groupId is recommended to identify a group.

The name of the group. This parameter cannot be used with the groupId parameter.

groupId

The ID of the group. This parameter cannot be used with the groupName parameter.

expand

List of fields to expand.

Returns a JIRA::API::Group.

`createGroup`

my $res = $client->createGroup()->get;

Create group

Parameters

Options

name: The name of the group.

Returns a JIRA::API::Group.

`bulkGetGroups`

my $res = $client->bulkGetGroups()->get;

Bulk get groups

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
groupId: The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5.
groupName: The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&groupName=jira-software-users.
accessType: The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
applicationKey: The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.

Returns a JIRA::API::PageBeanGroupDetails.

`getUsersFromGroup`

my $res = $client->getUsersFromGroup()->get;

Get users from group

Parameters

groupname

As a group's name can change, use of groupId is recommended to identify a group.

The name of the group. This parameter cannot be used with the groupId parameter.

groupId

The ID of the group. This parameter cannot be used with the groupName parameter.

includeInactiveUsers

Include inactive users.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

Returns a JIRA::API::PageBeanUserDetails.

`removeUserFromGroup`

my $res = $client->removeUserFromGroup()->get;

Remove user from group

Parameters

groupname

As a group's name can change, use of groupId is recommended to identify a group.

The name of the group. This parameter cannot be used with the groupId parameter.

groupId

The ID of the group. This parameter cannot be used with the groupName parameter.

username

This parameter is no longer available. See the deprecation notice for details.

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

`addUserToGroup`

my $res = $client->addUserToGroup()->get;

Add user to group

Parameters

groupname

As a group's name can change, use of groupId is recommended to identify a group.

The name of the group. This parameter cannot be used with the groupId parameter.

groupId

The ID of the group. This parameter cannot be used with the groupName parameter.

Options

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
name: This property is no longer available. See the deprecation notice for details.

Returns a JIRA::API::Group.

`findGroups`

my $res = $client->findGroups()->get;

Find groups

Parameters

accountId

This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups.

query

The string to find in group names.

exclude

As a group's name can change, use of excludeGroupIds is recommended to identify a group.

A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, exclude=group1&exclude=group2. This parameter cannot be used with the excludeGroupIds parameter.

excludeId

A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, excludeId=group1-id&excludeId=group2-id. This parameter cannot be used with the excludeGroups parameter.

maxResults

The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property jira.ajax.autocomplete.limit.

caseInsensitive

Whether the search for groups should be case insensitive.

userName

This parameter is no longer available. See the deprecation notice for details.

Returns a JIRA::API::FoundGroups.

`findUsersAndGroups`

my $res = $client->findUsersAndGroups()->get;

Find users and groups

Parameters

query: The search string.
maxResults: The maximum number of items to return in each list.
showAvatar: Whether the user avatar should be returned. If an invalid value is provided, the default value is used.
fieldId: The custom field ID of the field this request is for.
projectId: The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, projectId=10000&projectId=10001. This parameter is only used when fieldId is present.
issueTypeId: The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, issueTypeId=10000&issueTypeId=10001. Special values, such as -1 (all standard issue types) and -2 (all subtask issue types), are supported. This parameter is only used when fieldId is present.
avatarSize: The size of the avatar to return. If an invalid value is provided, the default value is used.
caseInsensitive: Whether the search for groups should be case insensitive.
excludeConnectAddons: Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used.

Returns a JIRA::API::FoundUsersAndGroups.

`getLicense`

my $res = $client->getLicense()->get;

Get license

Parameters

Returns a JIRA::API::License.

`createIssue`

my $res = $client->createIssue()->get;

Create issue

Parameters

updateHistory: Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen.

Options

fields: List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
historyMetadata: Additional issue history details.
properties: Details of issue properties to be add or update.
transition: Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update: A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

Returns a JIRA::API::CreatedIssue. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`createIssues`

my $res = $client->createIssues()->get;

Bulk create issue

Parameters

Options

issueUpdates

Returns a JIRA::API::CreatedIssues. Returns a JIRA::API::CreatedIssues.

`getCreateIssueMeta`

my $res = $client->getCreateIssueMeta()->get;

Get create issue metadata

Parameters

projectIds: List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided with projectKeys.
projectKeys: List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided with projectIds.
issuetypeIds: List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided with issuetypeNames.
issuetypeNames: List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided with issuetypeIds.
expand: Use expand to include additional information about issue metadata in the response. This parameter accepts projects.issuetypes.fields, which returns information about the fields in the issue creation screen for each issue type. Fields hidden from the screen are not returned. Use the information to populate the fields and update fields in Create issue and Create issues.

Returns a JIRA::API::IssueCreateMetadata.

`getIssuePickerResource`

my $res = $client->getIssuePickerResource()->get;

Get issue picker suggestions

Parameters

query: A string to match against text fields in the issue such as title, description, or comments.
currentJQL: A JQL query defining a list of issues to search for the query term. Note that username and userkey cannot be used as search terms for this parameter, due to privacy reasons. Use accountId instead.
currentIssueKey: The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query.
currentProjectId: The ID of a project that suggested issues must belong to.
showSubTasks: Indicate whether to include subtasks in the suggestions list.
showSubTaskParent: When currentIssueKey is a subtask, whether to include the parent issue in the suggestions if it matches the query.

Returns a JIRA::API::IssuePickerSuggestions.

`bulkSetIssuesPropertiesList`

my $res = $client->bulkSetIssuesPropertiesList()->get;

Bulk set issues properties by list

Parameters

Options

entitiesIds: A list of entity property IDs.
properties: A list of entity property keys and values.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`bulkSetIssuePropertiesByIssue`

my $res = $client->bulkSetIssuePropertiesByIssue()->get;

Bulk set issue properties by issue

Parameters

Options

issues: A list of issue IDs and their respective properties.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`bulkDeleteIssueProperty`

my $res = $client->bulkDeleteIssueProperty()->get;

Bulk delete issue property

Parameters

propertyKey: The key of the property.

Options

currentValue: The value of properties to perform the bulk operation on.
entityIds: List of issues to perform the bulk delete operation on.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`bulkSetIssueProperty`

my $res = $client->bulkSetIssueProperty()->get;

Bulk set issue property

Parameters

propertyKey: The key of the property. The maximum length is 255 characters.

Options

expression: EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are issue and user. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored.
filter: The bulk operation filter.
value: The value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getIsWatchingIssueBulk`

my $res = $client->getIsWatchingIssueBulk()->get;

Get is watching issue bulk

Parameters

Options

issueIds: The list of issue IDs.

Returns a JIRA::API::BulkIssueIsWatching.

`deleteIssue`

my $res = $client->deleteIssue()->get;

Delete issue

Parameters

issueIdOrKey: The ID or key of the issue.
deleteSubtasks: Whether the issue's subtasks are deleted when the issue is deleted.

`getIssue`

my $res = $client->getIssue()->get;

Get issue

Parameters

issueIdOrKey

The ID or key of the issue.

fields

A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values:

*all Returns all fields.
*navigable Returns navigable fields.
Any issue field, prefixed with a minus to exclude.

Examples:

summary,comment Returns only the summary and comments fields.
-description Returns all (default) fields except description.
*navigable,-comment Returns all navigable fields except comment.

This parameter may be specified multiple times. For example, fields=field1,field2& fields=field3.

Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields.

fieldsByKeys

Whether fields in fields are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID.

expand

Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:

renderedFields Returns field values rendered in HTML format.
names Returns the display name of each field.
schema Returns the schema describing a field type.
transitions Returns all possible transitions for the issue.
editmeta Returns information about how each field can be edited.
changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
versionedRepresentations Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the fields parameter is ignored.

properties

A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:

*all Returns all issue properties.
Any issue property key, prefixed with a minus to exclude.

Examples:

*all Returns all properties.
*all,-prop1 Returns all properties except prop1.
prop1,prop2 Returns prop1 and prop2 properties.

This parameter may be specified multiple times. For example, properties=prop1,prop2& properties=prop3.

updateHistory

Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. This also populates the JQL issues search lastViewed field.

Returns a JIRA::API::IssueBean.

`editIssue`

my $res = $client->editIssue()->get;

Edit issue

Parameters

issueIdOrKey: The ID or key of the issue.
notifyUsers: Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored.
overrideScreenSecurity: Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
overrideEditableFlag: Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.

Options

fields: List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
historyMetadata: Additional issue history details.
properties: Details of issue properties to be add or update.
transition: Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update: A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

Returns a >>.

`assignIssue`

my $res = $client->assignIssue()->get;

Assign issue

Parameters

issueIdOrKey: The ID or key of the issue to be assigned.

Options

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.

accountType

The user account type. Can take the following values:

atlassian regular Atlassian user account
app system account used for Connect applications and OAuth to represent external systems
customer Jira Service Desk account representing an external service desk

active

Whether the user is active.

applicationRoles

The application roles the user is assigned to.

avatarUrls

The avatars of the user.

displayName

The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.

emailAddress

The email address of the user. Depending on the user’s privacy setting, this may be returned as null.

expand

Expand options that include additional user details in the response.

groups

The groups that the user belongs to.

key

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

locale

The locale of the user. Depending on the user’s privacy setting, this may be returned as null.

name

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

self

The URL of the user.

timeZone

The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null.

Returns a >>.

`addAttachment`

my $res = $client->addAttachment()->get;

Add attachment

Parameters

issueIdOrKey: The ID or key of the issue that attachments are added to.

Returns an array of JIRA::API::Attachment.

`getChangeLogs`

my $res = $client->getChangeLogs()->get;

Get changelogs

Parameters

issueIdOrKey: The ID or key of the issue.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanChangelog.

`getChangeLogsByIds`

my $res = $client->getChangeLogsByIds()->get;

Get changelogs by IDs

Parameters

issueIdOrKey: The ID or key of the issue.

Options

changelogIds: The list of changelog IDs.

Returns a JIRA::API::PageOfChangelogs.

`getComments`

my $res = $client->getComments()->get;

Get comments

Parameters

issueIdOrKey: The ID or key of the issue.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
orderBy: Order the results by a field. Accepts created to sort comments by their created date.
expand: Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Returns a JIRA::API::PageOfComments.

`addComment`

my $res = $client->addComment()->get;

Add comment

Parameters

issueIdOrKey: The ID or key of the issue.
expand: Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Options

author: The ID of the user who created the comment.
body: The comment text in Atlassian Document Format.
created: The date and time at which the comment was created.
id: The ID of the comment.
jsdAuthorCanSeeRequest: Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
jsdPublic: Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
properties: A list of comment properties. Optional on create and update.
renderedBody: The rendered version of the comment.
self: The URL of the comment.
updateAuthor: The ID of the user who updated the comment last.
updated: The date and time at which the comment was updated last.
visibility: The group or role to which this comment is visible. Optional on create and update.

Returns a JIRA::API::Comment.

`deleteComment`

my $res = $client->deleteComment()->get;

Delete comment

Parameters

issueIdOrKey: The ID or key of the issue.
id: The ID of the comment.

`getComment`

my $res = $client->getComment()->get;

Get comment

Parameters

issueIdOrKey: The ID or key of the issue.
id: The ID of the comment.
expand: Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Returns a JIRA::API::Comment.

`updateComment`

my $res = $client->updateComment()->get;

Update comment

Parameters

issueIdOrKey: The ID or key of the issue.
id: The ID of the comment.
notifyUsers: Whether users are notified when a comment is updated.
overrideEditableFlag: Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
expand: Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

Options

author: The ID of the user who created the comment.
body: The comment text in Atlassian Document Format.
created: The date and time at which the comment was created.
id: The ID of the comment.
jsdAuthorCanSeeRequest: Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
jsdPublic: Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.
properties: A list of comment properties. Optional on create and update.
renderedBody: The rendered version of the comment.
self: The URL of the comment.
updateAuthor: The ID of the user who updated the comment last.
updated: The date and time at which the comment was updated last.
visibility: The group or role to which this comment is visible. Optional on create and update.

Returns a JIRA::API::Comment.

`getEditIssueMeta`

my $res = $client->getEditIssueMeta()->get;

Get edit issue metadata

Parameters

issueIdOrKey: The ID or key of the issue.
overrideScreenSecurity: Whether hidden fields are returned. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
overrideEditableFlag: Whether non-editable fields are returned. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.

Returns a JIRA::API::IssueUpdateMetadata.

`notify`

my $res = $client->notify()->get;

Send notification for issue

Parameters

issueIdOrKey: ID or key of the issue that the notification is sent for.

Options

htmlBody: The HTML body of the email notification for the issue.
restrict: Restricts the notifications to users with the specified permissions.
subject: The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary.
textBody: The plain text body of the email notification for the issue.
to: The recipients of the email notification for the issue.

Returns a >>.

`getIssuePropertyKeys`

my $res = $client->getIssuePropertyKeys()->get;

Get issue property keys

Parameters

issueIdOrKey: The key or ID of the issue.

Returns a JIRA::API::PropertyKeys.

`deleteIssueProperty`

my $res = $client->deleteIssueProperty()->get;

Delete issue property

Parameters

issueIdOrKey: The key or ID of the issue.
propertyKey: The key of the property.

`getIssueProperty`

my $res = $client->getIssueProperty()->get;

Get issue property

Parameters

issueIdOrKey: The key or ID of the issue.
propertyKey: The key of the property.

Returns a JIRA::API::EntityProperty.

`setIssueProperty`

my $res = $client->setIssueProperty()->get;

Set issue property

Parameters

issueIdOrKey: The ID or key of the issue.
propertyKey: The key of the issue property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`deleteRemoteIssueLinkByGlobalId`

my $res = $client->deleteRemoteIssueLinkByGlobalId()->get;

Delete remote issue link by global ID

Parameters

issueIdOrKey: The ID or key of the issue.
globalId: The global ID of a remote issue link.

`getRemoteIssueLinks`

my $res = $client->getRemoteIssueLinks()->get;

Get remote issue links

Parameters

issueIdOrKey: The ID or key of the issue.
globalId: The global ID of the remote issue link.

Returns a JIRA::API::RemoteIssueLink.

`createOrUpdateRemoteIssueLink`

my $res = $client->createOrUpdateRemoteIssueLink()->get;

Create or update remote issue link

Parameters

issueIdOrKey: The ID or key of the issue.

Options

application

Details of the remote application the linked item is in. For example, trello.

globalId

An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

The maximum length is 255 characters.

object

Details of the item linked to.

relationship

Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

Returns a JIRA::API::RemoteIssueLinkIdentifies. Returns a JIRA::API::RemoteIssueLinkIdentifies.

`deleteRemoteIssueLinkById`

my $res = $client->deleteRemoteIssueLinkById()->get;

Delete remote issue link by ID

Parameters

issueIdOrKey: The ID or key of the issue.
linkId: The ID of a remote issue link.

`getRemoteIssueLinkById`

my $res = $client->getRemoteIssueLinkById()->get;

Get remote issue link by ID

Parameters

issueIdOrKey: The ID or key of the issue.
linkId: The ID of the remote issue link.

Returns a JIRA::API::RemoteIssueLink.

`updateRemoteIssueLink`

my $res = $client->updateRemoteIssueLink()->get;

Update remote issue link by ID

Parameters

issueIdOrKey: The ID or key of the issue.
linkId: The ID of the remote issue link.

Options

application

Details of the remote application the linked item is in. For example, trello.

globalId

An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

The maximum length is 255 characters.

object

Details of the item linked to.

relationship

Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

Returns a >>.

`getTransitions`

my $res = $client->getTransitions()->get;

Get transitions

Parameters

issueIdOrKey: The ID or key of the issue.
expand: Use expand to include additional information about transitions in the response. This parameter accepts transitions.fields, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the fields and update fields in Transition issue.
transitionId: The ID of the transition.
skipRemoteOnlyCondition: Whether transitions with the condition Hide From User Condition are included in the response.
includeUnavailableTransitions: Whether details of transitions that fail a condition are included in the response
sortByOpsBarAndStatus: Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value.

Returns a JIRA::API::Transitions.

`doTransition`

my $res = $client->doTransition()->get;

Transition issue

Parameters

issueIdOrKey: The ID or key of the issue.

Options

fields: List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.
historyMetadata: Additional issue history details.
properties: Details of issue properties to be add or update.
transition: Details of a transition. Required when performing a transition, optional when creating or editing an issue.
update: A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

Returns a >>.

`removeVote`

my $res = $client->removeVote()->get;

Delete vote

Parameters

issueIdOrKey: The ID or key of the issue.

`getVotes`

my $res = $client->getVotes()->get;

Get votes

Parameters

issueIdOrKey: The ID or key of the issue.

Returns a JIRA::API::Votes.

`addVote`

my $res = $client->addVote()->get;

Add vote

Parameters

issueIdOrKey: The ID or key of the issue.

Returns a >>.

`removeWatcher`

my $res = $client->removeWatcher()->get;

Delete watcher

Parameters

issueIdOrKey: The ID or key of the issue.
username: This parameter is no longer available. See the deprecation notice for details.
accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.

`getIssueWatchers`

my $res = $client->getIssueWatchers()->get;

Get issue watchers

Parameters

issueIdOrKey: The ID or key of the issue.

Returns a JIRA::API::Watchers.

`addWatcher`

my $res = $client->addWatcher()->get;

Add watcher

Parameters

issueIdOrKey: The ID or key of the issue.

Returns a >>.

`getIssueWorklog`

my $res = $client->getIssueWorklog()->get;

Get issue worklogs

Parameters

issueIdOrKey: The ID or key of the issue.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
startedAfter: The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned.
startedBefore: The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned.
expand: Use expand to include additional information about worklogs in the response. This parameter acceptsproperties, which returns worklog properties.

Returns a JIRA::API::PageOfWorklogs.

`addWorklog`

my $res = $client->addWorklog()->get;

Add worklog

Parameters

issueIdOrKey

The ID or key the issue.

notifyUsers

Whether users watching the issue are notified by email.

adjustEstimate

Defines how to update the issue's time estimate, the options are:

new Sets the estimate to a specific value, defined in newEstimate.
leave Leaves the estimate unchanged.
manual Reduces the estimate by amount specified in reduceBy.
auto Reduces the estimate by the value of timeSpent in the worklog.

newEstimate

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

reduceBy

The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when adjustEstimate is manual.

expand

Use expand to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.

overrideEditableFlag

Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.

Options

author: Details of the user who created the worklog.
comment: A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
created: The datetime on which the worklog was created.
id: The ID of the worklog record.
issueId: The ID of the issue this worklog is for.
properties: Details of properties for the worklog. Optional when creating or updating a worklog.
self: The URL of the worklog item.
started: The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
timeSpent: The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
timeSpentSeconds: The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
updateAuthor: Details of the user who last updated the worklog.
updated: The datetime on which the worklog was last updated.
visibility: Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

Returns a JIRA::API::Worklog.

`deleteWorklog`

my $res = $client->deleteWorklog()->get;

Delete worklog

Parameters

issueIdOrKey

The ID or key of the issue.

id

The ID of the worklog.

notifyUsers

Whether users watching the issue are notified by email.

adjustEstimate

Defines how to update the issue's time estimate, the options are:

new Sets the estimate to a specific value, defined in newEstimate.
leave Leaves the estimate unchanged.
manual Increases the estimate by amount specified in increaseBy.
auto Reduces the estimate by the value of timeSpent in the worklog.

newEstimate

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

increaseBy

The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is manual.

overrideEditableFlag

Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag.

`getWorklog`

my $res = $client->getWorklog()->get;

Get worklog

Parameters

issueIdOrKey

The ID or key of the issue.

id

The ID of the worklog.

expand

Use expand to include additional information about work logs in the response. This parameter accepts

properties, which returns worklog properties.

Returns a JIRA::API::Worklog.

`updateWorklog`

my $res = $client->updateWorklog()->get;

Update worklog

Parameters

issueIdOrKey

The ID or key the issue.

id

The ID of the worklog.

notifyUsers

Whether users watching the issue are notified by email.

adjustEstimate

Defines how to update the issue's time estimate, the options are:

new Sets the estimate to a specific value, defined in newEstimate.
leave Leaves the estimate unchanged.
auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.

newEstimate

The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when adjustEstimate is new.

expand

Use expand to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.

overrideEditableFlag

Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with Administer Jira global permission can use this flag.

Options

author: Details of the user who created the worklog.
comment: A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
created: The datetime on which the worklog was created.
id: The ID of the worklog record.
issueId: The ID of the issue this worklog is for.
properties: Details of properties for the worklog. Optional when creating or updating a worklog.
self: The URL of the worklog item.
started: The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
timeSpent: The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if timeSpentSeconds isn't provided. Optional when updating a worklog. Cannot be provided if timeSpentSecond is provided.
timeSpentSeconds: The time in seconds spent working on the issue. Required when creating a worklog if timeSpent isn't provided. Optional when updating a worklog. Cannot be provided if timeSpent is provided.
updateAuthor: Details of the user who last updated the worklog.
updated: The datetime on which the worklog was last updated.
visibility: Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

Returns a JIRA::API::Worklog.

`getWorklogPropertyKeys`

my $res = $client->getWorklogPropertyKeys()->get;

Get worklog property keys

Parameters

issueIdOrKey: The ID or key of the issue.
worklogId: The ID of the worklog.

Returns a JIRA::API::PropertyKeys.

`deleteWorklogProperty`

my $res = $client->deleteWorklogProperty()->get;

Delete worklog property

Parameters

issueIdOrKey: The ID or key of the issue.
worklogId: The ID of the worklog.
propertyKey: The key of the property.

`getWorklogProperty`

my $res = $client->getWorklogProperty()->get;

Get worklog property

Parameters

issueIdOrKey: The ID or key of the issue.
worklogId: The ID of the worklog.
propertyKey: The key of the property.

Returns a JIRA::API::EntityProperty.

`setWorklogProperty`

my $res = $client->setWorklogProperty()->get;

Set worklog property

Parameters

issueIdOrKey: The ID or key of the issue.
worklogId: The ID of the worklog.
propertyKey: The key of the issue property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`linkIssues`

my $res = $client->linkIssues()->get;

Create issue link

Parameters

Options

comment

A comment.

inwardIssue

The ID or key of a linked issue.

outwardIssue

The ID or key of a linked issue.

type

This object is used as follows:

In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types.
In the issueLinkType resource it defines and reports on issue link types.

Returns a >>.

`deleteIssueLink`

my $res = $client->deleteIssueLink()->get;

Delete issue link

Parameters

linkId: The ID of the issue link.

`getIssueLink`

my $res = $client->getIssueLink()->get;

Get issue link

Parameters

linkId: The ID of the issue link.

Returns a JIRA::API::IssueLink.

`getIssueLinkTypes`

my $res = $client->getIssueLinkTypes()->get;

Get issue link types

Parameters

Returns a JIRA::API::IssueLinkTypes.

`createIssueLinkType`

my $res = $client->createIssueLinkType()->get;

Create issue link type

Parameters

Options

id

The ID of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.
In the issueLinkType resource it is read only.

inward

The description of the issue link type inward link and is used as follows:

In the issueLink resource it is read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

name

The name of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

outward

The description of the issue link type outward link and is used as follows:

In the issueLink resource it is read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

self

The URL of the issue link type. Read only.

Returns a JIRA::API::IssueLinkType.

`deleteIssueLinkType`

my $res = $client->deleteIssueLinkType()->get;

Delete issue link type

Parameters

issueLinkTypeId: The ID of the issue link type.

`getIssueLinkType`

my $res = $client->getIssueLinkType()->get;

Get issue link type

Parameters

issueLinkTypeId: The ID of the issue link type.

Returns a JIRA::API::IssueLinkType.

`updateIssueLinkType`

my $res = $client->updateIssueLinkType()->get;

Update issue link type

Parameters

issueLinkTypeId: The ID of the issue link type.

Options

id

The ID of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when name isn't provided. Otherwise, read only.
In the issueLinkType resource it is read only.

inward

The description of the issue link type inward link and is used as follows:

In the issueLink resource it is read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

name

The name of the issue link type and is used as follows:

In the issueLink resource it is the type of issue link. Required on create when id isn't provided. Otherwise, read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

outward

The description of the issue link type outward link and is used as follows:

In the issueLink resource it is read only.
In the issueLinkType resource it is required on create and optional on update. Otherwise, read only.

self

The URL of the issue link type. Read only.

Returns a JIRA::API::IssueLinkType.

`getIssueSecuritySchemes`

my $res = $client->getIssueSecuritySchemes()->get;

Get issue security schemes

Parameters

Returns a JIRA::API::SecuritySchemes.

`getIssueSecurityScheme`

my $res = $client->getIssueSecurityScheme()->get;

Get issue security scheme

Parameters

id: The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.

Returns a JIRA::API::SecurityScheme.

`getIssueSecurityLevelMembers`

my $res = $client->getIssueSecurityLevelMembers()->get;

Get issue security level members

Parameters

issueSecuritySchemeId

The ID of the issue security scheme. Use the Get issue security schemes operation to get a list of issue security scheme IDs.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

issueSecurityLevelId

The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: issueSecurityLevelId=10000&issueSecurityLevelId=10001.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Returns a JIRA::API::PageBeanIssueSecurityLevelMember.

`getIssueAllTypes`

my $res = $client->getIssueAllTypes()->get;

Get all issue types for user

Parameters

Returns an array of JIRA::API::IssueTypeDetails.

`createIssueType`

my $res = $client->createIssueType()->get;

Create issue type

Parameters

Options

description

The description of the issue type.

hierarchyLevel

The hierarchy level of the issue type. Use:

-1 for Subtask.
0 for Base.

Defaults to 0.

name

The unique name for the issue type. The maximum length is 60 characters.

type

Deprecated. Use hierarchyLevel instead. See the deprecation notice for details.

Whether the issue type is subtype or standard. Defaults to standard.

Returns a JIRA::API::IssueTypeDetails.

`getIssueTypesForProject`

my $res = $client->getIssueTypesForProject()->get;

Get issue types for project

Parameters

projectId

The ID of the project.

level

The level of the issue type to filter by. Use:

-1 for Subtask.
0 for Base.
1 for Epic.

Returns an array of JIRA::API::IssueTypeDetails.

`deleteIssueType`

my $res = $client->deleteIssueType()->get;

Delete issue type

Parameters

id: The ID of the issue type.
alternativeIssueTypeId: The ID of the replacement issue type.

`getIssueType`

my $res = $client->getIssueType()->get;

Get issue type

Parameters

id: The ID of the issue type.

Returns a JIRA::API::IssueTypeDetails.

`updateIssueType`

my $res = $client->updateIssueType()->get;

Update issue type

Parameters

id: The ID of the issue type.

Options

avatarId: The ID of an issue type avatar.
description: The description of the issue type.
name: The unique name for the issue type. The maximum length is 60 characters.

Returns a JIRA::API::IssueTypeDetails.

`getAlternativeIssueTypes`

my $res = $client->getAlternativeIssueTypes()->get;

Get alternative issue types

Parameters

id: The ID of the issue type.

Returns an array of JIRA::API::IssueTypeDetails.

`createIssueTypeAvatar`

my $res = $client->createIssueTypeAvatar()->get;

Load issue type avatar

Parameters

id: The ID of the issue type.
x: The X coordinate of the top-left corner of the crop region.
y: The Y coordinate of the top-left corner of the crop region.
size: The length of each side of the crop region.

Returns a JIRA::API::Avatar.

`getIssueTypePropertyKeys`

my $res = $client->getIssueTypePropertyKeys()->get;

Get issue type property keys

Parameters

issueTypeId: The ID of the issue type.

Returns a JIRA::API::PropertyKeys.

`deleteIssueTypeProperty`

my $res = $client->deleteIssueTypeProperty()->get;

Delete issue type property

Parameters

issueTypeId: The ID of the issue type.
propertyKey: The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

`getIssueTypeProperty`

my $res = $client->getIssueTypeProperty()->get;

Get issue type property

Parameters

issueTypeId: The ID of the issue type.
propertyKey: The key of the property. Use Get issue type property keys to get a list of all issue type property keys.

Returns a JIRA::API::EntityProperty.

`setIssueTypeProperty`

my $res = $client->setIssueTypeProperty()->get;

Set issue type property

Parameters

issueTypeId: The ID of the issue type.
propertyKey: The key of the issue type property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`getAllIssueTypeSchemes`

my $res = $client->getAllIssueTypeSchemes()->get;

Get all issue type schemes

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

orderBy

Order the results by a field:

name Sorts by issue type scheme name.
id Sorts by issue type scheme ID.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

projects For each issue type schemes, returns information about the projects the issue type scheme is assigned to.
issueTypes For each issue type schemes, returns information about the issueTypes the issue type scheme have.

queryString

String used to perform a case-insensitive partial match with issue type scheme name.

Returns a JIRA::API::PageBeanIssueTypeScheme.

`createIssueTypeScheme`

my $res = $client->createIssueTypeScheme()->get;

Create issue type scheme

Parameters

Options

defaultIssueTypeId: The ID of the default issue type of the issue type scheme. This ID must be included in issueTypeIds.
description: The description of the issue type scheme. The maximum length is 4000 characters.
issueTypeIds: The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required.
name: The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

Returns a JIRA::API::IssueTypeSchemeID.

`getIssueTypeSchemesMapping`

my $res = $client->getIssueTypeSchemesMapping()->get;

Get issue type scheme items

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
issueTypeSchemeId: The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, issueTypeSchemeId=10000&issueTypeSchemeId=10001.

Returns a JIRA::API::PageBeanIssueTypeSchemeMapping.

`getIssueTypeSchemeForProjects`

my $res = $client->getIssueTypeSchemeForProjects()->get;

Get issue type schemes for projects

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
projectId: The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, projectId=10000&projectId=10001.

Returns a JIRA::API::PageBeanIssueTypeSchemeProjects.

`assignIssueTypeSchemeToProject`

my $res = $client->assignIssueTypeSchemeToProject()->get;

Assign issue type scheme to project

Parameters

Options

issueTypeSchemeId: The ID of the issue type scheme.
projectId: The ID of the project.

Returns a >>.

`deleteIssueTypeScheme`

my $res = $client->deleteIssueTypeScheme()->get;

Delete issue type scheme

Parameters

issueTypeSchemeId: The ID of the issue type scheme.

Returns a >>.

`updateIssueTypeScheme`

my $res = $client->updateIssueTypeScheme()->get;

Update issue type scheme

Parameters

issueTypeSchemeId: The ID of the issue type scheme.

Options

defaultIssueTypeId: The ID of the default issue type of the issue type scheme.
description: The description of the issue type scheme. The maximum length is 4000 characters.
name: The name of the issue type scheme. The name must be unique. The maximum length is 255 characters.

Returns a >>.

`addIssueTypesToIssueTypeScheme`

my $res = $client->addIssueTypesToIssueTypeScheme()->get;

Add issue types to issue type scheme

Parameters

issueTypeSchemeId: The ID of the issue type scheme.

Options

issueTypeIds: The list of issue type IDs.

Returns a >>.

`reorderIssueTypesInIssueTypeScheme`

my $res = $client->reorderIssueTypesInIssueTypeScheme()->get;

Change order of issue types

Parameters

issueTypeSchemeId: The ID of the issue type scheme.

Options

after: The ID of the issue type to place the moved issue types after. Required if position isn't provided.
issueTypeIds: A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move.
position: The position the issue types should be moved to. Required if after isn't provided.

Returns a >>.

`removeIssueTypeFromIssueTypeScheme`

my $res = $client->removeIssueTypeFromIssueTypeScheme()->get;

Remove issue type from issue type scheme

Parameters

issueTypeSchemeId: The ID of the issue type scheme.
issueTypeId: The ID of the issue type.

Returns a >>.

`getIssueTypeScreenSchemes`

my $res = $client->getIssueTypeScreenSchemes()->get;

Get issue type screen schemes

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

queryString

String used to perform a case-insensitive partial match with issue type screen scheme name.

orderBy

Order the results by a field:

name Sorts by issue type screen scheme name.
id Sorts by issue type screen scheme ID.

expand

Use expand to include additional information in the response. This parameter accepts projects that, for each issue type screen schemes, returns information about the projects the issue type screen scheme is assigned to.

Returns a JIRA::API::PageBeanIssueTypeScreenScheme.

`createIssueTypeScreenScheme`

my $res = $client->createIssueTypeScreenScheme()->get;

Create issue type screen scheme

Parameters

Options

description: The description of the issue type screen scheme. The maximum length is 255 characters.
issueTypeMappings: The IDs of the screen schemes for the issue type IDs and default. A default entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme.
name: The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

Returns a JIRA::API::IssueTypeScreenSchemeId.

`getIssueTypeScreenSchemeMappings`

my $res = $client->getIssueTypeScreenSchemeMappings()->get;

Get issue type screen scheme items

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
issueTypeScreenSchemeId: The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001.

Returns a JIRA::API::PageBeanIssueTypeScreenSchemeItem.

`getIssueTypeScreenSchemeProjectAssociations`

my $res = $client->getIssueTypeScreenSchemeProjectAssociations()->get;

Get issue type screen schemes for projects

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
projectId: The list of project IDs. To include multiple projects, separate IDs with ampersand: projectId=10000&projectId=10001.

Returns a JIRA::API::PageBeanIssueTypeScreenSchemesProjects.

`assignIssueTypeScreenSchemeToProject`

my $res = $client->assignIssueTypeScreenSchemeToProject()->get;

Assign issue type screen scheme to project

Parameters

Options

issueTypeScreenSchemeId: The ID of the issue type screen scheme.
projectId: The ID of the project.

Returns a >>.

`deleteIssueTypeScreenScheme`

my $res = $client->deleteIssueTypeScreenScheme()->get;

Delete issue type screen scheme

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.

Returns a >>.

`updateIssueTypeScreenScheme`

my $res = $client->updateIssueTypeScreenScheme()->get;

Update issue type screen scheme

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.

Options

description: The description of the issue type screen scheme. The maximum length is 255 characters.
name: The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters.

Returns a >>.

`appendMappingsForIssueTypeScreenScheme`

my $res = $client->appendMappingsForIssueTypeScreenScheme()->get;

Append mappings to issue type screen scheme

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.

Options

issueTypeMappings: The list of issue type to screen scheme mappings. A default entry cannot be specified because a default entry is added when an issue type screen scheme is created.

Returns a >>.

`updateDefaultScreenScheme`

my $res = $client->updateDefaultScreenScheme()->get;

Update issue type screen scheme default screen scheme

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.

Options

screenSchemeId: The ID of the screen scheme.

Returns a >>.

`removeMappingsFromIssueTypeScreenScheme`

my $res = $client->removeMappingsFromIssueTypeScreenScheme()->get;

Remove mappings from issue type screen scheme

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.

Options

issueTypeIds: The list of issue type IDs.

Returns a >>.

`getProjectsForIssueTypeScreenScheme`

my $res = $client->getProjectsForIssueTypeScreenScheme()->get;

Get issue type screen scheme projects

Parameters

issueTypeScreenSchemeId: The ID of the issue type screen scheme.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
query

Returns a JIRA::API::PageBeanProjectDetails.

`getAutoComplete`

my $res = $client->getAutoComplete()->get;

Get field reference data (GET)

Parameters

Returns a JIRA::API::JQLReferenceData.

`getAutoCompletePost`

my $res = $client->getAutoCompletePost()->get;

Get field reference data (POST)

Parameters

Options

includeCollapsedFields: Include collapsed fields for fields that have non-unique names.
projectIds: List of project IDs used to filter the visible field details returned.

Returns a JIRA::API::JQLReferenceData.

`getFieldAutoCompleteForQueryString`

my $res = $client->getFieldAutoCompleteForQueryString()->get;

Get field auto complete suggestions

Parameters

fieldName: The name of the field.
fieldValue: The partial field item name entered by the user.
predicateName: The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to.
predicateValue: The partial predicate item name entered by the user.

Returns a JIRA::API::AutoCompleteSuggestions.

`getPrecomputations`

my $res = $client->getPrecomputations()->get;

Get precomputation

Parameters

functionKey
startAt
maxResults
orderBy
filter

Returns a JIRA::API::PageBeanJqlFunctionPrecomputationBean.

`updatePrecomputations`

my $res = $client->updatePrecomputations()->get;

Update precomputations

Parameters

Options

values

Returns a >>.

`matchIssues`

my $res = $client->matchIssues()->get;

Check issues against JQL

Parameters

Options

issueIds: A list of issue IDs.
jqls: A list of JQL queries.

Returns a JIRA::API::IssueMatches.

`parseJqlQueries`

my $res = $client->parseJqlQueries()->get;

Parse JQL query

Parameters

validation

How to validate the JQL query and treat the validation results. Validation options include:

strict Returns all errors. If validation fails, the query structure is not returned.
warn Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned.
none No validation is performed. If JQL query is correctly formed, the query structure is returned.

Options

queries: A list of queries to parse.

Returns a JIRA::API::ParsedJqlQueries. Returns a JIRA::API::ErrorCollection.

`migrateQueries`

my $res = $client->migrateQueries()->get;

Convert user identifiers to account IDs in JQL queries

Parameters

Options

queryStrings: A list of queries with user identifiers. Maximum of 100 queries.

Returns a JIRA::API::ConvertedJQLQueries.

`sanitiseJqlQueries`

my $res = $client->sanitiseJqlQueries()->get;

Sanitize JQL queries

Parameters

Options

queries: The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries.

Returns a JIRA::API::SanitizedJqlQueries. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAllLabels`

my $res = $client->getAllLabels()->get;

Get all labels

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanString.

`getApproximateLicenseCount`

my $res = $client->getApproximateLicenseCount()->get;

Get approximate license count

Parameters

Returns a JIRA::API::LicenseMetric.

`getApproximateApplicationLicenseCount`

my $res = $client->getApproximateApplicationLicenseCount()->get;

Get approximate application license count

Parameters

applicationKey

Returns a JIRA::API::LicenseMetric.

`getMyPermissions`

my $res = $client->getMyPermissions()->get;

Get my permissions

Parameters

projectKey: The key of project. Ignored if projectId is provided.
projectId: The ID of project.
issueKey: The key of the issue. Ignored if issueId is provided.
issueId: The ID of the issue.
permissions: A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions.
projectUuid
projectConfigurationUuid
commentId: The ID of the comment.

Returns a JIRA::API::Permissions. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`removePreference`

my $res = $client->removePreference()->get;

Delete preference

Parameters

key: The key of the preference.

`getPreference`

my $res = $client->getPreference()->get;

Get preference

Parameters

key: The key of the preference.

Returns a string.

`setPreference`

my $res = $client->setPreference()->get;

Set preference

Parameters

key: The key of the preference. The maximum length is 255 characters.

Returns a >>.

`deleteLocale`

my $res = $client->deleteLocale()->get;

Delete locale

Parameters

Returns a >>.

`getLocale`

my $res = $client->getLocale()->get;

Get locale

Parameters

Returns a JIRA::API::Locale.

`setLocale`

my $res = $client->setLocale()->get;

Set locale

Parameters

Options

locale: The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en_US represents a locale of English (United States). Required on create.

Returns a >>.

`getCurrentUser`

my $res = $client->getCurrentUser()->get;

Get current user

Parameters

expand

Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include:

groups Returns all groups, including nested groups, the user belongs to.
applicationRoles Returns the application roles the user is assigned to.

Returns a JIRA::API::User.

`getNotificationSchemes`

my $res = $client->getNotificationSchemes()->get;

Get notification schemes paginated

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

The list of notification schemes IDs to be filtered by

projectId

The list of projects IDs to be filtered by

onlyDefault

When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

all Returns all expandable information
field Returns information about any custom fields assigned to receive an event
group Returns information about any groups assigned to receive an event
notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
projectRole Returns information about any project roles assigned to receive an event
user Returns information about any users assigned to receive an event

Returns a JIRA::API::PageBeanNotificationScheme.

`createNotificationScheme`

my $res = $client->createNotificationScheme()->get;

Create notification scheme

Parameters

Options

description: The description of the notification scheme.
name: The name of the notification scheme. Must be unique (case-insensitive).
notificationSchemeEvents: The list of notifications which should be added to the notification scheme.

Returns a JIRA::API::NotificationSchemeId. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getNotificationSchemeToProjectMappings`

my $res = $client->getNotificationSchemeToProjectMappings()->get;

Get projects using notification schemes paginated

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
notificationSchemeId: The list of notifications scheme IDs to be filtered out
projectId: The list of project IDs to be filtered out

Returns a JIRA::API::PageBeanNotificationSchemeAndProjectMappingJsonBean. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getNotificationScheme`

my $res = $client->getNotificationScheme()->get;

Get notification scheme

Parameters

id

The ID of the notification scheme. Use Get notification schemes paginated to get a list of notification scheme IDs.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

all Returns all expandable information
field Returns information about any custom fields assigned to receive an event
group Returns information about any groups assigned to receive an event
notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
projectRole Returns information about any project roles assigned to receive an event
user Returns information about any users assigned to receive an event

Returns a JIRA::API::NotificationScheme.

`updateNotificationScheme`

my $res = $client->updateNotificationScheme()->get;

Update notification scheme

Parameters

id: The ID of the notification scheme.

Options

description: The description of the notification scheme.
name: The name of the notification scheme. Must be unique.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`addNotifications`

my $res = $client->addNotifications()->get;

Add notifications to notification scheme

Parameters

id: The ID of the notification scheme.

Options

notificationSchemeEvents: The list of notifications which should be added to the notification scheme.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`deleteNotificationScheme`

my $res = $client->deleteNotificationScheme()->get;

Delete notification scheme

Parameters

notificationSchemeId: The ID of the notification scheme.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`removeNotificationFromNotificationScheme`

my $res = $client->removeNotificationFromNotificationScheme()->get;

Remove notification from notification scheme

Parameters

notificationSchemeId: The ID of the notification scheme.
notificationId: The ID of the notification.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`getAllPermissions`

my $res = $client->getAllPermissions()->get;

Get all permissions

Parameters

Returns a JIRA::API::Permissions.

`getBulkPermissions`

my $res = $client->getBulkPermissions()->get;

Get bulk permissions

Parameters

Options

accountId: The account ID of a user.
globalPermissions: Global permissions to look up.
projectPermissions: Project permissions with associated projects and issues to look up.

Returns a JIRA::API::BulkPermissionGrants. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getPermittedProjects`

my $res = $client->getPermittedProjects()->get;

Get permitted projects

Parameters

Options

permissions: A list of permission keys.

Returns a JIRA::API::PermittedProjects.

`getAllPermissionSchemes`

my $res = $client->getAllPermissionSchemes()->get;

Get all permission schemes

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Returns a JIRA::API::PermissionSchemes.

`createPermissionScheme`

my $res = $client->createPermissionScheme()->get;

Create permission scheme

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Options

description: A description for the permission scheme.
expand: The expand options available for the permission scheme.
id: The ID of the permission scheme.
name: The name of the permission scheme. Must be unique.
permissions: The permission scheme to create or update. See About permission schemes and grants for more information.
scope: The scope of the permission scheme.
self: The URL of the permission scheme.

Returns a JIRA::API::PermissionScheme.

`deletePermissionScheme`

my $res = $client->deletePermissionScheme()->get;

Delete permission scheme

Parameters

schemeId: The ID of the permission scheme being deleted.

`getPermissionScheme`

my $res = $client->getPermissionScheme()->get;

Get permission scheme

Parameters

schemeId

The ID of the permission scheme to return.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Returns a JIRA::API::PermissionScheme.

`updatePermissionScheme`

my $res = $client->updatePermissionScheme()->get;

Update permission scheme

Parameters

schemeId

The ID of the permission scheme to update.

expand

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Options

description: A description for the permission scheme.
expand: The expand options available for the permission scheme.
id: The ID of the permission scheme.
name: The name of the permission scheme. Must be unique.
permissions: The permission scheme to create or update. See About permission schemes and grants for more information.
scope: The scope of the permission scheme.
self: The URL of the permission scheme.

Returns a JIRA::API::PermissionScheme.

`getPermissionSchemeGrants`

my $res = $client->getPermissionSchemeGrants()->get;

Get permission scheme grants

Parameters

schemeId

The ID of the permission scheme.

expand

permissions Returns all permission grants for each permission scheme.
user Returns information about the user who is granted the permission.
group Returns information about the group that is granted the permission.
projectRole Returns information about the project role granted the permission.
field Returns information about the custom field granted the permission.
all Returns all expandable information.

Returns a JIRA::API::PermissionGrants.

`createPermissionGrant`

my $res = $client->createPermissionGrant()->get;

Create permission grant

Parameters

schemeId

The ID of the permission scheme in which to create a new permission grant.

expand

permissions Returns all permission grants for each permission scheme.
user Returns information about the user who is granted the permission.
group Returns information about the group that is granted the permission.
projectRole Returns information about the project role granted the permission.
field Returns information about the custom field granted the permission.
all Returns all expandable information.

Options

holder: The user or group being granted the permission. It consists of a type, a type-dependent parameter and a type-dependent value. See Holder object in Get all permission schemes for more information.
id: The ID of the permission granted details.
permission: The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See Built-in permissions in Get all permission schemes for more information about the built-in permissions. See the project permission and global permission module documentation for more information about custom permissions.
self: The URL of the permission granted details.

Returns a JIRA::API::PermissionGrant.

`deletePermissionSchemeEntity`

my $res = $client->deletePermissionSchemeEntity()->get;

Delete permission scheme grant

Parameters

schemeId: The ID of the permission scheme to delete the permission grant from.
permissionId: The ID of the permission grant to delete.

`getPermissionSchemeGrant`

my $res = $client->getPermissionSchemeGrant()->get;

Get permission scheme grant

Parameters

schemeId

The ID of the permission scheme.

permissionId

The ID of the permission grant.

expand

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Returns a JIRA::API::PermissionGrant.

`getPriorities`

my $res = $client->getPriorities()->get;

Get priorities

Parameters

Returns an array of JIRA::API::Priority.

`createPriority`

my $res = $client->createPriority()->get;

Create priority

Parameters

Options

description: The description of the priority.
iconUrl: The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used.
name: The name of the priority. Must be unique.
statusColor: The status color of the priority in 3-digit or 6-digit hexadecimal format.

Returns a JIRA::API::PriorityId. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`setDefaultPriority`

my $res = $client->setDefaultPriority()->get;

Set default priority

Parameters

Options

id: The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`movePriorities`

my $res = $client->movePriorities()->get;

Move priorities

Parameters

Options

after: The ID of the priority. Required if position isn't provided.
ids: The list of issue IDs to be reordered. Cannot contain duplicates nor after ID.
position: The position for issue priorities to be moved to. Required if after isn't provided.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`searchPriorities`

my $res = $client->searchPriorities()->get;

Search priorities

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
id: The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=2&id=3.
onlyDefault: Whether only the default priority is returned.

Returns a JIRA::API::PageBeanPriority. Returns a JIRA::API::ErrorCollection.

`deletePriority`

my $res = $client->deletePriority()->get;

Delete priority

Parameters

id: The ID of the issue priority.
replaceWith: The ID of the issue priority that will replace the currently selected resolution.

`getPriority`

my $res = $client->getPriority()->get;

Get priority

Parameters

id: The ID of the issue priority.

Returns a JIRA::API::Priority.

`updatePriority`

my $res = $client->updatePriority()->get;

Update priority

Parameters

id: The ID of the issue priority.

Options

description: The description of the priority.
iconUrl: The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used.
name: The name of the priority. Must be unique.
statusColor: The status color of the priority in 3-digit or 6-digit hexadecimal format.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`getAllProjects`

my $res = $client->getAllProjects()->get;

Get all projects

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

description Returns the project description.
issueTypes Returns all issue types associated with the project.
lead Returns information about the project lead.
projectKeys Returns all project keys associated with the project.

recent

Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session.

properties

A list of project properties to return for the project. This parameter accepts a comma-separated list.

Returns an array of JIRA::API::Project.

`createProject`

my $res = $client->createProject()->get;

Create project

Parameters

Options

assigneeType: The default assignee when creating issues for this project.
avatarId: An integer value for the project's avatar.
categoryId: The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.
description: A brief description of the project.
fieldConfigurationScheme: The ID of the field configuration scheme for the project. Use the Get all field configuration schemes operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.
issueSecurityScheme: The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.
issueTypeScheme: The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.
issueTypeScreenScheme: The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.
key: Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
lead: This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with leadAccountId.
leadAccountId: The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead.
name: The name of the project.
notificationScheme: The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
permissionScheme: The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.
projectTemplateKey: A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey.
projectTypeKey: The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.
url: A link to information about this project, such as project documentation
workflowScheme: The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.

Returns a JIRA::API::ProjectIdentifiers.

`getRecent`

my $res = $client->getRecent()->get;

Get recent projects

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

description Returns the project description.
projectKeys Returns all project keys associated with a project.
lead Returns information about the project lead.
issueTypes Returns all issue types associated with the project.
url Returns the URL associated with the project.
permissions Returns the permissions associated with the project.
insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.
* Returns the project with all available expand options.

properties

EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored.

Returns an array of JIRA::API::Project.

`searchProjects`

my $res = $client->searchProjects()->get;

Get projects paginated

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

orderBy

Order the results by a field.

category Sorts by project category. A complete list of category IDs is found using Get all project categories.
issueCount Sorts by the total number of issues in each project.
key Sorts by project key.
lastIssueUpdatedTime Sorts by the last issue update time.
name Sorts by project name.
owner Sorts by project lead.
archivedDate EXPERIMENTAL. Sorts by project archived date.
deletedDate EXPERIMENTAL. Sorts by project deleted date.

id

The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Up to 50 project IDs can be provided.

keys

The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example, keys=PA&keys=PB. Up to 50 project keys can be provided.

query

Filter the results using a literal string. Projects with a matching key or name are returned (case insensitive).

typeKey

Orders results by the project type. This parameter accepts a comma-separated list. Valid values are business, service_desk, and software.

categoryId

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.

action

Filter results by projects for which the user can:

view the project, meaning that they have one of the following permissions:
- Browse projects project permission for the project.
- Administer projects project permission for the project.
- Administer Jira global permission.
browse the project, meaning that they have the Browse projects project permission for the project.
edit the project, meaning that they have one of the following permissions:
- Administer projects project permission for the project.
- Administer Jira global permission.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:

description Returns the project description.
projectKeys Returns all project keys associated with a project.
lead Returns information about the project lead.
issueTypes Returns all issue types associated with the project.
url Returns the URL associated with the project.
insight EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.

status

EXPERIMENTAL. Filter results by project status:

live Search live projects.
archived Search archived projects.
deleted Search deleted projects, those in the recycle bin.

properties

EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list.

propertyQuery

EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of nested from {"something":{"nested":1,"other":2}} use [thepropertykey].something.nested=1. Note that the propertyQuery key is enclosed in square brackets to enable searching where the propertyQuery key includes dot (.) or equals (=) characters. Note that thepropertykey is only returned when included in properties.

Returns a JIRA::API::PageBeanProject.

`getAllProjectTypes`

my $res = $client->getAllProjectTypes()->get;

Get all project types

Parameters

Returns an array of JIRA::API::ProjectType.

`getAllAccessibleProjectTypes`

my $res = $client->getAllAccessibleProjectTypes()->get;

Get licensed project types

Parameters

Returns an array of JIRA::API::ProjectType.

`getProjectTypeByKey`

my $res = $client->getProjectTypeByKey()->get;

Get project type by key

Parameters

projectTypeKey: The key of the project type.

Returns a JIRA::API::ProjectType.

`getAccessibleProjectTypeByKey`

my $res = $client->getAccessibleProjectTypeByKey()->get;

Get accessible project type by key

Parameters

projectTypeKey: The key of the project type.

Returns a JIRA::API::ProjectType.

`deleteProject`

my $res = $client->deleteProject()->get;

Delete project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
enableUndo: Whether this project is placed in the Jira recycle bin where it will be available for restoration.

`getProject`

my $res = $client->getProject()->get;

Get project

Parameters

projectIdOrKey

The project ID or project key (case sensitive).

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that the project description, issue types, and project lead are included in all responses by default. Expand options include:

description The project description.
issueTypes The issue types associated with the project.
lead The project lead.
projectKeys All project keys associated with the project.
issueTypeHierarchy The project issue type hierarchy.

properties

A list of project properties to return for the project. This parameter accepts a comma-separated list.

Returns a JIRA::API::Project.

`updateProject`

my $res = $client->updateProject()->get;

Update project

Parameters

projectIdOrKey

The project ID or project key (case sensitive).

expand

description The project description.
issueTypes The issue types associated with the project.
lead The project lead.
projectKeys All project keys associated with the project.

Options

assigneeType: The default assignee when creating issues for this project.
avatarId: An integer value for the project's avatar.
categoryId: The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. To remove the project category from the project, set the value to -1.
description: A brief description of the project.
issueSecurityScheme: The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.
key: Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.
lead: This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Cannot be provided with leadAccountId.
leadAccountId: The account ID of the project lead. Cannot be provided with lead.
name: The name of the project.
notificationScheme: The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.
permissionScheme: The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.
url: A link to information about this project, such as project documentation

Returns a JIRA::API::Project.

`archiveProject`

my $res = $client->archiveProject()->get;

Archive project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns a >>.

`updateProjectAvatar`

my $res = $client->updateProjectAvatar()->get;

Set project avatar

Parameters

projectIdOrKey: The ID or (case-sensitive) key of the project.

Options

fileName: The file name of the avatar icon. Returned for system avatars.
id: The ID of the avatar.
isDeletable: Whether the avatar can be deleted.
isSelected: Whether the avatar is used in Jira. For example, shown as a project's avatar.
isSystemAvatar: Whether the avatar is a system avatar.
owner: The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user.
urls: The list of avatar icon URLs.

Returns a >>.

`deleteProjectAvatar`

my $res = $client->deleteProjectAvatar()->get;

Delete project avatar

Parameters

projectIdOrKey: The project ID or (case-sensitive) key.
id: The ID of the avatar.

`createProjectAvatar`

my $res = $client->createProjectAvatar()->get;

Load project avatar

Parameters

projectIdOrKey: The ID or (case-sensitive) key of the project.
x: The X coordinate of the top-left corner of the crop region.
y: The Y coordinate of the top-left corner of the crop region.
size: The length of each side of the crop region.

Returns a JIRA::API::Avatar.

`getAllProjectAvatars`

my $res = $client->getAllProjectAvatars()->get;

Get all project avatars

Parameters

projectIdOrKey: The ID or (case-sensitive) key of the project.

Returns a JIRA::API::ProjectAvatars.

`getProjectComponentsPaginated`

my $res = $client->getProjectComponentsPaginated()->get;

Get project components paginated

Parameters

projectIdOrKey

The project ID or project key (case sensitive).

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

orderBy

Order the results by a field:

description Sorts by the component description.
issueCount Sorts by the count of issues associated with the component.
lead Sorts by the user key of the component's project lead.
name Sorts by component name.

query

Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

Returns a JIRA::API::PageBeanComponentWithIssueCount.

`getProjectComponents`

my $res = $client->getProjectComponents()->get;

Get project components

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns an array of JIRA::API::ProjectComponent.

`deleteProjectAsynchronously`

my $res = $client->deleteProjectAsynchronously()->get;

Delete project asynchronously

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns a JIRA::API::TaskProgressBeanObject.

`getFeaturesForProject`

my $res = $client->getFeaturesForProject()->get;

Get project features

Parameters

projectIdOrKey: The ID or (case-sensitive) key of the project.

Returns a JIRA::API::ContainerForProjectFeatures.

`toggleFeatureForProject`

my $res = $client->toggleFeatureForProject()->get;

Set project feature state

Parameters

projectIdOrKey: The ID or (case-sensitive) key of the project.
featureKey: The key of the feature.

Options

state: The feature state.

Returns a JIRA::API::ContainerForProjectFeatures.

`getProjectPropertyKeys`

my $res = $client->getProjectPropertyKeys()->get;

Get project property keys

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns a JIRA::API::PropertyKeys.

`deleteProjectProperty`

my $res = $client->deleteProjectProperty()->get;

Delete project property

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
propertyKey: The project property key. Use Get project property keys to get a list of all project property keys.

`getProjectProperty`

my $res = $client->getProjectProperty()->get;

Get project property

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
propertyKey: The project property key. Use Get project property keys to get a list of all project property keys.

Returns a JIRA::API::EntityProperty.

`setProjectProperty`

my $res = $client->setProjectProperty()->get;

Set project property

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
propertyKey: The key of the project property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`restore`

my $res = $client->restore()->get;

Restore deleted or archived project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns a JIRA::API::Project.

`getProjectRoles`

my $res = $client->getProjectRoles()->get;

Get project roles for project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns a object.

`deleteActor`

my $res = $client->deleteActor()->get;

Delete actors from project role

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
id: The ID of the project role. Use Get all project roles to get a list of project role IDs.
user: The user account ID of the user to remove from the project role.
group: The name of the group to remove from the project role. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.
groupId: The ID of the group to remove from the project role. This parameter cannot be used with the group parameter.

`getProjectRole`

my $res = $client->getProjectRole()->get;

Get project role for project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
id: The ID of the project role. Use Get all project roles to get a list of project role IDs.
excludeInactiveUsers: Exclude inactive users.

Returns a JIRA::API::ProjectRole.

`addActorUsers`

my $res = $client->addActorUsers()->get;

Add actors to project role

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Options

group: The name of the group to add. This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.
groupId: The ID of the group to add. This parameter cannot be used with the group parameter.
user: The user account ID of the user to add.

Returns a JIRA::API::ProjectRole.

`setActors`

my $res = $client->setActors()->get;

Set actors for project role

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Options

categorisedActors

The actors to add to the project role.

Add groups using:

atlassian-group-role-actor and a list of group names.
atlassian-group-role-actor-id and a list of group IDs.

As a group's name can change, use of atlassian-group-role-actor-id is recommended. For example, "atlassian-group-role-actor-id":["eef79f81-0b89-4fca-a736-4be531a10869","77f6ab39-e755-4570-a6ae-2d7a8df0bcb8"].

Add users using atlassian-user-role-actor and a list of account IDs. For example, "atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12", "abcdef12-3456-789a-bcde-f123456789ab"].

id

The ID of the project role. Use Get all project roles to get a list of project role IDs.

Returns a JIRA::API::ProjectRole.

`getProjectRoleDetails`

my $res = $client->getProjectRoleDetails()->get;

Get project role details

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
currentMember: Whether the roles should be filtered to include only those the user is assigned to.
excludeConnectAddons

Returns an array of JIRA::API::ProjectRoleDetails.

`getAllStatuses`

my $res = $client->getAllStatuses()->get;

Get all statuses for project

Parameters

projectIdOrKey: The project ID or project key (case sensitive).

Returns an array of JIRA::API::IssueTypeWithStatus.

`updateProjectType`

my $res = $client->updateProjectType()->get;

Update project type

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
newProjectTypeKey: The key of the new project type.

Returns a JIRA::API::Project.

`getProjectVersionsPaginated`

my $res = $client->getProjectVersionsPaginated()->get;

Get project versions paginated

Parameters

projectIdOrKey

The project ID or project key (case sensitive).

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

orderBy

Order the results by a field:

description Sorts by version description.
name Sorts by version name.
releaseDate Sorts by release date, starting with the oldest date. Versions with no release date are listed last.
sequence Sorts by the order of appearance in the user interface.
startDate Sorts by start date, starting with the oldest date. Versions with no start date are listed last.

query

Filter the results using a literal string. Versions with matching name or description are returned (case insensitive).

status

A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are released, unreleased, and archived.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

issuesstatus Returns the number of issues in each status category for each version.
operations Returns actions that can be performed on the specified version.

Returns a JIRA::API::PageBeanVersion.

`getProjectVersions`

my $res = $client->getProjectVersions()->get;

Get project versions

Parameters

projectIdOrKey: The project ID or project key (case sensitive).
expand: Use expand to include additional information in the response. This parameter accepts operations, which returns actions that can be performed on the version.

Returns an array of JIRA::API::Version.

`getProjectEmail`

my $res = $client->getProjectEmail()->get;

Get project's sender email

Parameters

projectId: The project ID.

Returns a JIRA::API::ProjectEmailAddress.

`updateProjectEmail`

my $res = $client->updateProjectEmail()->get;

Set project's sender email

Parameters

projectId: The project ID.

Options

emailAddress: The email address.
emailAddressStatus: When using a custom domain, the status of the email address.

Returns a >>.

`getHierarchy`

my $res = $client->getHierarchy()->get;

Get project issue type hierarchy

Parameters

projectId: The ID of the project.

Returns a JIRA::API::ProjectIssueTypeHierarchy.

`getProjectIssueSecurityScheme`

my $res = $client->getProjectIssueSecurityScheme()->get;

Get project issue security scheme

Parameters

projectKeyOrId: The project ID or project key (case sensitive).

Returns a JIRA::API::SecurityScheme.

`getNotificationSchemeForProject`

my $res = $client->getNotificationSchemeForProject()->get;

Get project notification scheme

Parameters

projectKeyOrId

The project ID or project key (case sensitive).

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

all Returns all expandable information
field Returns information about any custom fields assigned to receive an event
group Returns information about any groups assigned to receive an event
notificationSchemeEvents Returns a list of event associations. This list is returned for all expandable information
projectRole Returns information about any project roles assigned to receive an event
user Returns information about any users assigned to receive an event

Returns a JIRA::API::NotificationScheme.

`getAssignedPermissionScheme`

my $res = $client->getAssignedPermissionScheme()->get;

Get assigned permission scheme

Parameters

projectKeyOrId

The project ID or project key (case sensitive).

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Returns a JIRA::API::PermissionScheme.

`assignPermissionScheme`

my $res = $client->assignPermissionScheme()->get;

Assign permission scheme

Parameters

projectKeyOrId

The project ID or project key (case sensitive).

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are included when you specify any value. Expand options include:

all Returns all expandable information.
field Returns information about the custom field granted the permission.
group Returns information about the group that is granted the permission.
permissions Returns all permission grants for each permission scheme.
projectRole Returns information about the project role granted the permission.
user Returns information about the user who is granted the permission.

Options

id: The ID of the permission scheme to associate with the project. Use the Get all permission schemes resource to get a list of permission scheme IDs.

Returns a JIRA::API::PermissionScheme.

`getSecurityLevelsForProject`

my $res = $client->getSecurityLevelsForProject()->get;

Get project issue security levels

Parameters

projectKeyOrId: The project ID or project key (case sensitive).

Returns a JIRA::API::ProjectIssueSecurityLevels.

`getAllProjectCategories`

my $res = $client->getAllProjectCategories()->get;

Get all project categories

Parameters

Returns an array of JIRA::API::ProjectCategory.

`createProjectCategory`

my $res = $client->createProjectCategory()->get;

Create project category

Parameters

Options

description: The description of the project category.
id: The ID of the project category.
name: The name of the project category. Required on create, optional on update.
self: The URL of the project category.

Returns a JIRA::API::ProjectCategory.

`removeProjectCategory`

my $res = $client->removeProjectCategory()->get;

Delete project category

Parameters

id: ID of the project category to delete.

`getProjectCategoryById`

my $res = $client->getProjectCategoryById()->get;

Get project category by ID

Parameters

id: The ID of the project category.

Returns a JIRA::API::ProjectCategory.

`updateProjectCategory`

my $res = $client->updateProjectCategory()->get;

Update project category

Parameters

id

Options

description: The description of the project category.
id: The ID of the project category.
name: The name of the project category. Required on create, optional on update.
self: The URL of the project category.

Returns a JIRA::API::UpdatedProjectCategory.

`validateProjectKey`

my $res = $client->validateProjectKey()->get;

Validate project key

Parameters

key: The project key.

Returns a JIRA::API::ErrorCollection.

`getValidProjectKey`

my $res = $client->getValidProjectKey()->get;

Get valid project key

Parameters

key: The project key.

Returns a string.

`getValidProjectName`

my $res = $client->getValidProjectName()->get;

Get valid project name

Parameters

name: The project name.

Returns a string.

`getResolutions`

my $res = $client->getResolutions()->get;

Get resolutions

Parameters

Returns an array of JIRA::API::Resolution.

`createResolution`

my $res = $client->createResolution()->get;

Create resolution

Parameters

Options

description: The description of the resolution.
name: The name of the resolution. Must be unique (case-insensitive).

Returns a JIRA::API::ResolutionId. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`setDefaultResolution`

my $res = $client->setDefaultResolution()->get;

Set default resolution

Parameters

Options

id: The ID of the new default issue resolution. Must be an existing ID or null. Setting this to null erases the default resolution setting.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`moveResolutions`

my $res = $client->moveResolutions()->get;

Move resolutions

Parameters

Options

after: The ID of the resolution. Required if position isn't provided.
ids: The list of resolution IDs to be reordered. Cannot contain duplicates nor after ID.
position: The position for issue resolutions to be moved to. Required if after isn't provided.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`searchResolutions`

my $res = $client->searchResolutions()->get;

Search resolutions

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
id: The list of resolutions IDs to be filtered out
onlyDefault: When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false

Returns a JIRA::API::PageBeanResolutionJsonBean. Returns a JIRA::API::ErrorCollection.

`deleteResolution`

my $res = $client->deleteResolution()->get;

Delete resolution

Parameters

id: The ID of the issue resolution.
replaceWith: The ID of the issue resolution that will replace the currently selected resolution.

`getResolution`

my $res = $client->getResolution()->get;

Get resolution

Parameters

id: The ID of the issue resolution value.

Returns a JIRA::API::Resolution.

`updateResolution`

my $res = $client->updateResolution()->get;

Update resolution

Parameters

id: The ID of the issue resolution.

Options

description: The description of the resolution.
name: The name of the resolution. Must be unique.

Returns a ">>. Returns a . Returns a . Returns a . Returns a ."

`getAllProjectRoles`

my $res = $client->getAllProjectRoles()->get;

Get all project roles

Parameters

Returns an array of JIRA::API::ProjectRole.

`createProjectRole`

my $res = $client->createProjectRole()->get;

Create project role

Parameters

Options

description: A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
name: The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

Returns a JIRA::API::ProjectRole.

`deleteProjectRole`

my $res = $client->deleteProjectRole()->get;

Delete project role

Parameters

id: The ID of the project role to delete. Use Get all project roles to get a list of project role IDs.
swap: The ID of the project role that will replace the one being deleted.

`getProjectRoleById`

my $res = $client->getProjectRoleById()->get;

Get project role by ID

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Returns a JIRA::API::ProjectRole.

`partialUpdateProjectRole`

my $res = $client->partialUpdateProjectRole()->get;

Partial update project role

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Options

description: A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
name: The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

Returns a JIRA::API::ProjectRole.

`fullyUpdateProjectRole`

my $res = $client->fullyUpdateProjectRole()->get;

Fully update project role

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Options

description: A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role.
name: The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role.

Returns a JIRA::API::ProjectRole.

`deleteProjectRoleActorsFromRole`

my $res = $client->deleteProjectRoleActorsFromRole()->get;

Delete default actors from project role

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.
user: The user account ID of the user to remove as a default actor.
groupId: The group ID of the group to be removed as a default actor. This parameter cannot be used with the group parameter.
group: The group name of the group to be removed as a default actor.This parameter cannot be used with the groupId parameter. As a group's name can change, use of groupId is recommended.

Returns a JIRA::API::ProjectRole.

`getProjectRoleActorsForRole`

my $res = $client->getProjectRoleActorsForRole()->get;

Get default actors for project role

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Returns a JIRA::API::ProjectRole.

`addProjectRoleActorsToRole`

my $res = $client->addProjectRoleActorsToRole()->get;

Add default actors to project role

Parameters

id: The ID of the project role. Use Get all project roles to get a list of project role IDs.

Options

group: The name of the group to add as a default actor. This parameter cannot be used with the groupId parameter. As a group's name can change,use of groupId is recommended. This parameter accepts a comma-separated list. For example, "group":["project-admin", "jira-developers"].
groupId: The ID of the group to add as a default actor. This parameter cannot be used with the group parameter This parameter accepts a comma-separated list. For example, "groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8", "0c011f85-69ed-49c4-a801-3b18d0f771bc"].
user: The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example, "user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"].

Returns a JIRA::API::ProjectRole.

`getScreens`

my $res = $client->getScreens()->get;

Get screens

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

queryString

String used to perform a case-insensitive partial match with screen name.

scope

The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.

orderBy

Order the results by a field:

id Sorts by screen ID.
name Sorts by screen name.

Returns a JIRA::API::PageBeanScreen.

`createScreen`

my $res = $client->createScreen()->get;

Create screen

Parameters

Options

description: The description of the screen. The maximum length is 255 characters.
name: The name of the screen. The name must be unique. The maximum length is 255 characters.

Returns a JIRA::API::Screen.

`addFieldToDefaultScreen`

my $res = $client->addFieldToDefaultScreen()->get;

Add field to default screen

Parameters

fieldId: The ID of the field.

Returns a >>.

`deleteScreen`

my $res = $client->deleteScreen()->get;

Delete screen

Parameters

screenId: The ID of the screen.

`updateScreen`

my $res = $client->updateScreen()->get;

Update screen

Parameters

screenId: The ID of the screen.

Options

description: The description of the screen. The maximum length is 255 characters.
name: The name of the screen. The name must be unique. The maximum length is 255 characters.

Returns a JIRA::API::Screen.

`getAvailableScreenFields`

my $res = $client->getAvailableScreenFields()->get;

Get available screen fields

Parameters

screenId: The ID of the screen.

Returns an array of JIRA::API::ScreenableField.

`getAllScreenTabs`

my $res = $client->getAllScreenTabs()->get;

Get all screen tabs

Parameters

screenId: The ID of the screen.
projectKey: The key of the project.

Returns an array of JIRA::API::ScreenableTab.

`addScreenTab`

my $res = $client->addScreenTab()->get;

Create screen tab

Parameters

screenId: The ID of the screen.

Options

id: The ID of the screen tab.
name: The name of the screen tab. The maximum length is 255 characters.

Returns a JIRA::API::ScreenableTab.

`deleteScreenTab`

my $res = $client->deleteScreenTab()->get;

Delete screen tab

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.

`renameScreenTab`

my $res = $client->renameScreenTab()->get;

Update screen tab

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.

Options

id: The ID of the screen tab.
name: The name of the screen tab. The maximum length is 255 characters.

Returns a JIRA::API::ScreenableTab.

`getAllScreenTabFields`

my $res = $client->getAllScreenTabFields()->get;

Get all screen tab fields

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.
projectKey: The key of the project.

Returns an array of JIRA::API::ScreenableField.

`addScreenTabField`

my $res = $client->addScreenTabField()->get;

Add screen tab field

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.

Options

fieldId: The ID of the field to add.

Returns a JIRA::API::ScreenableField.

`removeScreenTabField`

my $res = $client->removeScreenTabField()->get;

Remove screen tab field

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.
id: The ID of the field.

`moveScreenTabField`

my $res = $client->moveScreenTabField()->get;

Move screen tab field

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.
id: The ID of the field.

Options

after: The ID of the screen tab field after which to place the moved screen tab field. Required if position isn't provided.
position: The named position to which the screen tab field should be moved. Required if after isn't provided.

Returns a >>.

`moveScreenTab`

my $res = $client->moveScreenTab()->get;

Move screen tab

Parameters

screenId: The ID of the screen.
tabId: The ID of the screen tab.
pos: The position of tab. The base index is 0.

Returns a >>.

`getScreenSchemes`

my $res = $client->getScreenSchemes()->get;

Get screen schemes

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

id

The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

expand

Use expand include additional information in the response. This parameter accepts issueTypeScreenSchemes that, for each screen schemes, returns information about the issue type screen scheme the screen scheme is assigned to.

queryString

String used to perform a case-insensitive partial match with screen scheme name.

orderBy

Order the results by a field:

id Sorts by screen scheme ID.
name Sorts by screen scheme name.

Returns a JIRA::API::PageBeanScreenScheme.

`createScreenScheme`

my $res = $client->createScreenScheme()->get;

Create screen scheme

Parameters

Options

description: The description of the screen scheme. The maximum length is 255 characters.
name: The name of the screen scheme. The name must be unique. The maximum length is 255 characters.
screens: The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted.

Returns a JIRA::API::ScreenSchemeId.

`deleteScreenScheme`

my $res = $client->deleteScreenScheme()->get;

Delete screen scheme

Parameters

screenSchemeId: The ID of the screen scheme.

`updateScreenScheme`

my $res = $client->updateScreenScheme()->get;

Update screen scheme

Parameters

screenSchemeId: The ID of the screen scheme.

Options

description: The description of the screen scheme. The maximum length is 255 characters.
name: The name of the screen scheme. The name must be unique. The maximum length is 255 characters.
screens: The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted.

Returns a >>.

`searchForIssuesUsingJql`

my $res = $client->searchForIssuesUsingJql()->get;

Search for issues using JQL (GET)

Parameters

jql

The JQL that defines the search. Note:

If no JQL expression is provided, all issues are returned.
username and userkey cannot be used as search terms due to privacy reasons. Use accountId instead.
If a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting id or key only.

validateQuery

Determines how to validate the JQL query and treat the validation results. Supported values are:

strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
warn Returns all errors as warnings.
none No validation is performed.
true Deprecated A legacy synonym for strict.
false Deprecated A legacy synonym for warn.

Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

fields

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

*all Returns all fields.
*navigable Returns navigable fields.
Any issue field, prefixed with a minus to exclude.

Examples:

summary,comment Returns only the summary and comments fields.
-description Returns all navigable (default) fields except description.
*all,-comment Returns all fields except comments.

This parameter may be specified multiple times. For example, fields=field1,field2&fields=field3.

Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

expand

Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:

renderedFields Returns field values rendered in HTML format.
names Returns the display name of each field.
schema Returns the schema describing a field type.
transitions Returns all possible transitions for the issue.
operations Returns all possible operations for the issue.
editmeta Returns information about how each field can be edited.
changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

properties

A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, properties=prop1,prop2&properties=prop3. A maximum of 5 issue property keys can be specified.

fieldsByKeys

Reference fields by their key (rather than ID).

Returns a JIRA::API::SearchResults.

`searchForIssuesUsingJqlPost`

my $res = $client->searchForIssuesUsingJqlPost()->get;

Search for issues using JQL (POST)

Parameters

Options

expand

Use expand#expansion> to include additional information about issues in the response. Note that, unlike the majority of instances where expand is specified, expand is defined as a list of values. The expand options are:

renderedFields Returns field values rendered in HTML format.
names Returns the display name of each field.
schema Returns the schema describing a field type.
transitions Returns all possible transitions for the issue.
operations Returns all possible operations for the issue.
editmeta Returns information about how each field can be edited.
changelog Returns a list of recent updates to an issue, sorted by date, starting from the most recent.
versionedRepresentations Instead of fields, returns versionedRepresentations a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.

fields

A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:

*all Returns all fields.
*navigable Returns navigable fields.
Any issue field, prefixed with a minus to exclude.

The default is *navigable.

Examples:

summary,comment Returns the summary and comments fields only.
-description Returns all navigable (default) fields except description.
*all,-comment Returns all fields except comments.

Multiple fields parameters can be included in a request.

Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields.

fieldsByKeys

Reference fields by their key (rather than ID). The default is false.

jql

A JQL expression.

maxResults

The maximum number of items to return per page.

properties

A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.

startAt

The index of the first item to return in the page of results (page offset). The base index is 0.

validateQuery

Determines how to validate the JQL query and treat the validation results. Supported values:

strict Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).
warn Returns all errors as warnings.
none No validation is performed.
true Deprecated A legacy synonym for strict.
false Deprecated A legacy synonym for warn.

The default is strict.

Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the validateQuery value.

Returns a JIRA::API::SearchResults.

`getIssueSecurityLevel`

my $res = $client->getIssueSecurityLevel()->get;

Get issue security level

Parameters

id: The ID of the issue security level.

Returns a JIRA::API::SecurityLevel.

`getServerInfo`

my $res = $client->getServerInfo()->get;

Get Jira instance info

Parameters

Returns a JIRA::API::ServerInformation.

`getIssueNavigatorDefaultColumns`

my $res = $client->getIssueNavigatorDefaultColumns()->get;

Get issue navigator default columns

Parameters

Returns an array of JIRA::API::ColumnItem.

`setIssueNavigatorDefaultColumns`

my $res = $client->setIssueNavigatorDefaultColumns()->get;

Set issue navigator default columns

Parameters

Returns a >>.

`getStatuses`

my $res = $client->getStatuses()->get;

Get all statuses

Parameters

Returns an array of JIRA::API::StatusDetails.

`getStatus`

my $res = $client->getStatus()->get;

Get status

Parameters

idOrName: The ID or name of the status.

Returns a JIRA::API::StatusDetails.

`getStatusCategories`

my $res = $client->getStatusCategories()->get;

Get all status categories

Parameters

Returns an array of JIRA::API::StatusCategory.

`getStatusCategory`

my $res = $client->getStatusCategory()->get;

Get status category

Parameters

idOrKey: The ID or key of the status category.

Returns a JIRA::API::StatusCategory.

`deleteStatusesById`

my $res = $client->deleteStatusesById()->get;

Bulk delete Statuses

Parameters

id

The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

Min items 1, Max items 50

Returns a >>.

`getStatusesById`

my $res = $client->getStatusesById()->get;

Bulk get statuses

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

usages Returns the project and issue types that use the status in their workflow.

id

The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

Min items 1, Max items 50

Returns an array of JIRA::API::JiraStatus.

`createStatuses`

my $res = $client->createStatuses()->get;

Bulk create statuses

Parameters

Options

scope: The scope of the status.
statuses: Details of the statuses being created.

Returns an array of JIRA::API::JiraStatus.

`updateStatuses`

my $res = $client->updateStatuses()->get;

Bulk update statuses

Parameters

Options

statuses: The list of statuses that will be updated.

Returns a >>.

`search`

my $res = $client->search()->get;

Search statuses paginated

Parameters

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

usages Returns the project and issue types that use the status in their workflow.

projectId

The project the status is part of or null for global statuses.

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

searchString

Term to match status names against or null to search for all statuses in the search scope.

statusCategory

Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

Returns a JIRA::API::PageOfStatuses.

`getTask`

my $res = $client->getTask()->get;

Get task

Parameters

taskId: The ID of the task.

Returns a JIRA::API::TaskProgressBeanObject.

`cancelTask`

my $res = $client->cancelTask()->get;

Cancel task

Parameters

taskId: The ID of the task.

Returns a ">>. Returns an array of . Returns an array of . Returns an array of . Returns an array of ."

`getUiModifications`

my $res = $client->getUiModifications()->get;

Get UI modifications

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

data Returns UI modification data.
contexts Returns UI modification contexts.

Returns a JIRA::API::PageBeanUiModificationDetails.

`createUiModification`

my $res = $client->createUiModification()->get;

Create UI modification

Parameters

Options

contexts: List of contexts of the UI modification. The maximum number of contexts is 1000.
data: The data of the UI modification. The maximum size of the data is 50000 characters.
description: The description of the UI modification. The maximum length is 255 characters.
name: The name of the UI modification. The maximum length is 255 characters.

Returns a JIRA::API::UiModificationIdentifiers.

`deleteUiModification`

my $res = $client->deleteUiModification()->get;

Delete UI modification

Parameters

uiModificationId: The ID of the UI modification.

Returns a >>.

`updateUiModification`

my $res = $client->updateUiModification()->get;

Update UI modification

Parameters

uiModificationId: The ID of the UI modification.

Options

contexts: List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts.
data: The data of the UI modification. The maximum size of the data is 50000 characters.
description: The description of the UI modification. The maximum length is 255 characters.
name: The name of the UI modification. The maximum length is 255 characters.

Returns a >>.

`getAvatars`

my $res = $client->getAvatars()->get;

Get avatars

Parameters

type: The avatar type.
entityId: The ID of the item the avatar is associated with.

Returns a JIRA::API::Avatars.

`storeAvatar`

my $res = $client->storeAvatar()->get;

Load avatar

Parameters

type: The avatar type.
entityId: The ID of the item the avatar is associated with.
x: The X coordinate of the top-left corner of the crop region.
y: The Y coordinate of the top-left corner of the crop region.
size: The length of each side of the crop region.

Returns a JIRA::API::Avatar.

`deleteAvatar`

my $res = $client->deleteAvatar()->get;

Delete avatar

Parameters

type: The avatar type.
owningObjectId: The ID of the item the avatar is associated with.
id: The ID of the avatar.

`getAvatarImageByType`

my $res = $client->getAvatarImageByType()->get;

Get avatar image by type

Parameters

type: The icon type of the avatar.
size: The size of the avatar image. If not provided the default size is returned.
format: The format to return the avatar image in. If not provided the original content format is returned.

Returns a object. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAvatarImageByID`

my $res = $client->getAvatarImageByID()->get;

Get avatar image by ID

Parameters

type: The icon type of the avatar.
id: The ID of the avatar.
size: The size of the avatar image. If not provided the default size is returned.
format: The format to return the avatar image in. If not provided the original content format is returned.

Returns a object. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAvatarImageByOwner`

my $res = $client->getAvatarImageByOwner()->get;

Get avatar image by owner

Parameters

type: The icon type of the avatar.
entityId: The ID of the project or issue type the avatar belongs to.
size: The size of the avatar image. If not provided the default size is returned.
format: The format to return the avatar image in. If not provided the original content format is returned.

Returns a object. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`removeUser`

my $res = $client->removeUser()->get;

Delete user

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
username: This parameter is no longer available. See the deprecation notice for details.
key: This parameter is no longer available. See the deprecation notice for details.

`getUser`

my $res = $client->getUser()->get;

Get user

Parameters

accountId

The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required.

username

This parameter is no longer available. See the deprecation notice for details.

key

This parameter is no longer available. See the deprecation notice for details.

expand

Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:

groups includes all groups and nested groups to which the user belongs.
applicationRoles includes details of all the applications to which the user has access.

Returns a JIRA::API::User.

`createUser`

my $res = $client->createUser()->get;

Create user

Parameters

Options

applicationKeys: Deprecated, do not use.
displayName: This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
emailAddress: The email address for the user.
key: This property is no longer available. See the migration guide for details.
name: This property is no longer available. See the migration guide for details.
password: This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account.
self: The URL of the user.

Returns a JIRA::API::User.

`findBulkAssignableUsers`

my $res = $client->findBulkAssignableUsers()->get;

Find users assignable to projects

Parameters

query: A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.
username: This parameter is no longer available. See the deprecation notice for details.
accountId: A query string that is matched exactly against user accountId. Required, unless query is specified.
projectKeys: A list of project keys (case sensitive). This parameter accepts a comma-separated list.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns an array of JIRA::API::User.

`findAssignableUsers`

my $res = $client->findAssignableUsers()->get;

Find users assignable to issues

Parameters

query: A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless username or accountId is specified.
sessionId: The sessionId of this request. SessionId is the same until the assignee is set.
username: This parameter is no longer available. See the deprecation notice for details.
accountId: A query string that is matched exactly against user accountId. Required, unless query is specified.
project: The project ID or project key (case sensitive). Required, unless issueKey is specified.
issueKey: The key of the issue. Required, unless project is specified.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue.
actionDescriptorId: The ID of the transition.
recommend

Returns an array of JIRA::API::User.

`bulkGetUsers`

my $res = $client->bulkGetUsers()->get;

Bulk get users

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
username: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
key: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
accountId: The account ID of a user. To specify multiple users, pass multiple accountId parameters. For example, accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5.

Returns a JIRA::API::PageBeanUser.

`bulkGetUsersMigration`

my $res = $client->bulkGetUsersMigration()->get;

Get account IDs for users

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
username: Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, username=fred&username=barney. Required if key isn't provided. Cannot be provided if key is present.
key: Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, key=fred&key=barney. Required if username isn't provided. Cannot be provided if username is present.

Returns an array of JIRA::API::UserMigrationBean.

`resetUserColumns`

my $res = $client->resetUserColumns()->get;

Reset user default columns

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
username: This parameter is no longer available. See the deprecation notice for details.

`getUserDefaultColumns`

my $res = $client->getUserDefaultColumns()->get;

Get user default columns

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
username: This parameter is no longer available See the deprecation notice for details.

Returns an array of JIRA::API::ColumnItem.

`setUserColumns`

my $res = $client->setUserColumns()->get;

Set user default columns

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

Returns a >>.

`getUserEmail`

my $res = $client->getUserEmail()->get;

Get user email

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

Returns a JIRA::API::UnrestrictedUserEmail.

`getUserEmailBulk`

my $res = $client->getUserEmailBulk()->get;

Get user email bulk

Parameters

accountId: The account IDs of the users for which emails are required. An accountId is an identifier that uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Note, this should be treated as an opaque identifier (that is, do not assume any structure in the value).

Returns a JIRA::API::UnrestrictedUserEmail.

`getUserGroups`

my $res = $client->getUserGroups()->get;

Get user groups

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
username: This parameter is no longer available. See the deprecation notice for details.
key: This parameter is no longer available. See the deprecation notice for details.

Returns an array of JIRA::API::GroupName.

`findUsersWithAllPermissions`

my $res = $client->findUsersWithAllPermissions()->get;

Find users with permissions

Parameters

query

A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.

username

This parameter is no longer available. See the deprecation notice for details.

accountId

A query string that is matched exactly against user accountId. Required, unless query is specified.

permissions

A comma separated list of permissions. Permissions can be specified as any:

permission returned by Get all permissions.
custom project permission added by Connect apps.
(deprecated) one of the following:
- ASSIGNABLE_USER
- ASSIGN_ISSUE
- ATTACHMENT_DELETE_ALL
- ATTACHMENT_DELETE_OWN
- BROWSE
- CLOSE_ISSUE
- COMMENT_DELETE_ALL
- COMMENT_DELETE_OWN
- COMMENT_EDIT_ALL
- COMMENT_EDIT_OWN
- COMMENT_ISSUE
- CREATE_ATTACHMENT
- CREATE_ISSUE
- DELETE_ISSUE
- EDIT_ISSUE
- LINK_ISSUE
- MANAGE_WATCHER_LIST
- MODIFY_REPORTER
- MOVE_ISSUE
- PROJECT_ADMIN
- RESOLVE_ISSUE
- SCHEDULE_ISSUE
- SET_ISSUE_SECURITY
- TRANSITION_ISSUE
- VIEW_VERSION_CONTROL
- VIEW_VOTERS_AND_WATCHERS
- VIEW_WORKFLOW_READONLY
- WORKLOG_DELETE_ALL
- WORKLOG_DELETE_OWN
- WORKLOG_EDIT_ALL
- WORKLOG_EDIT_OWN
- WORK_ISSUE

issueKey

The issue key for the issue.

projectKey

The project key for the project (case sensitive).

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

Returns an array of JIRA::API::User.

`findUsersForPicker`

my $res = $client->findUsersForPicker()->get;

Find users for picker

Parameters

query: A query string that is matched against user attributes, such as displayName, and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com.
maxResults: The maximum number of items to return. The total number of matched users is returned in total.
showAvatar: Include the URI to the user's avatar.
exclude: This parameter is no longer available. See the deprecation notice for details.
excludeAccountIds: A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided with exclude.
avatarSize
excludeConnectUsers

Returns a JIRA::API::FoundUsers.

`getUserPropertyKeys`

my $res = $client->getUserPropertyKeys()->get;

Get user property keys

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
userKey: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
username: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

Returns a JIRA::API::PropertyKeys.

`deleteUserProperty`

my $res = $client->deleteUserProperty()->get;

Delete user property

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
userKey: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
username: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
propertyKey: The key of the user's property.

`getUserProperty`

my $res = $client->getUserProperty()->get;

Get user property

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
userKey: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
username: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
propertyKey: The key of the user's property.

Returns a JIRA::API::EntityProperty.

`setUserProperty`

my $res = $client->setUserProperty()->get;

Set user property

Parameters

accountId: The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
userKey: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
username: This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
propertyKey: The key of the user's property. The maximum length is 255 characters.

Returns a ">>. Returns a "

`findUsers`

my $res = $client->findUsers()->get;

Find users

Parameters

query: A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId or property is specified.
username
accountId: A query string that is matched exactly against a user accountId. Required, unless query or property is specified.
startAt: The index of the first item to return in a page of filtered results (page offset).
maxResults: The maximum number of items to return per page.
property: A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

Returns an array of JIRA::API::User.

`findUsersByQuery`

my $res = $client->findUsersByQuery()->get;

Find users by query

Parameters

query: The search query.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanUser.

`findUserKeysByQuery`

my $res = $client->findUserKeysByQuery()->get;

Find user keys by query

Parameters

query: The search query.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanUserKey.

`findUsersWithBrowsePermission`

my $res = $client->findUsersWithBrowsePermission()->get;

Find users with browse permission

Parameters

query: A query string that is matched against user attributes, such as displayName and emailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with a displayName of John Smith and a user with an emailAddress of johnson@example.com. Required, unless accountId is specified.
username: This parameter is no longer available. See the deprecation notice for details.
accountId: A query string that is matched exactly against user accountId. Required, unless query is specified.
issueKey: The issue key for the issue. Required, unless projectKey is specified.
projectKey: The project key for the project (case sensitive). Required, unless issueKey is specified.
startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns an array of JIRA::API::User.

`getAllUsersDefault`

my $res = $client->getAllUsersDefault()->get;

Get all users default

Parameters

startAt: The index of the first item to return.
maxResults: The maximum number of items to return.

Returns an array of JIRA::API::User.

`getAllUsers`

my $res = $client->getAllUsers()->get;

Get all users

Parameters

startAt: The index of the first item to return.
maxResults: The maximum number of items to return.

Returns an array of JIRA::API::User.

`createVersion`

my $res = $client->createVersion()->get;

Create version

Parameters

Options

archived

Indicates that the version is archived. Optional when creating or updating a version.

description

The description of the version. Optional when creating or updating a version.

expand

Use expand#expansion> to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

operations Returns the list of operations available for this version.
issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

Optional for create and update.

id

The ID of the version.

issuesStatusForFixVersion

If the expand option issuesstatus is used, returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

moveUnfixedIssuesTo

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations

If the expand option operations is used, returns the list of operations available for this version.

overdue

Indicates that the version is overdue.

project

Deprecated. Use projectId.

projectId

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

releaseDate

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

released

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

self

The URL of the version.

startDate

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

Returns a JIRA::API::Version.

`deleteVersion`

my $res = $client->deleteVersion()->get;

Delete version

Parameters

id: The ID of the version.
moveFixIssuesTo: The ID of the version to update fixVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.
moveAffectedIssuesTo: The ID of the version to update affectedVersion to when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted.

`getVersion`

my $res = $client->getVersion()->get;

Get version

Parameters

id

The ID of the version.

expand

Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

operations Returns the list of operations available for this version.
issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done.

Returns a JIRA::API::Version.

`updateVersion`

my $res = $client->updateVersion()->get;

Update version

Parameters

id: The ID of the version.

Options

archived

Indicates that the version is archived. Optional when creating or updating a version.

description

The description of the version. Optional when creating or updating a version.

expand

Use expand#expansion> to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:

operations Returns the list of operations available for this version.
issuesstatus Returns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property contains a count of issues with a status other than to do, in progress, and done.

Optional for create and update.

id

The ID of the version.

issuesStatusForFixVersion

moveUnfixedIssuesTo

The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version.

name

The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters.

operations

If the expand option operations is used, returns the list of operations available for this version.

overdue

Indicates that the version is overdue.

project

Deprecated. Use projectId.

projectId

The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version.

releaseDate

The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

released

Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version.

self

The URL of the version.

startDate

The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version.

userReleaseDate

The date on which work on this version is expected to finish, expressed in the instance's Day/Month/Year Format date format.

userStartDate

The date on which work on this version is expected to start, expressed in the instance's Day/Month/Year Format date format.

Returns a JIRA::API::Version.

`mergeVersions`

my $res = $client->mergeVersions()->get;

Merge versions

Parameters

id: The ID of the version to delete.
moveIssuesTo: The ID of the version to merge into.

Returns a >>.

`moveVersion`

my $res = $client->moveVersion()->get;

Move version

Parameters

id: The ID of the version to be moved.

Options

after: The URL (self link) of the version after which to place the moved version. Cannot be used with position.
position: An absolute position in which to place the moved version. Cannot be used with after.

Returns a JIRA::API::Version.

`getVersionRelatedIssues`

my $res = $client->getVersionRelatedIssues()->get;

Get version's related issues count

Parameters

id: The ID of the version.

Returns a JIRA::API::VersionIssueCounts.

`deleteAndReplaceVersion`

my $res = $client->deleteAndReplaceVersion()->get;

Delete and replace version

Parameters

id: The ID of the version.

Options

customFieldReplacementList: An array of custom field IDs (customFieldId) and version IDs (moveTo) to update when the fields contain the deleted version.
moveAffectedIssuesTo: The ID of the version to update affectedVersion to when the field contains the deleted version.
moveFixIssuesTo: The ID of the version to update fixVersion to when the field contains the deleted version.

Returns a >>.

`getVersionUnresolvedIssues`

my $res = $client->getVersionUnresolvedIssues()->get;

Get version's unresolved issues count

Parameters

id: The ID of the version.

Returns a JIRA::API::VersionUnresolvedIssuesCount.

`deleteWebhookById`

my $res = $client->deleteWebhookById()->get;

Delete webhooks by ID

Parameters

Options

webhookIds: A list of webhook IDs.

Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getDynamicWebhooksForApp`

my $res = $client->getDynamicWebhooksForApp()->get;

Get dynamic webhooks for app

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanWebhook. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`registerDynamicWebhooks`

my $res = $client->registerDynamicWebhooks()->get;

Parameters

Options

url: The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered.
webhooks: A list of webhooks.

Returns a JIRA::API::ContainerForRegisteredWebhooks. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getFailedWebhooks`

my $res = $client->getFailedWebhooks()->get;

Get failed webhooks

Parameters

maxResults: The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page.
after: The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch.

Returns a JIRA::API::FailedWebhooks. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`refreshWebhooks`

my $res = $client->refreshWebhooks()->get;

Extend webhook life

Parameters

Options

webhookIds: A list of webhook IDs.

Returns a JIRA::API::WebhooksExpirationDate. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getAllWorkflows`

my $res = $client->getAllWorkflows()->get;

Get all workflows

Parameters

workflowName: The name of the workflow to be returned. Only one workflow can be specified.

Returns an array of JIRA::API::DeprecatedWorkflow.

`createWorkflow`

my $res = $client->createWorkflow()->get;

Create workflow

Parameters

Options

description

The description of the workflow. The maximum length is 1000 characters.

name

The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace.

statuses

The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition.

transitions

The transitions of the workflow. For the request to be valid, these transitions must:

include one initial transition.
not use the same name for a global and directed transition.
have a unique name for each global transition.
have a unique 'to' status for each global transition.
have unique names for each transition from a status.
not have a 'from' status on initial and global transitions.
have a 'from' status on directed transitions.

All the transition statuses must be included in statuses.

Returns a JIRA::API::WorkflowIDs.

`getWorkflowTransitionRuleConfigurations`

my $res = $client->getWorkflowTransitionRuleConfigurations()->get;

Get workflow transition rule configurations

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.
types: The types of the transition rules to return.
keys: The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return.
workflowNames: EXPERIMENTAL: The list of workflow names to filter by.
withTags: EXPERIMENTAL: The list of tags to filter by.
draft: EXPERIMENTAL: Whether draft or published workflows are returned. If not provided, both workflow types are returned.
expand: Use expand to include additional information in the response. This parameter accepts transition, which, for each rule, returns information about the transition the rule is assigned to.

Returns a JIRA::API::PageBeanWorkflowTransitionRules. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`updateWorkflowTransitionRuleConfigurations`

my $res = $client->updateWorkflowTransitionRuleConfigurations()->get;

Update workflow transition rule configurations

Parameters

Options

workflows: The list of workflows with transition rules to update.

Returns a JIRA::API::WorkflowTransitionRulesUpdateErrors. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`deleteWorkflowTransitionRuleConfigurations`

my $res = $client->deleteWorkflowTransitionRuleConfigurations()->get;

Delete workflow transition rule configurations

Parameters

Options

workflows: The list of workflows with transition rules to delete.

Returns a JIRA::API::WorkflowTransitionRulesUpdateErrors. Returns a JIRA::API::ErrorCollection. Returns a JIRA::API::ErrorCollection.

`getWorkflowsPaginated`

my $res = $client->getWorkflowsPaginated()->get;

Get workflows paginated

Parameters

startAt

The index of the first item to return in a page of results (page offset).

maxResults

The maximum number of items to return per page.

workflowName

The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, workflowName=name1&workflowName=name2.

expand

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

transitions For each workflow, returns information about the transitions inside the workflow.
transitions.rules For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.
transitions.properties For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested.
statuses For each workflow, returns information about the statuses inside the workflow.
statuses.properties For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.
default For each workflow, returns information about whether this is the default workflow.
schemes For each workflow, returns information about the workflow schemes the workflow is assigned to.
projects For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes.
hasDraftWorkflow For each workflow, returns information about whether the workflow has a draft version.
operations For each workflow, returns information about the actions that can be undertaken on the workflow.

queryString

String used to perform a case-insensitive partial match with workflow name.

orderBy

Order the results by a field:

name Sorts by workflow name.
created Sorts by create time.
updated Sorts by update time.

isActive

Filters active and inactive workflows.

Returns a JIRA::API::PageBeanWorkflow. Returns a JIRA::API::ErrorCollection.

`deleteWorkflowTransitionProperty`

my $res = $client->deleteWorkflowTransitionProperty()->get;

Delete workflow transition property

Parameters

transitionId: The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
key: The name of the transition property to delete, also known as the name of the property.
workflowName: The name of the workflow that the transition belongs to.
workflowMode: The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

`getWorkflowTransitionProperties`

my $res = $client->getWorkflowTransitionProperties()->get;

Get workflow transition properties

Parameters

transitionId: The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition.
includeReservedKeys: Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true.
key: The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned.
workflowName: The name of the workflow that the transition belongs to.
workflowMode: The workflow status. Set to live for active and inactive workflows, or draft for draft workflows.

Returns a JIRA::API::WorkflowTransitionProperty.

`createWorkflowTransitionProperty`

my $res = $client->createWorkflowTransitionProperty()->get;

Create workflow transition property

Parameters

transitionId: The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
key: The key of the property being added, also known as the name of the property. Set this to the same value as the key defined in the request body.
workflowName: The name of the workflow that the transition belongs to.
workflowMode: The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

Options

id: The ID of the transition property.
key: The key of the transition property. Also known as the name of the transition property.
value: The value of the transition property.

Returns a JIRA::API::WorkflowTransitionProperty.

`updateWorkflowTransitionProperty`

my $res = $client->updateWorkflowTransitionProperty()->get;

Update workflow transition property

Parameters

transitionId: The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition.
key: The key of the property being updated, also known as the name of the property. Set this to the same value as the key defined in the request body.
workflowName: The name of the workflow that the transition belongs to.
workflowMode: The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited.

Options

id: The ID of the transition property.
key: The key of the transition property. Also known as the name of the transition property.
value: The value of the transition property.

Returns a JIRA::API::WorkflowTransitionProperty.

`deleteInactiveWorkflow`

my $res = $client->deleteInactiveWorkflow()->get;

Delete inactive workflow

Parameters

entityId: The entity ID of the workflow.

`getAllWorkflowSchemes`

my $res = $client->getAllWorkflowSchemes()->get;

Get all workflow schemes

Parameters

startAt: The index of the first item to return in a page of results (page offset).
maxResults: The maximum number of items to return per page.

Returns a JIRA::API::PageBeanWorkflowScheme.

`createWorkflowScheme`

my $res = $client->createWorkflowScheme()->get;

Create workflow scheme

Parameters

Options

defaultWorkflow

The name of the default workflow for the workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira. If defaultWorkflow is not specified when creating a workflow scheme, it is set to Jira Workflow (jira).

description

The description of the workflow scheme.

draft

Whether the workflow scheme is a draft or not.

id

The ID of the workflow scheme.

issueTypeMappings

The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

issueTypes

The issue types available in Jira.

lastModified

The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

lastModifiedUser

The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

name

The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

originalDefaultWorkflow

For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

originalIssueTypeMappings

For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

self

updateDraftIfNeeded

Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:

Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.

Defaults to false.

Returns a JIRA::API::WorkflowScheme.

`getWorkflowSchemeProjectAssociations`

my $res = $client->getWorkflowSchemeProjectAssociations()->get;

Get workflow scheme project associations

Parameters

projectId: The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, projectId=10000&projectId=10001.

Returns a JIRA::API::ContainerOfWorkflowSchemeAssociations.

`assignSchemeToProject`

my $res = $client->assignSchemeToProject()->get;

Assign workflow scheme to project

Parameters

Options

projectId: The ID of the project.
workflowSchemeId: The ID of the workflow scheme. If the workflow scheme ID is null, the operation assigns the default workflow scheme.

Returns a >>.

`deleteWorkflowScheme`

my $res = $client->deleteWorkflowScheme()->get;

Delete workflow scheme

Parameters

id: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

Returns a >>.

`getWorkflowScheme`

my $res = $client->getWorkflowScheme()->get;

Get workflow scheme

Parameters

id: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.
returnDraftIfExists: Returns the workflow scheme's draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned.

Returns a JIRA::API::WorkflowScheme.

`updateWorkflowScheme`

my $res = $client->updateWorkflowScheme()->get;

Update workflow scheme

Parameters

id: The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as schemeId. For example, schemeId=10301.

Options

defaultWorkflow

description

The description of the workflow scheme.

draft

Whether the workflow scheme is a draft or not.

id

The ID of the workflow scheme.

issueTypeMappings

The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

issueTypes

The issue types available in Jira.

lastModified

The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

lastModifiedUser

The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

name

The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

originalDefaultWorkflow

For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

originalIssueTypeMappings

self

updateDraftIfNeeded

Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.

Defaults to false.

Returns a JIRA::API::WorkflowScheme.

`createWorkflowSchemeDraftFromParent`

my $res = $client->createWorkflowSchemeDraftFromParent()->get;

Create draft workflow scheme

Parameters

id: The ID of the active workflow scheme that the draft is created from.

Returns a JIRA::API::WorkflowScheme.

`deleteDefaultWorkflow`

my $res = $client->deleteDefaultWorkflow()->get;

Delete default workflow

Parameters

id: The ID of the workflow scheme.
updateDraftIfNeeded: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.

Returns a JIRA::API::WorkflowScheme.

`getDefaultWorkflow`

my $res = $client->getDefaultWorkflow()->get;

Get default workflow

Parameters

id: The ID of the workflow scheme.
returnDraftIfExists: Set to true to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned.

Returns a JIRA::API::DefaultWorkflow.

`updateDefaultWorkflow`

my $res = $client->updateDefaultWorkflow()->get;

Update default workflow

Parameters

id: The ID of the workflow scheme.

Options

updateDraftIfNeeded: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false.
workflow: The name of the workflow to set as the default workflow.

Returns a JIRA::API::WorkflowScheme.

`deleteWorkflowSchemeDraft`

my $res = $client->deleteWorkflowSchemeDraft()->get;

Delete draft workflow scheme

Parameters

id: The ID of the active workflow scheme that the draft was created from.

`getWorkflowSchemeDraft`

my $res = $client->getWorkflowSchemeDraft()->get;

Get draft workflow scheme

Parameters

id: The ID of the active workflow scheme that the draft was created from.

Returns a JIRA::API::WorkflowScheme.

`updateWorkflowSchemeDraft`

my $res = $client->updateWorkflowSchemeDraft()->get;

Update draft workflow scheme

Parameters

id: The ID of the active workflow scheme that the draft was created from.

Options

defaultWorkflow

description

The description of the workflow scheme.

draft

Whether the workflow scheme is a draft or not.

id

The ID of the workflow scheme.

issueTypeMappings

The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.

issueTypes

The issue types available in Jira.

lastModified

The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

lastModifiedUser

The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows.

name

The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme.

originalDefaultWorkflow

For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has All Unassigned Issue Types assigned to it in Jira.

originalIssueTypeMappings

self

updateDraftIfNeeded

Update an active workflow scheme with updateDraftIfNeeded set to true: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.
Update an active workflow scheme with updateDraftIfNeeded set to false: An error is returned, as active workflow schemes cannot be updated.
Update an inactive workflow scheme with updateDraftIfNeeded set to true: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.

Defaults to false.

Returns a JIRA::API::WorkflowScheme.

`deleteDraftDefaultWorkflow`

my $res = $client->deleteDraftDefaultWorkflow()->get;

Delete draft default workflow

Parameters

id: The ID of the workflow scheme that the draft belongs to.

Returns a JIRA::API::WorkflowScheme.

`getDraftDefaultWorkflow`

my $res = $client->getDraftDefaultWorkflow()->get;

Get draft default workflow

Parameters

id: The ID of the workflow scheme that the draft belongs to.

Returns a JIRA::API::DefaultWorkflow.

`updateDraftDefaultWorkflow`

my $res = $client->updateDraftDefaultWorkflow()->get;

Update draft default workflow

Parameters

id: The ID of the workflow scheme that the draft belongs to.

Options

updateDraftIfNeeded: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to false.
workflow: The name of the workflow to set as the default workflow.

Returns a JIRA::API::WorkflowScheme.

`deleteWorkflowSchemeDraftIssueType`

my $res = $client->deleteWorkflowSchemeDraftIssueType()->get;

Delete workflow for issue type in draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
issueType: The ID of the issue type.

Returns a JIRA::API::WorkflowScheme.

`getWorkflowSchemeDraftIssueType`

my $res = $client->getWorkflowSchemeDraftIssueType()->get;

Get workflow for issue type in draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
issueType: The ID of the issue type.

Returns a JIRA::API::IssueTypeWorkflowMapping.

`setWorkflowSchemeDraftIssueType`

my $res = $client->setWorkflowSchemeDraftIssueType()->get;

Set workflow for issue type in draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
issueType: The ID of the issue type.

Options

issueType: The ID of the issue type. Not required if updating the issue type-workflow mapping.
updateDraftIfNeeded: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping.
workflow: The name of the workflow.

Returns a JIRA::API::WorkflowScheme.

`publishDraftWorkflowScheme`

my $res = $client->publishDraftWorkflowScheme()->get;

Publish draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
validateOnly: Whether the request only performs a validation.

Options

statusMappings: Mappings of statuses to new statuses for issue types.

Returns a JIRA::API::TaskProgressBeanObject.

`deleteDraftWorkflowMapping`

my $res = $client->deleteDraftWorkflowMapping()->get;

Delete issue types for workflow in draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
workflowName: The name of the workflow.

`getDraftWorkflow`

my $res = $client->getDraftWorkflow()->get;

Get issue types for workflows in draft workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
workflowName: The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.

Returns a JIRA::API::IssueTypesWorkflowMapping.

`updateDraftWorkflowMapping`

my $res = $client->updateDraftWorkflowMapping()->get;

Set issue types for workflow in workflow scheme

Parameters

id: The ID of the workflow scheme that the draft belongs to.
workflowName: The name of the workflow.

Options

defaultMapping: Whether the workflow is the default workflow for the workflow scheme.
issueTypes: The list of issue type IDs.
updateDraftIfNeeded: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.
workflow: The name of the workflow. Optional if updating the workflow-issue types mapping.

Returns a JIRA::API::WorkflowScheme.

`deleteWorkflowSchemeIssueType`

my $res = $client->deleteWorkflowSchemeIssueType()->get;

Delete workflow for issue type in workflow scheme

Parameters

id: The ID of the workflow scheme.
issueType: The ID of the issue type.
updateDraftIfNeeded: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false.

Returns a JIRA::API::WorkflowScheme.

`getWorkflowSchemeIssueType`

my $res = $client->getWorkflowSchemeIssueType()->get;

Get workflow for issue type in workflow scheme

Parameters

id: The ID of the workflow scheme.
issueType: The ID of the issue type.
returnDraftIfExists: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.

Returns a JIRA::API::IssueTypeWorkflowMapping.

`setWorkflowSchemeIssueType`

my $res = $client->setWorkflowSchemeIssueType()->get;

Set workflow for issue type in workflow scheme

Parameters

id: The ID of the workflow scheme.
issueType: The ID of the issue type.

Options

issueType: The ID of the issue type. Not required if updating the issue type-workflow mapping.
updateDraftIfNeeded: Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to false. Only applicable when updating the workflow-issue types mapping.
workflow: The name of the workflow.

Returns a JIRA::API::WorkflowScheme.

`deleteWorkflowMapping`

my $res = $client->deleteWorkflowMapping()->get;

Delete issue types for workflow in workflow scheme

Parameters

id: The ID of the workflow scheme.
workflowName: The name of the workflow.
updateDraftIfNeeded: Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to false.

`getWorkflow`

my $res = $client->getWorkflow()->get;

Get issue types for workflows in workflow scheme

Parameters

id: The ID of the workflow scheme.
workflowName: The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow.
returnDraftIfExists: Returns the mapping from the workflow scheme's draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned.

Returns a JIRA::API::IssueTypesWorkflowMapping.

`updateWorkflowMapping`

my $res = $client->updateWorkflowMapping()->get;

Set issue types for workflow in workflow scheme

Parameters

id: The ID of the workflow scheme.
workflowName: The name of the workflow.

Options

defaultMapping: Whether the workflow is the default workflow for the workflow scheme.
issueTypes: The list of issue type IDs.
updateDraftIfNeeded: Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to false.
workflow: The name of the workflow. Optional if updating the workflow-issue types mapping.

Returns a JIRA::API::WorkflowScheme.

`getIdsOfWorklogsDeletedSince`

my $res = $client->getIdsOfWorklogsDeletedSince()->get;

Get IDs of deleted worklogs

Parameters

since: The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned.

Returns a JIRA::API::ChangedWorklogs.

`getWorklogsForIds`

my $res = $client->getWorklogsForIds()->get;

Get worklogs

Parameters

expand: Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

Options

ids: A list of worklog IDs.

Returns an array of JIRA::API::Worklog.

`getIdsOfWorklogsModifiedSince`

my $res = $client->getIdsOfWorklogsModifiedSince()->get;

Get IDs of updated worklogs

Parameters

since: The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned.
expand: Use expand to include additional information about worklogs in the response. This parameter accepts properties that returns the properties of each worklog.

Returns a JIRA::API::ChangedWorklogs.

`AddonPropertiesResource_getAddonProperties_get`

my $res = $client->AddonPropertiesResource_getAddonProperties_get()->get;

Get app properties

Parameters

addonKey: The key of the app, as defined in its descriptor.

Returns a JIRA::API::PropertyKeys. Returns a JIRA::API::OperationMessage.

`AddonPropertiesResource_deleteAddonProperty_delete`

my $res = $client->AddonPropertiesResource_deleteAddonProperty_delete()->get;

Delete app property

Parameters

addonKey: The key of the app, as defined in its descriptor.
propertyKey: The key of the property.

Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage.

`AddonPropertiesResource_getAddonProperty_get`

my $res = $client->AddonPropertiesResource_getAddonProperty_get()->get;

Get app property

Parameters

addonKey: The key of the app, as defined in its descriptor.
propertyKey: The key of the property.

Returns a JIRA::API::EntityProperty. Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage.

`AddonPropertiesResource_putAddonProperty_put`

my $res = $client->AddonPropertiesResource_putAddonProperty_put()->get;

Set app property

Parameters

addonKey: The key of the app, as defined in its descriptor.
propertyKey: The key of the property.

Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage. Returns a JIRA::API::OperationMessage.

`DynamicModulesResource_removeModules_delete`

my $res = $client->DynamicModulesResource_removeModules_delete()->get;

Remove modules

Parameters

moduleKey: The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored.

Returns a JIRA::API::ErrorMessage.

`DynamicModulesResource_getModules_get`

my $res = $client->DynamicModulesResource_getModules_get()->get;

Get modules

Parameters

Returns a JIRA::API::ConnectModules. Returns a JIRA::API::ErrorMessage.

`DynamicModulesResource_registerModules_post`

my $res = $client->DynamicModulesResource_registerModules_post()->get;

Parameters

Options

modules: A list of app modules in the same format as the modules property in the app descriptor.

Returns a JIRA::API::ErrorMessage. Returns a JIRA::API::ErrorMessage.

`AppIssueFieldValueUpdateResource_updateIssueFields_put`

my $res = $client->AppIssueFieldValueUpdateResource_updateIssueFields_put()->get;

Bulk update custom field value

Parameters

Atlassian-Transfer-Id: The ID of the transfer.

Options

updateValueList: The list of custom field update details.

Returns a >>.

`MigrationResource_updateEntityPropertiesValue_put`

my $res = $client->MigrationResource_updateEntityPropertiesValue_put()->get;

Bulk update entity properties

Parameters

Atlassian-Transfer-Id: The app migration transfer ID.
entityType: The type indicating the object that contains the entity properties.

`MigrationResource_workflowRuleSearch_post`

my $res = $client->MigrationResource_workflowRuleSearch_post()->get;

Get workflow transition rule configurations

Parameters

Atlassian-Transfer-Id: The app migration transfer ID.

Options

expand: Use expand to include additional information in the response. This parameter accepts transition which, for each rule, returns information about the transition the rule is assigned to.
ruleIds: The list of workflow rule IDs.
workflowEntityId: The workflow ID.

Returns a JIRA::API::WorkflowRulesSearchDetails.

110 POD Errors

The following errors were encountered while parsing the POD:

Around line 737:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 865:

Unterminated L< ... > sequence

Around line 1109:

Unterminated L< ... > sequence

Around line 1225:

Unterminated L< ... > sequence

Around line 3132:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 4027:

Unterminated L< ... > sequence

Around line 4140:

Unterminated L< ... > sequence

Around line 5472:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 5599:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 6037:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 7925:

Unterminated L< ... > sequence

Around line 8465:

Unterminated L< ... > sequence

Around line 8993:

Unterminated L< ... > sequence

Around line 9137:

Unterminated L< ... > sequence

Around line 9280:

Unterminated L< ... > sequence

Around line 9434:

Unterminated L< ... > sequence

Around line 10024:

Unterminated L< ... > sequence

Around line 10295:

Unterminated L< ... > sequence

Around line 10438:

Unterminated L< ... > sequence

Around line 11303:

Unterminated L< ... > sequence

Around line 11956:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 12091:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 12440:

Unterminated L< ... > sequence

Around line 12553:

Unterminated L< ... > sequence

Around line 12774:

Unterminated L< ... > sequence

Around line 13323:

Unterminated L< ... > sequence

Around line 13443:

Unterminated L< ... > sequence

Around line 13556:

Unterminated L< ... > sequence

Around line 13692:

Unterminated L< ... > sequence

Around line 13804:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 15444:

Unterminated L< ... > sequence

Around line 15776:

Unterminated L< ... > sequence

Around line 18870:

Unterminated L< ... > sequence

Around line 19023:

Non-ASCII character seen before =encoding in 'user’s'. Assuming UTF-8

Around line 19059:

Unterminated L< ... > sequence

Around line 20264:

Unterminated L< ... > sequence

Around line 20647:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 21350:

Unterminated L< ... > sequence

Around line 21610:

Unterminated L< ... > sequence

Around line 21885:

Unterminated L< ... > sequence

Around line 22176:

Unterminated L< ... > sequence

Around line 23403:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 23541:

L<> starts or ends with whitespace

Around line 23546:

L<> starts or ends with whitespace

Around line 23555:

Unterminated L< ... > sequence

Around line 23922:

L<> starts or ends with whitespace

Around line 23927:

L<> starts or ends with whitespace

Around line 23940:

L<> starts or ends with whitespace

Around line 23945:

L<> starts or ends with whitespace

Around line 23958:

L<> starts or ends with whitespace

Around line 23963:

L<> starts or ends with whitespace

Around line 23976:

L<> starts or ends with whitespace

Around line 23981:

L<> starts or ends with whitespace

Around line 24279:

L<> starts or ends with whitespace

Around line 24284:

L<> starts or ends with whitespace

Around line 24297:

L<> starts or ends with whitespace

Around line 24302:

L<> starts or ends with whitespace

Around line 24315:

L<> starts or ends with whitespace

Around line 24320:

L<> starts or ends with whitespace

Around line 24333:

L<> starts or ends with whitespace

Around line 24338:

L<> starts or ends with whitespace

Around line 25944:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 26567:

Unterminated L< ... > sequence

Around line 26687:

Unterminated L< ... > sequence

Around line 26828:

Unterminated L< ... > sequence

Around line 26964:

Unterminated L< ... > sequence

Around line 27108:

Unterminated L< ... > sequence

Around line 27238:

Unterminated L< ... > sequence

Around line 27863:

Unterminated L< ... > sequence

Around line 27983:

Unterminated L< ... > sequence

Around line 28112:

Unterminated L< ... > sequence

Around line 28248:

Unterminated L< ... > sequence

Around line 28387:

Unterminated L< ... > sequence

Around line 28523:

Unterminated L< ... > sequence

Around line 28944:

L<> starts or ends with whitespace

Around line 29146:

Unterminated L< ... > sequence

Around line 30275:

Unterminated L< ... > sequence

Around line 30369:

Unterminated L< ... > sequence

Around line 30539:

Unterminated L< ... > sequence

Around line 31299:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 31447:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 31585:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 31724:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 33612:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 33758:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 34274:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 35909:

Unterminated L< ... > sequence

Around line 36042:

Unterminated L< ... > sequence

Around line 37301:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 38767:

Unterminated L< ... > sequence

Around line 40567:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 40713:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 41221:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 42562:

Unterminated L< ... > sequence

Around line 43805:

Unterminated L< ... > sequence

Around line 43921:

Unterminated L< ... > sequence

Around line 44422:

Unterminated L< ... > sequence

Around line 45312:

Unterminated L< ... > sequence

Around line 45760:

Unterminated L< ... > sequence

Around line 46082:

Unterminated L< ... > sequence

Around line 46401:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< ... > sequence

Around line 46772:

Unterminated L< ... > sequence

Around line 46890:

Unterminated L< ... > sequence

Around line 49166:

Unterminated L< ... > sequence

Around line 50366:

Nested L<> are illegal. Pretending inner one is X<...> so can continue looking for other errors.

Unterminated L< X< ... > > sequence

Around line 51741:

Unterminated L< ... > sequence

Around line 52064:

Unterminated L< ... > sequence

Around line 54694:

Unterminated L< ... > sequence

Around line 54814:

Unterminated L< ... > sequence

Around line 58857:

Unterminated L< ... > sequence

To install OpenAPI::PerlGenerator, copy and paste the appropriate command in to your terminal.

cpanm

cpanm OpenAPI::PerlGenerator

CPAN shell

perl -MCPAN -e shell
install OpenAPI::PerlGenerator

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)