This resource represents system and custom avatars. Use it to obtain the
details of system or custom avatars, add and remove avatars from a project
or issue type, and obtain avatar images.
This resource represents dashboards. Use it to obtain the details of
dashboards as well as get, create, update, or remove item properties and
gadgets from dashboards.
This resource represents
filters. Use it to get,
create, update, or delete filters. Also use it to configure the columns
for a filter and set favorite filters.
This resource represents groups of users. Use it to get, create, find, and
delete groups as well as add and remove users from groups. (WARNING The
standard Atlassian group names are default names only and can be edited or
deleted. For example, an admin or Atlassian support could delete the
default group jira-software-users or rename it to jsw-users at any point.
See
https://support.atlassian.com/user-management/docs/create-and-update-groups/
for details.)
This resource represents issue attachments and the attachment settings for
Jira. Use it to get the metadata for an attachment, delete an attachment,
and view the metadata for the contents of an attachment. Also, use it to
get the attachment settings for Jira.
This resource represents issue comment
properties, which provides for storing custom data against an issue
comment. Use is to get, set, and delete issue comment properties as well
as obtain the keys of all properties on a comment. Comment properties are
a type of
entity property.
This resource represents configurations stored against a custom field
context by a Forge app.
Configurations are information used by the Forge app at runtime to
determine how to handle or process the data in a custom field in a given
context. Use this resource to set and read configurations.
This resource represents custom issue field select list options created in
Jira or using the REST API. This resource supports the following field
types:
This resource represents custom issue field select list options created by
a Connect app. See
Issue custom field options to
manipulate options created in Jira or using the REST API.
This resource represents notification schemes, lists of events and the
recipients who will receive notifications for those events. Use it to get
details of a notification scheme and a list of notification schemes.
This resource represents issue properties, which
provides for storing custom data against an issue. Use it to get, set, and
delete issue properties as well as obtain details of all properties on an
issue. Operations to bulk update and delete issue properties are also
provided. Issue properties are a type of
entity property.
This resource represents remote issue links, a way of linking Jira to
information in other systems. Use it to get, create, update, and delete
remote issue links either by ID or global ID. The global ID provides a way
of accessing remote issue links using information about the item's remote
system host and remote system identifier.
This resource represents issue resolution values. Use it to obtain a list
of all issue resolution values and the details of individual resolution
values.
This resource represents issue security levels. Use it to obtain the
details of any issue security level. For more information about issue
security levels, see
Configuring issue-level security.
This resource represents issue type properties,
which provides for storing custom data against an issue type. Use it to
get, create, and delete issue type properties as well as obtain the keys
of all properties on a issues type. Issue type properties are a type of
entity property.
This resource represents issue worklog
properties, which provides for storing custom data against an issue
worklog. Use it to get, create, and delete issue worklog properties as
well as obtain the keys of all properties on a issue worklog. Issue
worklog properties are a type of
entity property.
This resource represents JQL search auto-complete details. Use it to
obtain JQL search auto-complete data and suggestions for use in
programmatic construction of queries or custom query builders. It also
provides operations to:
This resource represents JQL function's precomputations. Precomputation is
a mapping between custom function call and JQL fragment returned by this
function. Use it to get and update precomputations.
This resource represents information about the current user, such as basic
details, group membership, application roles, preferences, and locale. Use
it to get, create, update, and delete (restore default) values of the
user's preferences and locale.
This resource represents permission schemes. Use it to get, create,
update, and delete permission schemes as well as get, create, update, and
delete details of the permissions granted in those schemes.
This resource represents project categories. Use it to create, update, and
delete project categories as well as obtain a list of all project
categories and details of individual categories. For more information on
managing project categories, see
Adding, assigning, and deleting project categories.
This resource represents project components. Use it to get, create,
update, and delete project components. Also get components for project and
get a count of issues by component.
This resource represents project features. Use it to get the list of
features for a project and modify the state of a feature. The project
feature endpoint is available only for Jira Software, both for team- and
company-managed projects.
This resource represents project properties, which
provides for storing custom data against a project. Use it to get, create,
and delete project properties as well as get a list of property keys for a
project. Project properties are a type of
entity property.
This resource represents the users assigned to
project roles. Use it to get, add, and remove
default users from project roles. Also use it to add and remove users from
a project role associated with a project.
This resource represents projects. Use it to get, create, update, and
delete projects. Also get statuses available to a project, a project's
notification schemes, and update a project's type.
This resource represents project types. Use it to obtain a list of all
project types, a list of project types accessible to the calling user, and
details of a project type.
This resource represents project versions. Use it to get, get lists of,
create, update, move, merge, and delete project versions. This resource
also provides counts of issues by version.
This resource represents a
long-running asynchronous tasks. Use it to obtain
details about the progress of a long-running task or cancel a long-running
task.
This resource represents time tracking and time tracking providers. Use it
to get and set the time tracking provider, get and set the time tracking
options, and disable time tracking.
UI modifications is a feature available for Forge apps only. It
enables Forge apps to control how selected Jira fields behave on global
create issue dialog. For example: hide specific fields, set them as
required, etc.
This resource represents user properties and provides
for storing custom data against a user. Use it to get, create, and delete
user properties as well as get a list of property keys for a user. This
resourse is designed for integrations and apps to store per-user data and
settings. This enables data used to customized the user experience to be
kept in the Jira Cloud instance's database. User properties are a type of
entity property.
This resource represents various ways to search for and find users. Use it
to obtain list of users including users assignable to projects and issues,
users with permissions, user lists for pickup fields, and user lists
generated using structured queries. Note that the operations in this
resource only return users found within the first 1000 users.
This resource represents webhooks. Webhooks are calls sent to a URL when
an event occurs in Jira for issues specified by a JQL query. Only Connect
and OAuth 2.0 apps can register and manage webhooks. For more information,
see
Webhooks.
This resource represents status categories. Use it to obtain a list of all
status categories and the details of a category. Status categories
provided a mechanism for categorizing
statuses.
This resource represents workflow transition properties, which provides
for storing custom data against a workflow transition. Use it to get,
create, and delete workflow transition properties as well as get a list of
property keys for a workflow transition. Workflow transition properties
are a type of
entity property.
This resource represents workflow transition rules. Workflow transition
rules define a Connect or a Forge app routine, such as a
workflow post functions
that is executed in association with the workflow. Use it to read and
modify configuration of workflow transition rules.
