Adapter for Integration to Jira

Description
Technical Documentation

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the Jira System. The API that was used to build the adapter for Jira is usually available in the report directory of this adapter. The adapter utilizes the Jira API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.

For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

Atlassian Jira

Getting Started
Configuration
Using this Adapter
Additional Information
Troubleshoot
- Connectivity Issues
- Functional Issues

Getting Started

These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:

Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter

Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder

Prerequisites

The following is a list of required packages for installation on the system the adapter will run on:

Node.js
npm
Git

The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.

Package	Description
@itentialopensource/adapter-utils	Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.
ajv	Required for validation of adapter properties to integrate with Jira.
axios	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
commander	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
dns-lookup-promise	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
fs-extra	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
mocha	Testing library that is utilized by some of the node scripts that are included with the adapter.
mocha-param	Testing library that is utilized by some of the node scripts that are included with the adapter.
mongodb	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
nyc	Testing coverage library that is utilized by some of the node scripts that are included with the adapter.
ping	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
readline-sync	Utilized by the node script that comes with the adapter; helps to test unit and integration functionality.
semver	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
winston	Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.

If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.

chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble

How to Install

Set up the name space location in your IAP node_modules.

cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource

Clone/unzip/tar the adapter into your IAP environment.

cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-jira
or
unzip adapter-jira.zip
or
tar -xvf adapter-jira.tar

Run the adapter install script.

cd adapter-jira
npm install
npm run lint:errors
npm run test

Restart IAP

systemctl restart pronghorn

Create an adapter service instance configuration in IAP Admin Essentials GUI
Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:

Install adapter dependencies and check the adapter.

cd adapter-jira
npm run adapter:install

Restart IAP

systemctl restart pronghorn

Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

Testing

Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.

Unit Testing

Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.

node utils/testRunner --unit

npm run test:unit
npm run test:baseunit

To add new unit tests, edit the test/unit/adapterTestUnit.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing - Standalone

Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Jira. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.

Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.

node utils/testRunner
  answer no at the first prompt

npm run test:integration

To add new integration tests, edit the test/integration/adapterTestIntegration.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing

Integration Testing requires connectivity to Jira. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.

Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for creates and updates. Hence, integration tests may have to be enhanced before they will work (integrate) with Jira. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Jira which change order dependencies or required data.

node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials

Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.

Reminder: Do not check in code with actual credentials to systems.

Configuration

This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.

Example Properties

  "properties": {
    "host": "your_host.atlassian.net",
    "port": 443,
    "choosepath": "",
    "base_path": "/rest/api",
    "version": "2",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": true,
    "protocol": "https",
    "authentication": {
      "auth_method": "basic user_password",
      "username": "exampleUsername",
      "password": "examplePassword",
      "token": "",
      "token_timeout": 1800000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Authorization",
      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "sensitive": [],
      "sso": {
        "protocol": "",
        "host": "",
        "port": 0
      },
      "multiStepAuthCalls": [
        {
          "name": "",
          "requestFields": {},
          "responseFields": {},
          "successfullResponseCode": 200
        }
      ]
    },
    "healthcheck": {
      "type": "intermittent",
      "frequency": 60000,
      "query_object": {},
      "addlHeaders": {}
    },
    "throttle": {
      "throttle_enabled": false,
      "number_pronghorns": 1,
      "sync_async": "sync",
      "max_in_queue": 1000,
      "concurrent_max": 1,
      "expire_timeout": 0,
      "avg_runtime": 200,
      "priorities": [
        {
          "value": 0,
          "percent": 100
        }
      ]
    },
    "request": {
      "number_redirects": 0,
      "number_retries": 3,
      "limit_retry_error": 401,
      "failover_codes": [],
      "attempt_timeout": 5000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {}
      },
      "healthcheck_on_timeout": true,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": true,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{id}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "getDevicesFiltered": [
        {
          "path": "/get/devices",
          "method": "GET",
          "pagination": {
            "offsetVar": "",
            "limitVar": "",
            "incrementBy": "limit",
            "requestLocation": "query"
          },
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "isAlive": [
        {
          "path": "/get/devices/{id}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{id}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {}
        }
      ],
      "getCount": [
        {
          "path": "/get/devices",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {}
        }
      ]
    },
    "cache": {
      "enabled": false,
      "entities": [
        {
          "entityType": "",
          "frequency": 1440,
          "flushOnFail": false,
          "limit": 1000,
          "retryAttempts": 5,
          "sort": true,
          "populate": [
            {
              "path": "",
              "method": "GET",
              "pagination": {
                "offsetVar": "",
                "limitVar": "",
                "incrementBy": "limit",
                "requestLocation": "query"
              },
              "query": {},
              "body": {},
              "headers": {},
              "handleFailure": "ignore",
              "requestFields": {},
              "responseDatakey": "",
              "responseFields": {}
            }
          ],
          "cachedTasks": [
            {
              "name": "",
              "filterField": "",
              "filterLoc": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

These base properties are used to connect to Jira upon the adapter initially coming up. It is important to set these properties appropriately.

Property	Description
host	Required. A fully qualified domain name or IP address.
port	Required. Used to connect to the server.
base_path	Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example base_path might be `/rest/api`. Default is ``.
version	Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.
cache_location	Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.
encode_pathvars	Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior.
encode_queryvars	Optional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior.
save_metric	Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.
stub	Optional. Indicates whether the stub should run instead of making calls to Jira (very useful during basic testing). Default is false (which means connect to Jira).
protocol	Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.

A connectivity check tells IAP the adapter has loaded successfully.

Authentication Properties

The following properties are used to define the authentication process to Jira.

Note: Depending on the method that is used to authenticate with Jira, you may not need to set all of the authentication properties.

Property	Description
auth_method	Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.
username	Used to authenticate with Jira on every request or when pulling a token that will be used in subsequent requests.
password	Used to authenticate with Jira on every request or when pulling a token that will be used in subsequent requests.
token	Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).
invalid_token_error	Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.
token_timeout	Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Jira. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.
token_cache	Used to determine where the token should be stored (local memory or in Redis).
auth_field	Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.
auth_field_format	Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item.
auth_logging	Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true.
client_id	Provide a client id when needed, this is common on some types of OAuth.
client_secret	Provide a client secret when needed, this is common on some types of OAuth.
grant_type	Provide a grant type when needed, this is common on some types of OAuth.

Examples of authentication field format

"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"

Healthcheck Properties

The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Jira. There are currently three types of healthchecks.

None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Jira.
Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
Intermittent - Adapter will check connectivity to Jira at a frequency defined in the frequency property.

Property	Description
type	Required. The type of health check to run.
frequency	Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_object	Query parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

Property	Description
number_redirects	Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.
number_retries	Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.
limit_retry_error	Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].
failover_codes	An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.
attempt_timeout	Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if healthcheck\_on\_timeout is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Jira, and then will re-attempt the request that aborted. Default is 5000 milliseconds.
global_request	Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.
global_request -> payload	Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body.
global_request -> uriOptions	Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.
global_request -> addlHeaders	Optioonal. Defines any headers that should be sent on all requests to the other system.
global_request -> authData	Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.
healthcheck_on_timeout	Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.
return_raw	Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.
archiving	Optional flag. Default is false. It archives the request, the results and the various times (wait time, Jira time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.
return_request	Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.

SSL Properties

The SSL section defines the properties utilized for ssl authentication with Jira. SSL can work two different ways: set the accept\_invalid\_certs flag to true (only recommended for lab environments), or provide a ca\_file.

Property	Description
enabled	If SSL is required, set to true.
accept_invalid_certs	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
ca_file	Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
key_file	Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
cert_file	Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.
secure_protocol	Defines the protocol (e.g., SSLv3_method) to use on the SSL request.
ciphers	Required if SSL enabled. Specifies a list of SSL ciphers to use.
ecdhCurve	During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9.

Throttle Properties

The throttle section is used when requests to Jira must be queued (throttled). All of the properties in this section are optional.

Property	Description
throttle_enabled	Default is false. Defines if the adapter should use throttling or not.
number_pronghorns	Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.
sync-async	This property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queue	Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.
concurrent_max	Defines the number of requests the adapter can send to Jira at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Jira in a serial manner.
expire_timeout	Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).
average_runtime	Represents the approximate average of how long it takes Jira to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Jira performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
priorities	An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }

Proxy Properties

The proxy section defines the properties to utilize when Jira is behind a proxy server.

Property	Description
enabled	Required. Default is false. If Jira is behind a proxy server, set enabled flag to true.
host	Host information for the proxy server. Required if `enabled` is true.
port	Port information for the proxy server. Required if `enabled` is true.
protocol	The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.
username	If there is authentication for the proxy, provide the username here.
password	If there is authentication for the proxy, provide the password here.

Mongo Properties

The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.

Property	Description
host	Optional. Host information for the mongo server.
port	Optional. Port information for the mongo server.
database	Optional. The database for the adapter to use for its data.
username	Optional. If credentials are required to access mongo, this is the user to login as.
password	Optional. If credentials are required to access mongo, this is the password to login with.
replSet	Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.
db_ssl	Optional. Contains information for SSL connectivity to the database.
db_ssl -> enabled	If SSL is required, set to true.
db_ssl -> accept_invalid_cert	Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
db_ssl -> ca_file	Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
db_ssl -> key_file	Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
db_ssl -> cert_file	Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.

Device Broker Properties

The device broker section defines the properties used integrate Jira to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.

Property	Description
getDevice	The array of calls used to get device details for the broker
getDevicesFiltered	The array of calls used to get devices for the broker
isAlive	The array of calls used to get device status for the broker
getConfig	The array of calls used to get device configuration for the broker
getCount	The array of calls used to get device configuration for the broker
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path	The path, not including the base_path and version, for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method	The rest method for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query	Query object containing and query parameters and their values for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body	Body object containing the payload for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers	Header object containing the headers for this call.
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure	Tells the adapter whether to "fail" or "ignore" failures if they occur.
isAlive -> statusValue	Tells the adapter what value to look for in the status field to determine if the device is alive.
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields	Object containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value.
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFields	Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.

Using this Adapter

The adapter.js file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.

Generic Adapter Calls

These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.

Method Signature	Description	Workflow?
connect()	This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.	No
healthCheck(callback)	This call ensures that the adapter can communicate with Adapter for Atlassian Jira. The actual call that is used is defined in the adapter properties and .system entities action.json file.	No
refreshProperties(properties)	This call provides the adapter the ability to accept property changes without having to restart the adapter.	No
encryptProperty(property, technique, callback)	This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Atlassian Jira.	No
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)	This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.	Yes
iapSuspendAdapter(mode, callback)	This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.	Yes
iapUnsuspendAdapter(callback)	This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.	Yes
iapGetAdapterQueue(callback)	This call will return the requests that are waiting in the queue if throttling is enabled.	Yes
iapFindAdapterPath(apiPath, callback)	This call provides the ability to see if a particular API path is supported by the adapter.	Yes
iapTroubleshootAdapter(props, persistFlag, adapter, callback)	This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.	Yes
iapRunAdapterHealthcheck(adapter, callback)	This call will return the results of a healthcheck.	Yes
iapRunAdapterConnectivity(callback)	This call will return the results of a connectivity check.	Yes
iapRunAdapterBasicGet(callback)	This call will return the results of running basic get API calls.	Yes
iapMoveAdapterEntitiesToDB(callback)	This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.	Yes
iapDeactivateTasks(tasks, callback)	This call provides the ability to remove tasks from the adapter.	Yes
iapActivateTasks(tasks, callback)	This call provides the ability to add deactivated tasks back into the adapter.	Yes
iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback)	This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request.	Yes
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)	This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.	Yes
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)	This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.	Yes
iapRunAdapterLint(callback)	Runs lint on the addapter and provides the information back.	Yes
iapRunAdapterTests(callback)	Runs baseunit and unit tests on the adapter and provides the information back.	Yes
iapGetAdapterInventory(callback)	This call provides some inventory related information about the adapter.	Yes

Adapter Cache Calls

These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.

Method Signature	Description	Workflow?
iapPopulateEntityCache(entityTypes, callback)	This call populates the adapter cache.	Yes
iapRetrieveEntitiesCache(entityType, options, callback)	This call retrieves the specific items from the adapter cache.	Yes

Adapter Broker Calls

These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.

Method Signature	Description	Workflow?
hasEntities(entityType, entityList, callback)	This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.	No
getDevice(deviceName, callback)	This call returns the details of the requested device.	No
getDevicesFiltered(options, callback)	This call returns the list of devices that match the criteria provided in the options filter.	No
isAlive(deviceName, callback)	This call returns whether the device status is active	No
getConfig(deviceName, format, callback)	This call returns the configuration for the selected device.	No
iapGetDeviceCount(callback)	This call returns the count of devices.	No

Specific Adapter Calls

Specific adapter calls are built based on the API of the Atlassian Jira. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.

Method Signature Description Path Workflow?

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Searches for dashboards. This operation is similar to [Get dashboards](#api-api-2-dashboard-get) except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

Permissions required: Permission to access Jira. However, to get the property keys the user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.

When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item's content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.

There is no resource to set or get dashboard items.

Permissions required: Permission to access Jira. However, to get a dashboard item property the user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: Permission to access Jira. However, to set a dashboard item property the user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

Permissions required: Permission to access Jira. However, to delete a dashboard item property the user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

Permissions required: Permission to access Jira. However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Searches for filters. This operation is similar to [Get filters](#api-api-2-filter-get) except that the results can be refined to include filters that have specific attributes. For example, filters with a particular name. When multiple attributes are specified only filters matching all attributes are returned.

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the notificationSchemeEvents object and contains pairs of events and notifications:

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

If an invalid combination of criteria is provided, an error is returned. For example, specifying a currentValue and hasProperty as false would not match any issues (because without the property the property cannot have a value).

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

Permissions required: Permission to access Jira. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

If you specify a value for the key parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See Set application property for descriptions of editable properties.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Returns the application properties that are accessible on the *Advanced Settings* page. To navigate to the *Advanced Settings* page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** and then click **Advanced Settings** (in the upper right).

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Changes the value of an application property. For example, you can change the value of the `jira.clone.prefix` from its default value of *CLONE -* to *Clone -* if you prefer sentence case capitalization. Editable properties are described below along with their default values.

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration.

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

Creates a preference for the user or updates a preference's value by sending a plain text string. For example, `false`. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

This means that users may be shown as having an issue permission (such as EDIT_ISSUE) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT_ISSUE permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT_ISSUE permission for that issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group", and the parameter is the group name, "parameter": "Teams in space administrators". The holder object is defined by the following properties:

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. See the [Get notification scheme](#api-api-2-notificationscheme-id-get) resource for more information about notification schemes.

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
`jira.issuenav.criteria.autoupdate`	Supports instant updates to search criteria.	`true`

Note: Be careful when changing application properties and advanced settings.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/{pathv1}?{query}

Yes

getRestapi2configuration(callback)

Permissions required: Permission to access Jira .

{base_path}/{version}/configuration?{query}

Yes

getRestapi2jqlautocompletedata(callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata?{query}

Yes

getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

fieldName to get a list of all values for the field.
fieldName and fieldValue to get a list of values containing the text in fieldValue.
fieldName and predicateName to get a list of all predicate values for the field.
fieldName, predicateName, and predicateValue to get a list of predicate values containing the text in predicateValue.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/autocompletedata/suggestions?{query}

Yes

postRestapi2jqlpdcleaner(body, callback)

Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.

You may wish to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.

Permissions required: Permission to access Jira.

{base_path}/{version}/jql/pdcleaner?{query}

Yes

getRestapi2mypreferences(key, callback)

Returns the value of a preference of the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

putRestapi2mypreferences(key, body, callback)

user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
user.notify.own.changes Indicates whether the user gets notified of their own changes. Defaults to false.
jira.user.locale The locale of the user. By default, not set: the user takes the instance locale. See also, Set locale.
jira.user.timezone The time zone of the user. By default, not set, the user takes the instance time zone.
user.default.share.private Indicates whether new filters are set to private. Defaults to true.
user.keyboard.shortcuts.disabled Indicates whether keyboard shortcuts are disabled. Defaults to false.
user.autowatch.disabled Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

deleteRestapi2mypreferences(key, callback)

Deletes a preference of the user, which restores the default value of system defined settings.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences?{query}

Yes

getRestapi2mypreferenceslocale(callback)

Returns the locale for the user.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

putRestapi2mypreferenceslocale(body, callback)

Sets the locale of the user. The locale must be one supported by the instance of Jira.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

deleteRestapi2mypreferenceslocale(callback)

Deletes the locale of the user, which restores the default setting.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypreferences/locale?{query}

Yes

getRestapi2myself(expand, callback)

Returns details for the current user.

Permissions required: Permission to access Jira.

{base_path}/{version}/myself?{query}

Yes

getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)

Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be obtained in a global, project, or issue context.

The user is reported as having a project permission:

in the global context, if the user has the project permission in any project.
for a project, where the project permission is determined using issue data, if the user meets the permission's criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue.

Global permissions are unaffected by context.

Permissions required: Permission to access Jira.

{base_path}/{version}/mypermissions?{query}

Yes

getRestapi2permissions(callback)

Returns all permissions, including:

global permissions.
project permissions.
global permissions added by plugins.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissions?{query}

Yes

postRestapi2permissionscheck(body, callback)

Returns:

for a list of global permissions, the global permissions granted to the user.
for a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues the user can access or manipulate.

Note that:

Invalid project and issue IDs are ignored.
A maximum of 1000 projects and 1000 issues can be checked.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/check?{query}

Yes

postRestapi2permissionsproject(body, callback)

Returns all the projects where the user is granted a list of project permissions.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissions/project?{query}

Yes

getRestapi2permissionscheme(expand, callback)

Returns all permission schemes.

About permission schemes and grants

A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.

Holder

type Identifies the user or group (see the list of types below).
parameter The value of this property depends on the type. For example, if the type is a group, then you need to specify the group name.

The following types are available. The expected values for the parameter are given in parenthesis (some types may not have a parameter):

anyone Grant for anonymous users.
applicationRole Grant for users with access to the specified application (application name). See Manage application access for more information.
assignee Grant for the user currently assigned to an issue.
group Grant for the specified group (group name).
groupCustomField Grant for a user in the group selected in the specified custom field (custom field ID).
projectLead Grant for a project lead.
projectRole Grant for the specified project role (project role ID).
reporter Grant for the user who reported the issue.
sd.customer.portal.only Jira Service Desk only. Grants customers permission to access the customer portal but not Jira. See Customizing Jira Service Desk permissions for more information.
user Grant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used).
userCustomField Grant for a user selected in the specified custom field (custom field ID).

Permissions

The built-in Jira permissions are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.

Project permissions

ADMINISTER_PROJECTS
BROWSE_PROJECTS
MANAGE_SPRINTS_PERMISSION (Jira Software only)
SERVICEDESK_AGENT (Jira Service Desk only)
VIEW_DEV_TOOLS (Jira Software only)
VIEW_READONLY_WORKFLOW

Issue permissions

ASSIGNABLE_USER
ASSIGN_ISSUES
CLOSE_ISSUES
CREATE_ISSUES
DELETE_ISSUES
EDIT_ISSUES
LINK_ISSUES
MODIFY_REPORTER
MOVE_ISSUES
RESOLVE_ISSUES
SCHEDULE_ISSUES
SET_ISSUE_SECURITY
TRANSITION_ISSUES

Voters and watchers permissions

MANAGE_WATCHERS
VIEW_VOTERS_AND_WATCHERS

Comments permissions

ADD_COMMENTS
DELETE_ALL_COMMENTS
DELETE_OWN_COMMENTS
EDIT_ALL_COMMENTS
EDIT_OWN_COMMENTS

Attachments permissions

CREATE_ATTACHMENTS
DELETE_ALL_ATTACHMENTS
DELETE_OWN_ATTACHMENTS

Time tracking permissions

DELETE_ALL_WORKLOGS
DELETE_OWN_WORKLOGS
EDIT_ALL_WORKLOGS
EDIT_OWN_WORKLOGS
WORK_ON_ISSUES

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme?{query}

Yes

postRestapi2permissionscheme(expand, body, callback)

Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme?{query}

Yes

getRestapi2permissionschemeschemeId(schemeId, expand, callback)

Returns a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)

Updates a permission scheme. Below are some important things to note when using this resource:

If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
If you want to update only the name and description, then do not send a permissions list in the request.
Sending an empty list will remove all permission grants from the permission scheme.

If you want to add or delete a permission grant instead of updating the whole list, see Create permission grant or Delete permission scheme entity.

See About permission schemes and grants for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

deleteRestapi2permissionschemeschemeId(schemeId, callback)

Deletes a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}?{query}

Yes

getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)

Returns all permission grants for a permission scheme.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)

Creates a permission grant in a permission scheme.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}

Yes

getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)

Returns a permission grant.

Permissions required: Permission to access Jira.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)

Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.

Permissions required: Administer Jira global permission.

{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)

Permissions required: Administer Jira global permission or Administer Projects project permission.

{base_path}/{version}/project/{pathv1}/notificationscheme?{query}

Yes

getRestapi2project(expand, recent, callback)

Returns all projects visible to the user. Deprecated, use [ Get projects paginated](#api-api-2-project-search-get) that supports search and pagination.

Permissions required: None, however, projects are returned only where:

the user has Browse Projects or Administer projects project permission for the project.
the project is public.

{base_path}/{version}/project?{query}

Yes

postRestapi2project(body, callback)

Creates a project based on a project type template, as shown in the following table:

Project Type Key Project Template Key

getRestapi2applicationrole(callback)

Returns all application roles. In Jira, application roles are managed using the [Application access configuration](https://confluence.atlassian.com/x/3YxjL) page.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole?{query}

Yes

getRestapi2applicationrolekey(key, callback)

Returns an application role.

Permissions required: Administer Jira global permission.

{base_path}/{version}/applicationrole/{pathv1}?{query}

Yes

getRestapi2auditingrecord(offset, limit, filter, from, to, callback)

Returns a list of audit records. The list can be filtered to include items:

containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
created on or after a date and time.
created or or before a date and time.
created during a time period.

Permissions required: Administer Jira global permission.

{base_path}/{version}/auditing/record?{query}

Yes

getRestapi2dashboard(filter, startAt, maxResults, callback)

Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards.

Permissions required: Permission to access Jira.

{base_path}/{version}/dashboard?{query}

Yes

getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: None, however, only the following dashboards that match the query parameters are returned:

Dashboards owned by the user. Not returned for anonymous users.
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
Dashboards shared with a public project.
Dashboards shared with the public.

{base_path}/{version}/dashboard/search?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)

Returns the keys of all properties for a dashboard item.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}

Yes

getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Returns the key and value of a dashboard item property.

There is no resource to set or get dashboard items.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)

Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item.

There is no resource to set or get dashboard items.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)

Deletes a dashboard item property.

{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}

Yes

getRestapi2dashboardid(id, callback)

Returns a dashboard.

{base_path}/{version}/dashboard/{pathv1}?{query}

Yes

getRestapi2filter(expand, callback)

Returns all filters. Deprecated, use [ Search for filters](#api-api-2-filter-search-get) that supports search and pagination.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter?{query}

Yes

postRestapi2filter(expand, body, callback)

Creates a filter. The filter is shared according to the [default share scope](#api-api-2-filter-post). The filter is not selected as a favorite.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter?{query}

Yes

getRestapi2filterfavourite(expand, callback)

Returns the visible favorite filters of the user.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/favourite?{query}

Yes

getRestapi2filtermy(expand, includeFavourites, callback)

Returns the filters owned by the user. If `includeFavourites` is `true`, the user's visible favorite filters are also returned.

Permissions required: Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:

owned by the user.
shared with a group that the user is a member of.
shared with a private project that the user has Browse projects project permission for.
shared with a public project.
shared with the public.

For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.

{base_path}/{version}/filter/my?{query}

Yes

getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)

Permissions required: Permission to access Jira, however, only the following filters that match the query parameters are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/search?{query}

Yes

getRestapi2filterid(id, expand, callback)

Returns a filter.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

putRestapi2filterid(id, expand, body, callback)

Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing.

Permissions required: Permission to access Jira, however the user must own the filter.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

deleteRestapi2filterid(id, callback)

Delete a filter.

Permissions required: Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.

{base_path}/{version}/filter/{pathv1}?{query}

Yes

getRestapi2filteridcolumns(id, callback)

Returns the columns configured for a filter. The column configuration is used when the filter's results are viewed in *List View* with the *Columns* set to *Filter*.

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridcolumns(id, body, callback)

Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-api-2-field-get) to get the list fields in Jira. A navigable field has `navigable` set to `true`.

The parameters for this resource are expressed as HTML form data. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/filter/10000/columns

Permissions required: Permission to access Jira, however, columns are only set for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

deleteRestapi2filteridcolumns(id, callback)

Reset the user's column configuration for the filter to the default.

Permissions required: Permission to access Jira, however, columns are only reset for:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/columns?{query}

Yes

putRestapi2filteridfavourite(id, expand, callback)

Add a filter as a favorite for the user.

Permissions required: Permission to access Jira, however, the user can only favorite:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

deleteRestapi2filteridfavourite(id, expand, callback)

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/{pathv1}/favourite?{query}

Yes

getRestapi2filterdefaultShareScope(callback)

Returns the default sharing settings for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

putRestapi2filterdefaultShareScope(body, callback)

Sets the default sharing for new filters and dashboards for a user.

Permissions required: Permission to access Jira.

{base_path}/{version}/filter/defaultShareScope?{query}

Yes

getRestapi2filteridpermission(id, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

postRestapi2filteridpermission(id, body, callback)

Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter.

Be aware that this operation uses different objects for updating share permissions compared to Update filter.

Permissions required: Share dashboards and filters global permission and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission?{query}

Yes

getRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Permissions required: Permission to access Jira, however, only the following are returned:

filters owned by the user.
filters shared with a group that the user is a member of.
filters shared with a private project that the user has Browse projects project permission for.
filters shared with a public project.
filters shared with the public.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)

Deletes a share permission from a filter.

Permissions required: Permission to access Jira and the user must own the filter.

{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}

Yes

getRestapi2settingscolumns(callback)

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

putRestapi2settingscolumns(body, callback)

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.

Permissions required: Administer Jira global permission.

{base_path}/{version}/settings/columns?{query}

Yes

getRestapi2notificationscheme(startAt, maxResults, expand, callback)

Returns a [paginated](#pagination) list of [notification schemes](https://confluence.atlassian.com/x/8YdKLg) in order by display name.

About notification schemes

event Identifies the type of event. The events can be Jira system events or custom events.
notifications Identifies the recipients of notifications for each event. Recipients can be any of the following types:
- CurrentAssignee
- Reporter
- CurrentUser
- ProjectLead
- ComponentLead
- User (the parameter is the user key)
- Group (the parameter is the group name)
- ProjectRole (the parameter is the project role ID)
- EmailAddress
- AllWatchers
- UserCustomField (the parameter is the ID of the custom field)
- GroupCustomField(the parameter is the ID of the custom field)

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned.

{base_path}/{version}/notificationscheme?{query}

Yes

getRestapi2notificationschemeid(id, expand, callback)

Returns a [notification scheme](https://confluence.atlassian.com/x/8YdKLg), including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.

{base_path}/{version}/notificationscheme/{pathv1}?{query}

Yes

putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Sets a property value on multiple issues. The issues to be updated can be specified by a filter.

The filter identifies issues eligible for update using these criteria:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.
hasProperty:
- If true, only issues with the property are eligible.
- If false, only issues without the property are eligible.

If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible.

The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either all eligible issues are updated or, when errors occur, none are updated.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)

Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria.

The criteria the filter used to identify eligible issues are:

entityIds Only issues from this list are eligible.
currentValue Only issues with the property set to this value are eligible.

If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible.

If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT_ISSUES permission for the issue are considered eligible.

This operation is:

transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.

Permissions required:

Browse projects project permission for each project containing issues.
If configured, permission to view granted by issue-level security for each issue.
Edit issues project permission for each issue.

{base_path}/{version}/issue/properties/{pathv1}?{query}

Yes

getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)

Returns the URLs and keys of an issue's properties.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties?{query}

Yes

getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Returns the key and value of an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)

Sets the value of an issue's property. Use this resource to store custom data against an issue.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)

Deletes an issue's property.

Permissions required:

Browse projects project permission for the project that the issue is in.
If configured, permission to view the issue granted by issue-level security.
Edit issues project permission for the issue.

{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}

Yes

getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

If the JQL query expression is too large to be encoded as a query parameter, use the POST version of this resource.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

postRestapi2search(body, callback)

Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).

There is a GET version of this resource that can be used for smaller JQL query expressions.

Permissions required: Permission to access Jira.

{base_path}/{version}/search?{query}

Yes

getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)

Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string.

This operation returns two lists:

History Search which includes issues from the user's history of created, edited, or viewed issues that contain the string in the query parameter.
Current Search which includes issues that match the JQL expression in currentJQL and contain the string in the query parameter.

Permissions required: Permission to access Jira.

{base_path}/{version}/issue/picker?{query}

Yes

postRestapi2expressioneval(expand, body, callback)

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

user (User): The current user. Always available and equal to null if the request is anonymous.
app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).
issue (Issue): The current issue. Available only when the issue is provided in the request context object.
project (Project): The current project. Available only when the project is provided in the request context object.
sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.
board (Board): The current board. Available only when the board is provided in the request context object.

{base_path}/{version}/expression/eval?{query}

Yes

getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)

Returns all application properties or an application property.

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties?{query}

Yes

getRestapi2applicationPropertiesadvancedSettings(callback)

Permissions required: Administer Jira global permission.

{base_path}/{version}/application-properties/advanced-settings?{query}

Yes

putRestapi2applicationPropertiesid(id, body, callback)

Advanced settings

The advanced settings below are also accessible in Jira.

Key	Description	Default value
`jira.clone.prefix`	A string of text that automatically precedes the title of a cloned issue.	`CLONE -`
`jira.date.picker.java.format`	The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting.	`d/MMM/yy`
`jira.date.picker.javascript.format`	This date format is for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting.	`%e/%b/%y`
`jira.date.time.picker.java.format`	The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting.	`dd/MMM/yy h:mm a`
`jira.date.time.picker.javascript.format`	This date format is for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting.	`%e/%b/%y %I:%M %p`
`jira.issue.actions.order`	The default order of actions (such as Comments or Change history) displayed on the issue view.	`asc`
`jira.table.cols.subtasks`	The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue.	`issuetype, status, assignee, progress`
`jira.view.issue.links.sort.order`	The sort order of the list of issue links on the issue view.	`type, status, priority`
`jira.comment.collapsing.minimum.hidden`	The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing.	`4`
`jira.newsletter.tip.delay.days`	The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this functionality.	`7`

Look and feel

The settings listed below adjust the look and feel.

Key	Description	Default value
`jira.lf.date.time`	Look and feel of the time format.	`h:mm a`
`jira.lf.date.day`	Look and feel of the day format.	`EEEE h:mm a`
`jira.lf.date.complete`	Look and feel of the date and time format.	`dd/MMM/yy h:mm a`
`jira.lf.date.dmy`	Look and feel of the date format.	`dd/MMM/yy`
`jira.date.time.picker.use.iso8061`	When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard.	`false`
`jira.lf.logo.url`	The URL of the logo image file.	`/images/icon-jira-logo.png`
`jira.lf.logo.show.application.title`	Controls the visibility of the application title on the sidebar.	`false`
`jira.lf.favicon.url`	The URL of the favicon.	`/favicon.ico`
`jira.lf.favicon.hires.url`	The URL of the high resolution favicon.	`/images/64jira.png`
`jira.lf.top.adg3.bgcolour`	The background color of the sidebar.	`#0747A6`
`jira.lf.top.adg3.textcolour`	The color of the text and logo of the sidebar.	`#DEEBFF`
`jira.lf.hero.button.base.bg.colour`		`#3b7fc4`
`jira.title`	The text for the application title. The application title can also be set in General settings.	`Jira`
`jira.option.globalsharing`	boolean	`true`
`xflow.product.suggestions.enabled`	Indicates whether to expose product suggestions for other Atlassian products within Jira.	`true`

Other settings

Key	Description	Default value
getRestapi2applicationrole(callback)	Get all application roles	{base_path}/{version}/applicationrole?{query}	Yes
getRestapi2applicationrolekey(key, callback)	Get application role	{base_path}/{version}/applicationrole/{pathv1}?{query}	Yes
getRestapi2auditingrecord(offset, limit, filter, from, to, callback)	Get audit records	{base_path}/{version}/auditing/record?{query}	Yes
getRestapi2dashboard(filter, startAt, maxResults, callback)	Get all dashboards	{base_path}/{version}/dashboard?{query}	Yes
getRestapi2dashboardsearch(dashboardName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)	Search for dashboards	{base_path}/{version}/dashboard/search?{query}	Yes
getRestapi2dashboarddashboardIditemsitemIdproperties(dashboardId, itemId, callback)	Get dashboard item property keys	{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties?{query}	Yes
getRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)	Get dashboard item property	{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}	Yes
putRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, body, callback)	Set dashboard item property	{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}	Yes
deleteRestapi2dashboarddashboardIditemsitemIdpropertiespropertyKey(dashboardId, itemId, propertyKey, callback)	Delete dashboard item property	{base_path}/{version}/dashboard/{pathv1}/items/{pathv2}/properties/{pathv3}?{query}	Yes
getRestapi2dashboardid(id, callback)	Get dashboard	{base_path}/{version}/dashboard/{pathv1}?{query}	Yes
getRestapi2filter(expand, callback)	Get filters	{base_path}/{version}/filter?{query}	Yes
postRestapi2filter(expand, body, callback)	Create filter	{base_path}/{version}/filter?{query}	Yes
getRestapi2filterfavourite(expand, callback)	Get favorite filters	{base_path}/{version}/filter/favourite?{query}	Yes
getRestapi2filtermy(expand, includeFavourites, callback)	Get my filters	{base_path}/{version}/filter/my?{query}	Yes
getRestapi2filtersearch(filterName, accountId, owner, groupname, projectId, orderBy, startAt, maxResults, expand, callback)	Search for filters	{base_path}/{version}/filter/search?{query}	Yes
getRestapi2filterid(id, expand, callback)	Get filter	{base_path}/{version}/filter/{pathv1}?{query}	Yes
putRestapi2filterid(id, expand, body, callback)	Update filter	{base_path}/{version}/filter/{pathv1}?{query}	Yes
deleteRestapi2filterid(id, callback)	Delete filter	{base_path}/{version}/filter/{pathv1}?{query}	Yes
getRestapi2filteridcolumns(id, callback)	Get columns	{base_path}/{version}/filter/{pathv1}/columns?{query}	Yes
putRestapi2filteridcolumns(id, body, callback)	Set columns	{base_path}/{version}/filter/{pathv1}/columns?{query}	Yes
deleteRestapi2filteridcolumns(id, callback)	Reset columns	{base_path}/{version}/filter/{pathv1}/columns?{query}	Yes
putRestapi2filteridfavourite(id, expand, callback)	Add filter as favorite	{base_path}/{version}/filter/{pathv1}/favourite?{query}	Yes
deleteRestapi2filteridfavourite(id, expand, callback)	Remove filter as favorite	{base_path}/{version}/filter/{pathv1}/favourite?{query}	Yes
getRestapi2filterdefaultShareScope(callback)	Get default share scope	{base_path}/{version}/filter/defaultShareScope?{query}	Yes
putRestapi2filterdefaultShareScope(body, callback)	Set default share scope	{base_path}/{version}/filter/defaultShareScope?{query}	Yes
getRestapi2filteridpermission(id, callback)	Get share permissions	{base_path}/{version}/filter/{pathv1}/permission?{query}	Yes
postRestapi2filteridpermission(id, body, callback)	Add share permission	{base_path}/{version}/filter/{pathv1}/permission?{query}	Yes
getRestapi2filteridpermissionpermissionId(id, permissionId, callback)	Get share permission	{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}	Yes
deleteRestapi2filteridpermissionpermissionId(id, permissionId, callback)	Delete share permission	{base_path}/{version}/filter/{pathv1}/permission/{pathv2}?{query}	Yes
getRestapi2settingscolumns(callback)	Get issue navigator default columns	{base_path}/{version}/settings/columns?{query}	Yes
putRestapi2settingscolumns(body, callback)	Set issue navigator default columns	{base_path}/{version}/settings/columns?{query}	Yes
getRestapi2notificationscheme(startAt, maxResults, expand, callback)	Get notification schemes paginated	{base_path}/{version}/notificationscheme?{query}	Yes
getRestapi2notificationschemeid(id, expand, callback)	Get notification scheme	{base_path}/{version}/notificationscheme/{pathv1}?{query}	Yes
putRestapi2issuepropertiespropertyKey(propertyKey, body, callback)	Bulk set issue property	{base_path}/{version}/issue/properties/{pathv1}?{query}	Yes
deleteRestapi2issuepropertiespropertyKey(propertyKey, body, callback)	Bulk delete issue property	{base_path}/{version}/issue/properties/{pathv1}?{query}	Yes
getRestapi2issueissueIdOrKeyproperties(issueIdOrKey, callback)	Get issue property keys	{base_path}/{version}/issue/{pathv1}/properties?{query}	Yes
getRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)	Get issue property	{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}	Yes
putRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, body, callback)	Set issue property	{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}	Yes
deleteRestapi2issueissueIdOrKeypropertiespropertyKey(issueIdOrKey, propertyKey, callback)	Delete issue property	{base_path}/{version}/issue/{pathv1}/properties/{pathv2}?{query}	Yes
getRestapi2search(jql, startAt, maxResults, validateQuery, fields, expand, properties, fieldsByKeys, callback)	Search for issues using JQL (GET)	{base_path}/{version}/search?{query}	Yes
postRestapi2search(body, callback)	Search for issues using JQL (POST)	{base_path}/{version}/search?{query}	Yes
getRestapi2issuepicker(query, currentJQL, currentIssueKey, currentProjectId, showSubTasks, showSubTaskParent, callback)	Get issue picker suggestions	{base_path}/{version}/issue/picker?{query}	Yes
postRestapi2expressioneval(expand, body, callback)	Evaluate Jira expression	{base_path}/{version}/expression/eval?{query}	Yes
getRestapi2applicationProperties(key, permissionLevel, keyFilter, callback)	Get application property	{base_path}/{version}/application-properties?{query}	Yes
getRestapi2applicationPropertiesadvancedSettings(callback)	Get advanced settings	{base_path}/{version}/application-properties/advanced-settings?{query}	Yes
putRestapi2applicationPropertiesid(id, body, callback)	Set application property	{base_path}/{version}/application-properties/{pathv1}?{query}	Yes
getRestapi2configuration(callback)	Get global settings	{base_path}/{version}/configuration?{query}	Yes
getRestapi2jqlautocompletedata(callback)	Get field reference data	{base_path}/{version}/jql/autocompletedata?{query}	Yes
getRestapi2jqlautocompletedatasuggestions(fieldName, fieldValue, predicateName, predicateValue, callback)	Get field auto complete suggestions	{base_path}/{version}/jql/autocompletedata/suggestions?{query}	Yes
postRestapi2jqlpdcleaner(body, callback)	Convert user identifiers to account IDs in JQL queries	{base_path}/{version}/jql/pdcleaner?{query}	Yes
getRestapi2mypreferences(key, callback)	Get preference	{base_path}/{version}/mypreferences?{query}	Yes
putRestapi2mypreferences(key, body, callback)	Set preference	{base_path}/{version}/mypreferences?{query}	Yes
deleteRestapi2mypreferences(key, callback)	Delete preference	{base_path}/{version}/mypreferences?{query}	Yes
getRestapi2mypreferenceslocale(callback)	Get locale	{base_path}/{version}/mypreferences/locale?{query}	Yes
putRestapi2mypreferenceslocale(body, callback)	Set locale	{base_path}/{version}/mypreferences/locale?{query}	Yes
deleteRestapi2mypreferenceslocale(callback)	Delete locale	{base_path}/{version}/mypreferences/locale?{query}	Yes
getRestapi2myself(expand, callback)	Get current user	{base_path}/{version}/myself?{query}	Yes
getRestapi2mypermissions(projectKey, projectId, issueKey, issueId, permissions, callback)	Get my permissions	{base_path}/{version}/mypermissions?{query}	Yes
getRestapi2permissions(callback)	Get all permissions	{base_path}/{version}/permissions?{query}	Yes
postRestapi2permissionscheck(body, callback)	Get bulk permissions	{base_path}/{version}/permissions/check?{query}	Yes
postRestapi2permissionsproject(body, callback)	Get permitted projects	{base_path}/{version}/permissions/project?{query}	Yes
getRestapi2permissionscheme(expand, callback)	Get all permission schemes	{base_path}/{version}/permissionscheme?{query}	Yes
postRestapi2permissionscheme(expand, body, callback)	Create permission scheme	{base_path}/{version}/permissionscheme?{query}	Yes
getRestapi2permissionschemeschemeId(schemeId, expand, callback)	Get permission scheme	{base_path}/{version}/permissionscheme/{pathv1}?{query}	Yes
putRestapi2permissionschemeschemeId(schemeId, expand, body, callback)	Update permission scheme	{base_path}/{version}/permissionscheme/{pathv1}?{query}	Yes
deleteRestapi2permissionschemeschemeId(schemeId, callback)	Delete permission scheme	{base_path}/{version}/permissionscheme/{pathv1}?{query}	Yes
getRestapi2permissionschemeschemeIdpermission(schemeId, expand, callback)	Get permission scheme grants	{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}	Yes
postRestapi2permissionschemeschemeIdpermission(schemeId, expand, body, callback)	Create permission grant	{base_path}/{version}/permissionscheme/{pathv1}/permission?{query}	Yes
getRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, expand, callback)	Get permission scheme grant	{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}	Yes
deleteRestapi2permissionschemeschemeIdpermissionpermissionId(schemeId, permissionId, callback)	Delete permission scheme grant	{base_path}/{version}/permissionscheme/{pathv1}/permission/{pathv2}?{query}	Yes
getRestapi2projectprojectKeyOrIdnotificationscheme(projectKeyOrId, expand, callback)	Get project notification scheme	{base_path}/{version}/project/{pathv1}/notificationscheme?{query}	Yes
getRestapi2project(expand, recent, callback)	Get all projects	{base_path}/{version}/project?{query}	Yes
postRestapi2project(body, callback)	Create project	{base_path}/{version}/project?{query}	Yes
getRestapi2projectsearch(startAt, maxResults, orderBy, query, typeKey, categoryId, action, expand, callback)	Get projects paginated	{base_path}/{version}/project/search?{query}	Yes
getRestapi2projectprojectIdOrKey(projectIdOrKey, expand, callback)	Get project	{base_path}/{version}/project/{pathv1}?{query}	Yes
putRestapi2projectprojectIdOrKey(projectIdOrKey, expand, body, callback)	Update project	{base_path}/{version}/project/{pathv1}?{query}	Yes
deleteRestapi2projectprojectIdOrKey(projectIdOrKey, callback)	Delete project	{base_path}/{version}/project/{pathv1}?{query}	Yes
getRestapi2projectprojectIdOrKeystatuses(projectIdOrKey, callback)	Get all statuses for project	{base_path}/{version}/project/{pathv1}/statuses?{query}	Yes
putRestapi2projectprojectIdOrKeytypenewProjectTypeKey(projectIdOrKey, newProjectTypeKey, callback)	Update project type	{base_path}/{version}/project/{pathv1}/type/{pathv2}?{query}	Yes
getRestapi2projectprojectKeyOrIdpermissionscheme(projectKeyOrId, expand, callback)	Get assigned permission scheme	{base_path}/{version}/project/{pathv1}/permissionscheme?{query}	Yes
putRestapi2projectprojectKeyOrIdpermissionscheme(projectKeyOrId, expand, body, callback)	Assign permission scheme	{base_path}/{version}/project/{pathv1}/permissionscheme?{query}	Yes
getRestapi2projectprojectKeyOrIdsecuritylevel(projectKeyOrId, callback)	Get project issue security levels	{base_path}/{version}/project/{pathv1}/securitylevel?{query}	Yes
getRestapi2projectprojectKeyOrIdissuesecuritylevelscheme(projectKeyOrId, callback)	Get project issue security scheme	{base_path}/{version}/project/{pathv1}/issuesecuritylevelscheme?{query}	Yes
getRestapi2projecttype(callback)	Get all project types	{base_path}/{version}/project/type?{query}	Yes
getRestapi2projecttypeprojectTypeKey(projectTypeKey, callback)	Get project type by key	{base_path}/{version}/project/type/{pathv1}?{query}	Yes
getRestapi2projecttypeprojectTypeKeyaccessible(projectTypeKey, callback)	Get accessible project type by key	{base_path}/{version}/project/type/{pathv1}/accessible?{query}	Yes
getRestapi2serverInfo(callback)	Get Jira instance info	{base_path}/{version}/serverInfo?{query}	Yes
getRestapi2tasktaskId(taskId, callback)	Get task	{base_path}/{version}/task/{pathv1}?{query}	Yes
postRestapi2tasktaskIdcancel(taskId, callback)	Cancel task	{base_path}/{version}/task/{pathv1}/cancel?{query}	Yes
getRestapi2configurationtimetracking(callback)	Get selected time tracking provider	{base_path}/{version}/configuration/timetracking?{query}	Yes
putRestapi2configurationtimetracking(body, callback)	Select time tracking provider	{base_path}/{version}/configuration/timetracking?{query}	Yes
deleteRestapi2configurationtimetracking(callback)	Disable time tracking	{base_path}/{version}/configuration/timetracking?{query}	Yes
getRestapi2configurationtimetrackinglist(callback)	Get all time tracking providers	{base_path}/{version}/configuration/timetracking/list?{query}	Yes
getRestapi2configurationtimetrackingoptions(callback)	Get time tracking settings	{base_path}/{version}/configuration/timetracking/options?{query}	Yes
putRestapi2configurationtimetrackingoptions(body, callback)	Set time tracking settings	{base_path}/{version}/configuration/timetracking/options?{query}	Yes
getRestapi2userbulk(startAt, maxResults, username, key, accountId, callback)	Bulk get users	{base_path}/{version}/user/bulk?{query}	Yes
getRestapi2userbulkmigration(startAt, maxResults, username, key, callback)	Bulk get users migration	{base_path}/{version}/user/bulk/migration?{query}	Yes
getRestapi2user(accountId, username, key, expand, callback)	Get user	{base_path}/{version}/user?{query}	Yes
postRestapi2user(body, callback)	Create user	{base_path}/{version}/user?{query}	Yes
deleteRestapi2user(accountId, username, key, callback)	Delete user	{base_path}/{version}/user?{query}	Yes
getRestapi2usercolumns(accountId, username, callback)	Get user default columns	{base_path}/{version}/user/columns?{query}	Yes
putRestapi2usercolumns(accountId, body, callback)	Set user default columns	{base_path}/{version}/user/columns?{query}	Yes
deleteRestapi2usercolumns(accountId, username, callback)	Reset user default columns	{base_path}/{version}/user/columns?{query}	Yes
getRestapi2usergroups(accountId, username, key, callback)	Get user groups	{base_path}/{version}/user/groups?{query}	Yes
getRestapi2userproperties(accountId, userKey, username, callback)	Get user property keys	{base_path}/{version}/user/properties?{query}	Yes
getRestapi2userpropertiespropertyKey(accountId, userKey, username, propertyKey, callback)	Get user property	{base_path}/{version}/user/properties/{pathv1}?{query}	Yes
putRestapi2userpropertiespropertyKey(accountId, userKey, username, propertyKey, body, callback)	Set user property	{base_path}/{version}/user/properties/{pathv1}?{query}	Yes
deleteRestapi2userpropertiespropertyKey(accountId, userKey, username, propertyKey, callback)	Delete user property	{base_path}/{version}/user/properties/{pathv1}?{query}	Yes
getRestapi2usersearchquery(query, startAt, maxResults, includeInactive, callback)	Find users by query	{base_path}/{version}/user/search/query?{query}	Yes
getRestapi2usersearchquerykey(query, startAt, maxResults, includeInactive, callback)	Find user keys by query	{base_path}/{version}/user/search/query/key?{query}	Yes
getRestapi2userassignablemultiProjectSearch(query, username, accountId, projectKeys, startAt, maxResults, callback)	Find users assignable to projects	{base_path}/{version}/user/assignable/multiProjectSearch?{query}	Yes
getRestapi2userassignablesearch(query, username, accountId, project, issueKey, startAt, maxResults, actionDescriptorId, callback)	Find users assignable to issues	{base_path}/{version}/user/assignable/search?{query}	Yes
getRestapi2userpermissionsearch(query, username, accountId, permissions, issueKey, projectKey, startAt, maxResults, callback)	Find users with permissions	{base_path}/{version}/user/permission/search?{query}	Yes
getRestapi2userpicker(query, maxResults, showAvatar, exclude, excludeAccountIds, callback)	Find users for picker	{base_path}/{version}/user/picker?{query}	Yes
getRestapi2usersearch(query, username, accountId, startAt, maxResults, includeActive, includeInactive, property, callback)	Find users	{base_path}/{version}/user/search?{query}	Yes
getRestapi2userviewissuesearch(query, username, accountId, issueKey, projectKey, startAt, maxResults, callback)	Find users with browse permission	{base_path}/{version}/user/viewissue/search?{query}	Yes
getRestapi2workflow(workflowName, callback)	Get all workflows	{base_path}/{version}/workflow?{query}	Yes
postRestapi2workflowscheme(body, callback)	Create workflow scheme	{base_path}/{version}/workflowscheme?{query}	Yes
getRestapi2workflowschemeid(id, returnDraftIfExists, callback)	Get workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}?{query}	Yes
putRestapi2workflowschemeid(id, body, callback)	Update workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}?{query}	Yes
deleteRestapi2workflowschemeid(id, callback)	Delete workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}?{query}	Yes
getRestapi2workflowschemeiddefault(id, returnDraftIfExists, callback)	Get default workflow	{base_path}/{version}/workflowscheme/{pathv1}/default?{query}	Yes
putRestapi2workflowschemeiddefault(id, body, callback)	Update default workflow	{base_path}/{version}/workflowscheme/{pathv1}/default?{query}	Yes
deleteRestapi2workflowschemeiddefault(id, updateDraftIfNeeded, callback)	Delete default workflow	{base_path}/{version}/workflowscheme/{pathv1}/default?{query}	Yes
getRestapi2workflowschemeidissuetypeissueType(id, issueType, returnDraftIfExists, callback)	Get workflow for issue type in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/issuetype/{pathv2}?{query}	Yes
putRestapi2workflowschemeidissuetypeissueType(id, issueType, body, callback)	Set workflow for issue type in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/issuetype/{pathv2}?{query}	Yes
deleteRestapi2workflowschemeidissuetypeissueType(id, issueType, updateDraftIfNeeded, callback)	Delete workflow for issue type in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/issuetype/{pathv2}?{query}	Yes
getRestapi2workflowschemeidworkflow(id, workflowName, returnDraftIfExists, callback)	Get issue types for workflows in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/workflow?{query}	Yes
putRestapi2workflowschemeidworkflow(id, workflowName, body, callback)	Set issue types for workflow in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/workflow?{query}	Yes
deleteRestapi2workflowschemeidworkflow(id, workflowName, updateDraftIfNeeded, callback)	Delete issue types for workflow in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/workflow?{query}	Yes
postRestapi2workflowschemeidcreatedraft(id, callback)	Create draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/createdraft?{query}	Yes
getRestapi2workflowschemeiddraft(id, callback)	Get draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft?{query}	Yes
putRestapi2workflowschemeiddraft(id, body, callback)	Update draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft?{query}	Yes
deleteRestapi2workflowschemeiddraft(id, callback)	Delete draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft?{query}	Yes
getRestapi2workflowschemeiddraftdefault(id, callback)	Get draft default workflow	{base_path}/{version}/workflowscheme/{pathv1}/draft/default?{query}	Yes
putRestapi2workflowschemeiddraftdefault(id, body, callback)	Update draft default workflow	{base_path}/{version}/workflowscheme/{pathv1}/draft/default?{query}	Yes
deleteRestapi2workflowschemeiddraftdefault(id, callback)	Delete draft default workflow	{base_path}/{version}/workflowscheme/{pathv1}/draft/default?{query}	Yes
getRestapi2workflowschemeiddraftissuetypeissueType(id, issueType, callback)	Get workflow for issue type in draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/issuetype/{pathv2}?{query}	Yes
putRestapi2workflowschemeiddraftissuetypeissueType(id, issueType, body, callback)	Set workflow for issue type in draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/issuetype/{pathv2}?{query}	Yes
deleteRestapi2workflowschemeiddraftissuetypeissueType(id, issueType, callback)	Delete workflow for issue type in draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/issuetype/{pathv2}?{query}	Yes
getRestapi2workflowschemeiddraftworkflow(id, workflowName, callback)	Get issue types for workflows in draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/workflow?{query}	Yes
putRestapi2workflowschemeiddraftworkflow(id, workflowName, body, callback)	Set issue types for workflow in workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/workflow?{query}	Yes
deleteRestapi2workflowschemeiddraftworkflow(id, workflowName, callback)	Delete issue types for workflow in draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/workflow?{query}	Yes
getRestapi2workflowtransitionstransitionIdproperties(transitionId, includeReservedKeys, key, workflowName, workflowMode, callback)	Get workflow transition properties	{base_path}/{version}/workflow/transitions/{pathv1}/properties?{query}	Yes
putRestapi2workflowtransitionstransitionIdproperties(transitionId, key, workflowName, workflowMode, body, callback)	Update workflow transition property	{base_path}/{version}/workflow/transitions/{pathv1}/properties?{query}	Yes
postRestapi2workflowtransitionstransitionIdproperties(transitionId, key, workflowName, workflowMode, body, callback)	Create workflow transition property	{base_path}/{version}/workflow/transitions/{pathv1}/properties?{query}	Yes
deleteRestapi2workflowtransitionstransitionIdproperties(transitionId, key, workflowName, workflowMode, callback)	Delete workflow transition property	{base_path}/{version}/workflow/transitions/{pathv1}/properties?{query}	Yes
getRestapi2attachmentmeta(callback)	Get Jira attachment settings	{base_path}/{version}/attachment/meta?{query}	Yes
getRestapi2attachmentid(id, callback)	Get attachment metadata	{base_path}/{version}/attachment/{pathv1}?{query}	Yes
deleteRestapi2attachmentid(id, callback)	Delete attachment	{base_path}/{version}/attachment/{pathv1}?{query}	Yes
getRestapi2attachmentidexpandhuman(id, callback)	Get all metadata for an expanded attachment	{base_path}/{version}/attachment/{pathv1}/expand/human?{query}	Yes
getRestapi2attachmentidexpandraw(id, callback)	Get contents metadata for an expanded attachment	{base_path}/{version}/attachment/{pathv1}/expand/raw?{query}	Yes
postRestapi2issueissueIdOrKeyattachments(issueIdOrKey, body, callback)	Add attachment	{base_path}/{version}/issue/{pathv1}/attachments?{query}	Yes
getRestapi2avatartypesystem(type, callback)	Get system avatars by type	{base_path}/{version}/avatar/{pathv1}/system?{query}	Yes
getRestapi2universalAvatartypetypeownerentityId(type, entityId, callback)	Get avatars	{base_path}/{version}/universal_avatar/type/{pathv1}/owner/{pathv2}?{query}	Yes
postRestapi2universalAvatartypetypeownerentityId(type, entityId, x, y, size, body, callback)	Load avatar	{base_path}/{version}/universal_avatar/type/{pathv1}/owner/{pathv2}?{query}	Yes
deleteRestapi2universalAvatartypetypeownerowningObjectIdavatarid(type, owningObjectId, id, callback)	Delete avatar	{base_path}/{version}/universal_avatar/type/{pathv1}/owner/{pathv2}/avatar/{pathv3}?{query}	Yes
postRestapi2commentlist(expand, body, callback)	Get comments by IDs	{base_path}/{version}/comment/list?{query}	Yes
getRestapi2issueissueIdOrKeycomment(issueIdOrKey, startAt, maxResults, orderBy, expand, callback)	Get comments	{base_path}/{version}/issue/{pathv1}/comment?{query}	Yes
postRestapi2issueissueIdOrKeycomment(issueIdOrKey, expand, body, callback)	Add comment	{base_path}/{version}/issue/{pathv1}/comment?{query}	Yes
getRestapi2issueissueIdOrKeycommentid(issueIdOrKey, id, expand, callback)	Get comment	{base_path}/{version}/issue/{pathv1}/comment/{pathv2}?{query}	Yes
putRestapi2issueissueIdOrKeycommentid(issueIdOrKey, id, expand, body, callback)	Update comment	{base_path}/{version}/issue/{pathv1}/comment/{pathv2}?{query}	Yes
deleteRestapi2issueissueIdOrKeycommentid(issueIdOrKey, id, callback)	Delete comment	{base_path}/{version}/issue/{pathv1}/comment/{pathv2}?{query}	Yes
getRestapi2commentcommentIdproperties(commentId, callback)	Get comment property keys	{base_path}/{version}/comment/{pathv1}/properties?{query}	Yes
getRestapi2commentcommentIdpropertiespropertyKey(commentId, propertyKey, callback)	Get comment property	{base_path}/{version}/comment/{pathv1}/properties/{pathv2}?{query}	Yes
putRestapi2commentcommentIdpropertiespropertyKey(commentId, propertyKey, body, callback)	Set comment property	{base_path}/{version}/comment/{pathv1}/properties/{pathv2}?{query}	Yes
deleteRestapi2commentcommentIdpropertiespropertyKey(commentId, propertyKey, callback)	Delete comment property	{base_path}/{version}/comment/{pathv1}/properties/{pathv2}?{query}	Yes
postRestapi2component(body, callback)	Create component	{base_path}/{version}/component?{query}	Yes
getRestapi2componentid(id, callback)	Get component	{base_path}/{version}/component/{pathv1}?{query}	Yes
putRestapi2componentid(id, body, callback)	Update component	{base_path}/{version}/component/{pathv1}?{query}	Yes
deleteRestapi2componentid(id, moveIssuesTo, callback)	Delete component	{base_path}/{version}/component/{pathv1}?{query}	Yes
getRestapi2componentidrelatedIssueCounts(id, callback)	Get component issues count	{base_path}/{version}/component/{pathv1}/relatedIssueCounts?{query}	Yes
getRestapi2projectprojectIdOrKeycomponent(projectIdOrKey, startAt, maxResults, orderBy, query, callback)	Get project components paginated	{base_path}/{version}/project/{pathv1}/component?{query}	Yes
getRestapi2projectprojectIdOrKeycomponents(projectIdOrKey, callback)	Get project components	{base_path}/{version}/project/{pathv1}/components?{query}	Yes
getRestapi2customFieldOptionid(id, callback)	Get custom field option	{base_path}/{version}/customFieldOption/{pathv1}?{query}	Yes
getRestapi2field(callback)	Get fields	{base_path}/{version}/field?{query}	Yes
postRestapi2field(body, callback)	Create custom field	{base_path}/{version}/field?{query}	Yes
getRestapi2fieldfieldKeyoption(startAt, maxResults, fieldKey, callback)	Get all issue field options	{base_path}/{version}/field/{pathv1}/option?{query}	Yes
postRestapi2fieldfieldKeyoption(fieldKey, body, callback)	Create issue field option	{base_path}/{version}/field/{pathv1}/option?{query}	Yes
getRestapi2fieldfieldKeyoptionsuggestionsedit(startAt, maxResults, projectId, fieldKey, callback)	Get selectable issue field options	{base_path}/{version}/field/{pathv1}/option/suggestions/edit?{query}	Yes
getRestapi2fieldfieldKeyoptionsuggestionssearch(startAt, maxResults, projectId, fieldKey, callback)	Get visible issue field options	{base_path}/{version}/field/{pathv1}/option/suggestions/search?{query}	Yes
getRestapi2fieldfieldKeyoptionoptionId(fieldKey, optionId, callback)	Get issue field option	{base_path}/{version}/field/{pathv1}/option/{pathv2}?{query}	Yes
putRestapi2fieldfieldKeyoptionoptionId(fieldKey, optionId, body, callback)	Update issue field option	{base_path}/{version}/field/{pathv1}/option/{pathv2}?{query}	Yes
deleteRestapi2fieldfieldKeyoptionoptionId(fieldKey, optionId, callback)	Delete issue field option	{base_path}/{version}/field/{pathv1}/option/{pathv2}?{query}	Yes
deleteRestapi2fieldfieldKeyoptionoptionIdissue(replaceWith, jql, fieldKey, optionId, callback)	Replace issue field option	{base_path}/{version}/field/{pathv1}/option/{pathv2}/issue?{query}	Yes
getRestapi2group(groupname, expand, callback)	Get group	{base_path}/{version}/group?{query}	Yes
postRestapi2group(body, callback)	Create group	{base_path}/{version}/group?{query}	Yes
deleteRestapi2group(groupname, swapGroup, callback)	Remove group	{base_path}/{version}/group?{query}	Yes
getRestapi2groupmember(groupname, includeInactiveUsers, startAt, maxResults, callback)	Get users from group	{base_path}/{version}/group/member?{query}	Yes
postRestapi2groupuser(groupname, body, callback)	Add user to group	{base_path}/{version}/group/user?{query}	Yes
deleteRestapi2groupuser(groupname, username, accountId, callback)	Remove user from group	{base_path}/{version}/group/user?{query}	Yes
getRestapi2groupspicker(accountId, query, exclude, maxResults, userName, callback)	Find groups	{base_path}/{version}/groups/picker?{query}	Yes
getRestapi2groupuserpicker(query, maxResults, showAvatar, fieldId, projectId, issueTypeId, avatarSize, caseInsensitive, excludeConnectAddons, callback)	Find users and groups	{base_path}/{version}/groupuserpicker?{query}	Yes
postRestapi2issue(updateHistory, body, callback)	Create issue	{base_path}/{version}/issue?{query}	Yes
postRestapi2issuebulk(body, callback)	Bulk issue create	{base_path}/{version}/issue/bulk?{query}	Yes
getRestapi2issuecreatemeta(projectIds, projectKeys, issuetypeIds, issuetypeNames, expand, callback)	Get create issue metadata	{base_path}/{version}/issue/createmeta?{query}	Yes
getRestapi2issueissueIdOrKey(issueIdOrKey, fields, fieldsByKeys, expand, properties, updateHistory, callback)	Get issue	{base_path}/{version}/issue/{pathv1}?{query}	Yes
putRestapi2issueissueIdOrKey(issueIdOrKey, notifyUsers, overrideScreenSecurity, overrideEditableFlag, body, callback)	Edit issue	{base_path}/{version}/issue/{pathv1}?{query}	Yes
deleteRestapi2issueissueIdOrKey(issueIdOrKey, deleteSubtasks, callback)	Delete issue	{base_path}/{version}/issue/{pathv1}?{query}	Yes
putRestapi2issueissueIdOrKeyassignee(issueIdOrKey, body, callback)	Assign issue	{base_path}/{version}/issue/{pathv1}/assignee?{query}	Yes
getRestapi2issueissueIdOrKeychangelog(issueIdOrKey, startAt, maxResults, callback)	Get change logs	{base_path}/{version}/issue/{pathv1}/changelog?{query}	Yes
getRestapi2issueissueIdOrKeyeditmeta(issueIdOrKey, overrideScreenSecurity, overrideEditableFlag, callback)	Get edit issue metadata	{base_path}/{version}/issue/{pathv1}/editmeta?{query}	Yes
postRestapi2issueissueIdOrKeynotify(issueIdOrKey, body, callback)	Send notification for issue	{base_path}/{version}/issue/{pathv1}/notify?{query}	Yes
getRestapi2issueissueIdOrKeytransitions(issueIdOrKey, expand, transitionId, skipRemoteOnlyCondition, callback)	Get transitions	{base_path}/{version}/issue/{pathv1}/transitions?{query}	Yes
postRestapi2issueissueIdOrKeytransitions(issueIdOrKey, body, callback)	Transition issue	{base_path}/{version}/issue/{pathv1}/transitions?{query}	Yes
getRestapi2issueissueIdOrKeyremotelink(issueIdOrKey, globalId, callback)	Get remote issue links	{base_path}/{version}/issue/{pathv1}/remotelink?{query}	Yes
postRestapi2issueissueIdOrKeyremotelink(issueIdOrKey, body, callback)	Create or update remote issue link	{base_path}/{version}/issue/{pathv1}/remotelink?{query}	Yes
deleteRestapi2issueissueIdOrKeyremotelink(issueIdOrKey, globalId, callback)	Delete remote issue link by global id	{base_path}/{version}/issue/{pathv1}/remotelink?{query}	Yes
getRestapi2issueissueIdOrKeyremotelinklinkId(issueIdOrKey, linkId, callback)	Get remote issue link by id	{base_path}/{version}/issue/{pathv1}/remotelink/{pathv2}?{query}	Yes
putRestapi2issueissueIdOrKeyremotelinklinkId(issueIdOrKey, linkId, body, callback)	Update remote issue link	{base_path}/{version}/issue/{pathv1}/remotelink/{pathv2}?{query}	Yes
deleteRestapi2issueissueIdOrKeyremotelinklinkId(issueIdOrKey, linkId, callback)	Delete remote issue link by id	{base_path}/{version}/issue/{pathv1}/remotelink/{pathv2}?{query}	Yes
getRestapi2issueissueIdOrKeyvotes(issueIdOrKey, callback)	Get votes	{base_path}/{version}/issue/{pathv1}/votes?{query}	Yes
postRestapi2issueissueIdOrKeyvotes(issueIdOrKey, callback)	Add vote	{base_path}/{version}/issue/{pathv1}/votes?{query}	Yes
deleteRestapi2issueissueIdOrKeyvotes(issueIdOrKey, callback)	Delete vote	{base_path}/{version}/issue/{pathv1}/votes?{query}	Yes
getRestapi2issueissueIdOrKeywatchers(issueIdOrKey, callback)	Get issue watchers	{base_path}/{version}/issue/{pathv1}/watchers?{query}	Yes
postRestapi2issueissueIdOrKeywatchers(issueIdOrKey, body, callback)	Add watcher	{base_path}/{version}/issue/{pathv1}/watchers?{query}	Yes
deleteRestapi2issueissueIdOrKeywatchers(issueIdOrKey, username, accountId, callback)	Delete watcher	{base_path}/{version}/issue/{pathv1}/watchers?{query}	Yes
getRestapi2issueissueIdOrKeyworklog(issueIdOrKey, startAt, maxResults, expand, callback)	Get issue worklogs	{base_path}/{version}/issue/{pathv1}/worklog?{query}	Yes
postRestapi2issueissueIdOrKeyworklog(issueIdOrKey, notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag, body, callback)	Add worklog	{base_path}/{version}/issue/{pathv1}/worklog?{query}	Yes
getRestapi2issueissueIdOrKeyworklogid(issueIdOrKey, id, expand, callback)	Get worklog	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}?{query}	Yes
putRestapi2issueissueIdOrKeyworklogid(issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlag, body, callback)	Update worklog	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}?{query}	Yes
deleteRestapi2issueissueIdOrKeyworklogid(issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag, callback)	Delete worklog	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}?{query}	Yes
getRestapi2worklogdeleted(since, callback)	Get IDs of deleted worklogs	{base_path}/{version}/worklog/deleted?{query}	Yes
postRestapi2workloglist(expand, body, callback)	Get worklogs	{base_path}/{version}/worklog/list?{query}	Yes
getRestapi2worklogupdated(since, expand, callback)	Get IDs of updated worklogs	{base_path}/{version}/worklog/updated?{query}	Yes
getRestapi2issueissueIdOrKeyworklogworklogIdproperties(issueIdOrKey, worklogId, callback)	Get worklog property keys	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}/properties?{query}	Yes
getRestapi2issueissueIdOrKeyworklogworklogIdpropertiespropertyKey(issueIdOrKey, worklogId, propertyKey, callback)	Get worklog property	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}/properties/{pathv3}?{query}	Yes
putRestapi2issueissueIdOrKeyworklogworklogIdpropertiespropertyKey(issueIdOrKey, worklogId, propertyKey, body, callback)	Set worklog property	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}/properties/{pathv3}?{query}	Yes
deleteRestapi2issueissueIdOrKeyworklogworklogIdpropertiespropertyKey(issueIdOrKey, worklogId, propertyKey, callback)	Delete worklog property	{base_path}/{version}/issue/{pathv1}/worklog/{pathv2}/properties/{pathv3}?{query}	Yes
postRestapi2issueLink(body, callback)	Create issue link	{base_path}/{version}/issueLink?{query}	Yes
getRestapi2issueLinklinkId(linkId, callback)	Get issue link	{base_path}/{version}/issueLink/{pathv1}?{query}	Yes
deleteRestapi2issueLinklinkId(linkId, callback)	Delete issue link	{base_path}/{version}/issueLink/{pathv1}?{query}	Yes
getRestapi2issueLinkType(callback)	Get issue link types	{base_path}/{version}/issueLinkType?{query}	Yes
postRestapi2issueLinkType(body, callback)	Create issue link type	{base_path}/{version}/issueLinkType?{query}	Yes
getRestapi2issueLinkTypeissueLinkTypeId(issueLinkTypeId, callback)	Get issue link type	{base_path}/{version}/issueLinkType/{pathv1}?{query}	Yes
putRestapi2issueLinkTypeissueLinkTypeId(issueLinkTypeId, body, callback)	Update issue link type	{base_path}/{version}/issueLinkType/{pathv1}?{query}	Yes
deleteRestapi2issueLinkTypeissueLinkTypeId(issueLinkTypeId, callback)	Delete issue link type	{base_path}/{version}/issueLinkType/{pathv1}?{query}	Yes
getRestapi2issuesecurityschemes(callback)	Get issue security schemes	{base_path}/{version}/issuesecurityschemes?{query}	Yes
getRestapi2issuesecurityschemesid(id, callback)	Get issue security scheme	{base_path}/{version}/issuesecurityschemes/{pathv1}?{query}	Yes
getRestapi2issuetype(callback)	Get all issue types for user	{base_path}/{version}/issuetype?{query}	Yes
postRestapi2issuetype(body, callback)	Create issue type	{base_path}/{version}/issuetype?{query}	Yes
getRestapi2issuetypeid(id, callback)	Get issue type	{base_path}/{version}/issuetype/{pathv1}?{query}	Yes
putRestapi2issuetypeid(id, body, callback)	Update issue type	{base_path}/{version}/issuetype/{pathv1}?{query}	Yes
deleteRestapi2issuetypeid(id, alternativeIssueTypeId, callback)	Delete issue type	{base_path}/{version}/issuetype/{pathv1}?{query}	Yes
getRestapi2issuetypeidalternatives(id, callback)	Get alternative issue types	{base_path}/{version}/issuetype/{pathv1}/alternatives?{query}	Yes
postRestapi2issuetypeidavatar2(id, x, y, size, body, callback)	Load issue type avatar	{base_path}/{version}/issuetype/{pathv1}/avatar2?{query}	Yes
getRestapi2issuetypeissueTypeIdproperties(issueTypeId, callback)	Get issue type property keys	{base_path}/{version}/issuetype/{pathv1}/properties?{query}	Yes
getRestapi2issuetypeissueTypeIdpropertiespropertyKey(issueTypeId, propertyKey, callback)	Get issue type property	{base_path}/{version}/issuetype/{pathv1}/properties/{pathv2}?{query}	Yes
putRestapi2issuetypeissueTypeIdpropertiespropertyKey(issueTypeId, propertyKey, body, callback)	Set issue type property	{base_path}/{version}/issuetype/{pathv1}/properties/{pathv2}?{query}	Yes
deleteRestapi2issuetypeissueTypeIdpropertiespropertyKey(issueTypeId, propertyKey, callback)	Delete issue type property	{base_path}/{version}/issuetype/{pathv1}/properties/{pathv2}?{query}	Yes
getRestapi2priority(callback)	Get priorities	{base_path}/{version}/priority?{query}	Yes
getRestapi2priorityid(id, callback)	Get priority	{base_path}/{version}/priority/{pathv1}?{query}	Yes
putRestapi2projectprojectIdOrKeyavatar(projectIdOrKey, body, callback)	Set project avatar	{base_path}/{version}/project/{pathv1}/avatar?{query}	Yes
deleteRestapi2projectprojectIdOrKeyavatarid(projectIdOrKey, id, callback)	Delete project avatar	{base_path}/{version}/project/{pathv1}/avatar/{pathv2}?{query}	Yes
postRestapi2projectprojectIdOrKeyavatar2(projectIdOrKey, x, y, size, body, callback)	Load project avatar	{base_path}/{version}/project/{pathv1}/avatar2?{query}	Yes
getRestapi2projectprojectIdOrKeyavatars(projectIdOrKey, callback)	Get all project avatars	{base_path}/{version}/project/{pathv1}/avatars?{query}	Yes
getRestapi2projectprojectIdOrKeyproperties(projectIdOrKey, callback)	Get project property keys	{base_path}/{version}/project/{pathv1}/properties?{query}	Yes
getRestapi2projectprojectIdOrKeypropertiespropertyKey(projectIdOrKey, propertyKey, callback)	Get project property	{base_path}/{version}/project/{pathv1}/properties/{pathv2}?{query}	Yes
putRestapi2projectprojectIdOrKeypropertiespropertyKey(projectIdOrKey, propertyKey, body, callback)	Set project property	{base_path}/{version}/project/{pathv1}/properties/{pathv2}?{query}	Yes
deleteRestapi2projectprojectIdOrKeypropertiespropertyKey(projectIdOrKey, propertyKey, callback)	Delete project property	{base_path}/{version}/project/{pathv1}/properties/{pathv2}?{query}	Yes
getRestapi2projectprojectIdOrKeyrole(projectIdOrKey, callback)	Get project roles for project	{base_path}/{version}/project/{pathv1}/role?{query}	Yes
getRestapi2projectprojectIdOrKeyroleid(projectIdOrKey, id, callback)	Get project role for project	{base_path}/{version}/project/{pathv1}/role/{pathv2}?{query}	Yes
getRestapi2projectprojectIdOrKeyroledetails(projectIdOrKey, currentMember, callback)	Get project role details	{base_path}/{version}/project/{pathv1}/roledetails?{query}	Yes
getRestapi2role(callback)	Get all project roles	{base_path}/{version}/role?{query}	Yes
postRestapi2role(body, callback)	Create project role	{base_path}/{version}/role?{query}	Yes
getRestapi2roleid(id, callback)	Get project role by ID	{base_path}/{version}/role/{pathv1}?{query}	Yes
putRestapi2roleid(id, body, callback)	Fully update project role	{base_path}/{version}/role/{pathv1}?{query}	Yes
postRestapi2roleid(id, body, callback)	Partial update project role	{base_path}/{version}/role/{pathv1}?{query}	Yes
deleteRestapi2roleid(id, swap, callback)	Delete project role	{base_path}/{version}/role/{pathv1}?{query}	Yes
putRestapi2projectprojectIdOrKeyroleid(projectIdOrKey, id, body, callback)	Set actors for project role	{base_path}/{version}/project/{pathv1}/role/{pathv2}?{query}	Yes
postRestapi2projectprojectIdOrKeyroleid(projectIdOrKey, id, body, callback)	Add actors to project role	{base_path}/{version}/project/{pathv1}/role/{pathv2}?{query}	Yes
deleteRestapi2projectprojectIdOrKeyroleid(projectIdOrKey, id, user, group, callback)	Delete actors from project role	{base_path}/{version}/project/{pathv1}/role/{pathv2}?{query}	Yes
getRestapi2roleidactors(id, callback)	Get default actors for project role	{base_path}/{version}/role/{pathv1}/actors?{query}	Yes
postRestapi2roleidactors(id, body, callback)	Add default actors to project role	{base_path}/{version}/role/{pathv1}/actors?{query}	Yes
deleteRestapi2roleidactors(id, user, group, callback)	Delete default actors from project role	{base_path}/{version}/role/{pathv1}/actors?{query}	Yes
getRestapi2projectprojectIdOrKeyversion(projectIdOrKey, startAt, maxResults, orderBy, query, status, expand, callback)	Get project versions paginated	{base_path}/{version}/project/{pathv1}/version?{query}	Yes
getRestapi2projectprojectIdOrKeyversions(projectIdOrKey, expand, callback)	Get project versions	{base_path}/{version}/project/{pathv1}/versions?{query}	Yes
postRestapi2version(body, callback)	Create version	{base_path}/{version}/version?{query}	Yes
getRestapi2versionid(id, expand, callback)	Get version	{base_path}/{version}/version/{pathv1}?{query}	Yes
putRestapi2versionid(id, body, callback)	Update version	{base_path}/{version}/version/{pathv1}?{query}	Yes
deleteRestapi2versionid(id, moveFixIssuesTo, moveAffectedIssuesTo, callback)	Delete version	{base_path}/{version}/version/{pathv1}?{query}	Yes
putRestapi2versionidmergetomoveIssuesTo(id, moveIssuesTo, callback)	Merge versions	{base_path}/{version}/version/{pathv1}/mergeto/{pathv2}?{query}	Yes
postRestapi2versionidmove(id, body, callback)	Move version	{base_path}/{version}/version/{pathv1}/move?{query}	Yes
getRestapi2versionidrelatedIssueCounts(id, callback)	Get version's related issues count	{base_path}/{version}/version/{pathv1}/relatedIssueCounts?{query}	Yes
postRestapi2versionidremoveAndSwap(id, body, callback)	Delete and replace version	{base_path}/{version}/version/{pathv1}/removeAndSwap?{query}	Yes
getRestapi2versionidunresolvedIssueCount(id, callback)	Get version's unresolved issues count	{base_path}/{version}/version/{pathv1}/unresolvedIssueCount?{query}	Yes
getRestapi2projectCategory(callback)	Get all project categories	{base_path}/{version}/projectCategory?{query}	Yes
postRestapi2projectCategory(body, callback)	Create project category	{base_path}/{version}/projectCategory?{query}	Yes
getRestapi2projectCategoryid(id, callback)	Get project category by id	{base_path}/{version}/projectCategory/{pathv1}?{query}	Yes
putRestapi2projectCategoryid(id, body, callback)	Update project category	{base_path}/{version}/projectCategory/{pathv1}?{query}	Yes
deleteRestapi2projectCategoryid(id, callback)	Delete project category	{base_path}/{version}/projectCategory/{pathv1}?{query}	Yes
getRestapi2projectvalidatekey(key, callback)	Validate project key	{base_path}/{version}/projectvalidate/key?{query}	Yes
getRestapi2projectvalidatevalidProjectKey(key, callback)	Get valid project key	{base_path}/{version}/projectvalidate/validProjectKey?{query}	Yes
getRestapi2projectvalidatevalidProjectName(name, callback)	Get valid project name	{base_path}/{version}/projectvalidate/validProjectName?{query}	Yes
getRestapi2resolution(callback)	Get resolutions	{base_path}/{version}/resolution?{query}	Yes
getRestapi2resolutionid(id, callback)	Get resolution	{base_path}/{version}/resolution/{pathv1}?{query}	Yes
getRestapi2screens(startAt, maxResults, callback)	Get all screens	{base_path}/{version}/screens?{query}	Yes
postRestapi2screensaddToDefaultfieldId(fieldId, callback)	Add field to default screen	{base_path}/{version}/screens/addToDefault/{pathv1}?{query}	Yes
getRestapi2screensscreenIdavailableFields(screenId, callback)	Get available screen fields	{base_path}/{version}/screens/{pathv1}/availableFields?{query}	Yes
getRestapi2screensscreenIdtabs(screenId, projectKey, callback)	Get all screen tabs	{base_path}/{version}/screens/{pathv1}/tabs?{query}	Yes
postRestapi2screensscreenIdtabs(screenId, body, callback)	Create screen tab	{base_path}/{version}/screens/{pathv1}/tabs?{query}	Yes
putRestapi2screensscreenIdtabstabId(screenId, tabId, body, callback)	Update screen tab	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}?{query}	Yes
deleteRestapi2screensscreenIdtabstabId(screenId, tabId, callback)	Delete screen tab	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}?{query}	Yes
getRestapi2screensscreenIdtabstabIdfields(screenId, tabId, projectKey, callback)	Get all screen tab fields	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}/fields?{query}	Yes
postRestapi2screensscreenIdtabstabIdfields(screenId, tabId, body, callback)	Add screen tab field	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}/fields?{query}	Yes
deleteRestapi2screensscreenIdtabstabIdfieldsid(screenId, tabId, id, callback)	Remove screen tab field	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}/fields/{pathv3}?{query}	Yes
postRestapi2screensscreenIdtabstabIdfieldsidmove(screenId, tabId, id, body, callback)	Move screen tab field	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}/fields/{pathv3}/move?{query}	Yes
postRestapi2screensscreenIdtabstabIdmovepos(screenId, tabId, pos, callback)	Move screen tab	{base_path}/{version}/screens/{pathv1}/tabs/{pathv2}/move/{pathv3}?{query}	Yes
getRestapi2securitylevelid(id, callback)	Get issue security level	{base_path}/{version}/securitylevel/{pathv1}?{query}	Yes
getRestapi2status(callback)	Get all statuses	{base_path}/{version}/status?{query}	Yes
getRestapi2statusidOrName(idOrName, callback)	Get status	{base_path}/{version}/status/{pathv1}?{query}	Yes
getRestapi2statuscategory(callback)	Get all status categories	{base_path}/{version}/statuscategory?{query}	Yes
getRestapi2statuscategoryidOrKey(idOrKey, callback)	Get status category	{base_path}/{version}/statuscategory/{pathv1}?{query}	Yes
updateMultipleCustomFieldValues(generateChangelog, body, callback)	Update custom fields	{base_path}/{version}/app/field/value?{query}	Yes
updateCustomFieldValue(fieldIdOrKey, generateChangelog, body, callback)	Update custom field value	{base_path}/{version}/app/field/{pathv1}/value?{query}	Yes
getCustomFieldConfiguration(fieldIdOrKey, id, contextId, fieldContextId, issueId, projectKeyOrId, issueTypeId, startAt, maxResults, callback)	Get custom field configurations	{base_path}/{version}/app/field/{pathv1}/context/configuration?{query}	Yes
updateCustomFieldConfiguration(fieldIdOrKey, body, callback)	Update custom field configurations	{base_path}/{version}/app/field/{pathv1}/context/configuration?{query}	Yes
getAttachmentContent(id, redirect, callback)	Get attachment content	{base_path}/{version}/attachment/content/{pathv1}?{query}	Yes
getAttachmentThumbnail(id, redirect, fallbackToDefault, width, height, callback)	Get attachment thumbnail	{base_path}/{version}/attachment/thumbnail/{pathv1}?{query}	Yes
createDashboard(body, callback)	Create dashboard	{base_path}/{version}/dashboard?{query}	Yes
updateDashboard(id, body, callback)	Update dashboard	{base_path}/{version}/dashboard/{pathv1}?{query}	Yes
deleteDashboard(id, callback)	Delete dashboard	{base_path}/{version}/dashboard/{pathv1}?{query}	Yes
copyDashboard(id, body, callback)	Copy dashboard	{base_path}/{version}/dashboard/{pathv1}/copy?{query}	Yes
getEvents(callback)	Get events	{base_path}/{version}/events?{query}	Yes
getChangeLogsByIds(issueIdOrKey, body, callback)	Get changelogs by IDs	{base_path}/{version}/issue/{pathv1}/changelog/list?{query}	Yes
analyseExpression(check = 'syntax', body, callback)	Analyse Jira expression	{base_path}/{version}/expression/analyse?{query}	Yes
getFieldsPaginated(startAt, maxResults, type, id, query, orderBy = 'contextsCount', expand, callback)	Get fields paginated	{base_path}/{version}/field/search?{query}	Yes
updateCustomField(fieldId, body, callback)	Update custom field	{base_path}/{version}/field/{pathv1}?{query}	Yes
getContextsForFieldDeprecated(fieldId, startAt, maxResults, callback)	Get contexts for a field	{base_path}/{version}/field/{pathv1}/contexts?{query}	Yes
deleteCustomField(id, callback)	Delete custom field	{base_path}/{version}/field/{pathv1}?{query}	Yes
restoreCustomField(id, callback)	Restore custom field from trash	{base_path}/{version}/field/{pathv1}/restore?{query}	Yes
trashCustomField(id, callback)	Move custom field to trash	{base_path}/{version}/field/{pathv1}/trash?{query}	Yes
getContextsForField(fieldId, isAnyIssueType, isGlobalContext, contextId, startAt, maxResults, callback)	Get custom field contexts	{base_path}/{version}/field/{pathv1}/context?{query}	Yes
createCustomFieldContext(fieldId, body, callback)	Create custom field context	{base_path}/{version}/field/{pathv1}/context?{query}	Yes
getDefaultValues(fieldId, contextId, startAt, maxResults, callback)	Get custom field contexts default values	{base_path}/{version}/field/{pathv1}/context/defaultValue?{query}	Yes
setDefaultValues(fieldId, body, callback)	Set custom field contexts default values	{base_path}/{version}/field/{pathv1}/context/defaultValue?{query}	Yes
getIssueTypeMappingsForContexts(fieldId, contextId, startAt, maxResults, callback)	Get issue types for custom field context	{base_path}/{version}/field/{pathv1}/context/issuetypemapping?{query}	Yes
getCustomFieldContextsForProjectsAndIssueTypes(fieldId, startAt, maxResults, body, callback)	Get custom field contexts for projects and issue types	{base_path}/{version}/field/{pathv1}/context/mapping?{query}	Yes
getProjectContextMapping(fieldId, contextId, startAt, maxResults, callback)	Get project mappings for custom field context	{base_path}/{version}/field/{pathv1}/context/projectmapping?{query}	Yes
updateCustomFieldContext(fieldId, contextId, body, callback)	Update custom field context	{base_path}/{version}/field/{pathv1}/context/{pathv2}?{query}	Yes
deleteCustomFieldContext(fieldId, contextId, callback)	Delete custom field context	{base_path}/{version}/field/{pathv1}/context/{pathv2}?{query}	Yes
addIssueTypesToContext(fieldId, contextId, body, callback)	Add issue types to context	{base_path}/{version}/field/{pathv1}/context/{pathv2}/issuetype?{query}	Yes
removeIssueTypesFromContext(fieldId, contextId, body, callback)	Remove issue types from context	{base_path}/{version}/field/{pathv1}/context/{pathv2}/issuetype/remove?{query}	Yes
assignProjectsToCustomFieldContext(fieldId, contextId, body, callback)	Assign custom field context to projects	{base_path}/{version}/field/{pathv1}/context/{pathv2}/project?{query}	Yes
removeCustomFieldContextFromProjects(fieldId, contextId, body, callback)	Remove custom field context from projects	{base_path}/{version}/field/{pathv1}/context/{pathv2}/project/remove?{query}	Yes
getOptionsForContext(fieldId, contextId, optionId, onlyOptions, startAt, maxResults, callback)	Get custom field options (context)	{base_path}/{version}/field/{pathv1}/context/{pathv2}/option?{query}	Yes
updateCustomFieldOption(fieldId, contextId, body, callback)	Update custom field options (context)	{base_path}/{version}/field/{pathv1}/context/{pathv2}/option?{query}	Yes
createCustomFieldOption(fieldId, contextId, body, callback)	Create custom field options (context)	{base_path}/{version}/field/{pathv1}/context/{pathv2}/option?{query}	Yes
reorderCustomFieldOptions(fieldId, contextId, body, callback)	Reorder custom field options (context)	{base_path}/{version}/field/{pathv1}/context/{pathv2}/option/move?{query}	Yes
deleteCustomFieldOption(fieldId, contextId, optionId, callback)	Delete custom field options (context)	{base_path}/{version}/field/{pathv1}/context/{pathv2}/option/{pathv3}?{query}	Yes
getScreensForField(fieldId, startAt, maxResults, expand, callback)	Get screens for a field	{base_path}/{version}/field/{pathv1}/screens?{query}	Yes
createScreen(body, callback)	Create screen	{base_path}/{version}/screens?{query}	Yes
updateScreen(screenId, body, callback)	Update screen	{base_path}/{version}/screens/{pathv1}?{query}	Yes
deleteScreen(screenId, callback)	Delete screen	{base_path}/{version}/screens/{pathv1}?{query}	Yes
getAllFieldConfigurations(startAt, maxResults, id, isDefault, query, callback)	Get all field configurations	{base_path}/{version}/fieldconfiguration?{query}	Yes
createFieldConfiguration(body, callback)	Create field configuration	{base_path}/{version}/fieldconfiguration?{query}	Yes
updateFieldConfiguration(id, body, callback)	Update field configuration	{base_path}/{version}/fieldconfiguration/{pathv1}?{query}	Yes
deleteFieldConfiguration(id, callback)	Delete field configuration	{base_path}/{version}/fieldconfiguration/{pathv1}?{query}	Yes
getFieldConfigurationItems(id, startAt, maxResults, callback)	Get field configuration items	{base_path}/{version}/fieldconfiguration/{pathv1}/fields?{query}	Yes
updateFieldConfigurationItems(id, body, callback)	Update field configuration items	{base_path}/{version}/fieldconfiguration/{pathv1}/fields?{query}	Yes
getAllFieldConfigurationSchemes(startAt, maxResults, id, callback)	Get all field configuration schemes	{base_path}/{version}/fieldconfigurationscheme?{query}	Yes
createFieldConfigurationScheme(body, callback)	Create field configuration scheme	{base_path}/{version}/fieldconfigurationscheme?{query}	Yes
getFieldConfigurationSchemeMappings(startAt, maxResults, fieldConfigurationSchemeId, callback)	Get field configuration issue type items	{base_path}/{version}/fieldconfigurationscheme/mapping?{query}	Yes
getFieldConfigurationSchemeProjectMapping(startAt, maxResults, projectId, callback)	Get field configuration schemes for projects	{base_path}/{version}/fieldconfigurationscheme/project?{query}	Yes
assignFieldConfigurationSchemeToProject(body, callback)	Assign field configuration scheme to project	{base_path}/{version}/fieldconfigurationscheme/project?{query}	Yes
updateFieldConfigurationScheme(id, body, callback)	Update field configuration scheme	{base_path}/{version}/fieldconfigurationscheme/{pathv1}?{query}	Yes
deleteFieldConfigurationScheme(id, callback)	Delete field configuration scheme	{base_path}/{version}/fieldconfigurationscheme/{pathv1}?{query}	Yes
setFieldConfigurationSchemeMapping(id, body, callback)	Assign issue types to field configurations	{base_path}/{version}/fieldconfigurationscheme/{pathv1}/mapping?{query}	Yes
removeIssueTypesFromGlobalFieldConfigurationScheme(id, body, callback)	Remove issue types from field configuration scheme	{base_path}/{version}/fieldconfigurationscheme/{pathv1}/mapping/delete?{query}	Yes
bulkGetGroups(startAt, maxResults, groupId, groupName, callback)	Bulk get groups	{base_path}/{version}/group/bulk?{query}	Yes
getLicense(callback)	Get license	{base_path}/{version}/instance/license?{query}	Yes
bulkSetIssuesPropertiesList(body, callback)	Bulk set issues properties by list	{base_path}/{version}/issue/properties?{query}	Yes
bulkSetIssuePropertiesByIssue(body, callback)	Bulk set issue properties by issue	{base_path}/{version}/issue/properties/multi?{query}	Yes
getIsWatchingIssueBulk(body, callback)	Get is watching issue bulk	{base_path}/{version}/issue/watching?{query}	Yes
getIssueSecurityLevelMembers(issueSecuritySchemeId, startAt, maxResults, issueSecurityLevelId, expand, callback)	Get issue security level members	{base_path}/{version}/issuesecurityschemes/{pathv1}/members?{query}	Yes
getIssueTypesForProject(projectId, level, callback)	Get issue types for project	{base_path}/{version}/issuetype/project?{query}	Yes
getAllIssueTypeSchemes(startAt, maxResults, id, callback)	Get all issue type schemes	{base_path}/{version}/issuetypescheme?{query}	Yes
createIssueTypeScheme(body, callback)	Create issue type scheme	{base_path}/{version}/issuetypescheme?{query}	Yes
getIssueTypeSchemesMapping(startAt, maxResults, issueTypeSchemeId, callback)	Get issue type scheme items	{base_path}/{version}/issuetypescheme/mapping?{query}	Yes
getIssueTypeSchemeForProjects(startAt, maxResults, projectId, callback)	Get issue type schemes for projects	{base_path}/{version}/issuetypescheme/project?{query}	Yes
assignIssueTypeSchemeToProject(body, callback)	Assign issue type scheme to project	{base_path}/{version}/issuetypescheme/project?{query}	Yes
updateIssueTypeScheme(issueTypeSchemeId, body, callback)	Update issue type scheme	{base_path}/{version}/issuetypescheme/{pathv1}?{query}	Yes
deleteIssueTypeScheme(issueTypeSchemeId, callback)	Delete issue type scheme	{base_path}/{version}/issuetypescheme/{pathv1}?{query}	Yes
addIssueTypesToIssueTypeScheme(issueTypeSchemeId, body, callback)	Add issue types to issue type scheme	{base_path}/{version}/issuetypescheme/{pathv1}/issuetype?{query}	Yes
reorderIssueTypesInIssueTypeScheme(issueTypeSchemeId, body, callback)	Change order of issue types	{base_path}/{version}/issuetypescheme/{pathv1}/issuetype/move?{query}	Yes
removeIssueTypeFromIssueTypeScheme(issueTypeSchemeId, issueTypeId, callback)	Remove issue type from issue type scheme	{base_path}/{version}/issuetypescheme/{pathv1}/issuetype/{pathv2}?{query}	Yes
getIssueTypeScreenSchemes(startAt, maxResults, id, callback)	Get issue type screen schemes	{base_path}/{version}/issuetypescreenscheme?{query}	Yes
createIssueTypeScreenScheme(body, callback)	Create issue type screen scheme	{base_path}/{version}/issuetypescreenscheme?{query}	Yes
getIssueTypeScreenSchemeMappings(startAt, maxResults, issueTypeScreenSchemeId, callback)	Get issue type screen scheme items	{base_path}/{version}/issuetypescreenscheme/mapping?{query}	Yes
getIssueTypeScreenSchemeProjectAssociations(startAt, maxResults, projectId, callback)	Get issue type screen schemes for projects	{base_path}/{version}/issuetypescreenscheme/project?{query}	Yes
assignIssueTypeScreenSchemeToProject(body, callback)	Assign issue type screen scheme to project	{base_path}/{version}/issuetypescreenscheme/project?{query}	Yes
updateIssueTypeScreenScheme(issueTypeScreenSchemeId, body, callback)	Update issue type screen scheme	{base_path}/{version}/issuetypescreenscheme/{pathv1}?{query}	Yes
deleteIssueTypeScreenScheme(issueTypeScreenSchemeId, callback)	Delete issue type screen scheme	{base_path}/{version}/issuetypescreenscheme/{pathv1}?{query}	Yes
appendMappingsForIssueTypeScreenScheme(issueTypeScreenSchemeId, body, callback)	Append mappings to issue type screen scheme	{base_path}/{version}/issuetypescreenscheme/{pathv1}/mapping?{query}	Yes
updateDefaultScreenScheme(issueTypeScreenSchemeId, body, callback)	Update issue type screen scheme default screen scheme	{base_path}/{version}/issuetypescreenscheme/{pathv1}/mapping/default?{query}	Yes
removeMappingsFromIssueTypeScreenScheme(issueTypeScreenSchemeId, body, callback)	Remove mappings from issue type screen scheme	{base_path}/{version}/issuetypescreenscheme/{pathv1}/mapping/remove?{query}	Yes
getProjectsForIssueTypeScreenScheme(issueTypeScreenSchemeId, startAt, maxResults, callback)	Get issue type screen scheme projects	{base_path}/{version}/issuetypescreenscheme/{pathv1}/project?{query}	Yes
getAutoCompletePost(body, callback)	Get field reference data (POST)	{base_path}/{version}/jql/autocompletedata?{query}	Yes
parseJqlQueries(validation = 'strict', body, callback)	Parse JQL query	{base_path}/{version}/jql/parse?{query}	Yes
matchIssues(body, callback)	Check issues against JQL	{base_path}/{version}/jql/match?{query}	Yes
getAllLabels(startAt, maxResults, callback)	Get all labels	{base_path}/{version}/label?{query}	Yes
getRecent(expand, properties, callback)	Get recent projects	{base_path}/{version}/project/recent?{query}	Yes
archiveProject(projectIdOrKey, callback)	Archive project	{base_path}/{version}/project/{pathv1}/archive?{query}	Yes
deleteProjectAsynchronously(projectIdOrKey, callback)	Delete project asynchronously	{base_path}/{version}/project/{pathv1}/delete?{query}	Yes
restore(projectIdOrKey, callback)	Restore deleted project	{base_path}/{version}/project/{pathv1}/restore?{query}	Yes
getHierarchy(projectId, callback)	Get project issue type hierarchy	{base_path}/{version}/project/{pathv1}/hierarchy?{query}	Yes
getAllAccessibleProjectTypes(callback)	Get licensed project types	{base_path}/{version}/project/type/accessible?{query}	Yes
getFeaturesForProject(projectIdOrKey, callback)	Get project features	{base_path}/{version}/project/{pathv1}/features?{query}	Yes
toggleFeatureForProject(projectIdOrKey, featureKey, body, callback)	Set project feature state	{base_path}/{version}/project/{pathv1}/features/{pathv2}?{query}	Yes
getProjectEmail(projectId, callback)	Get project's sender email	{base_path}/{version}/project/{pathv1}/email?{query}	Yes
updateProjectEmail(projectId, body, callback)	Set project's sender email	{base_path}/{version}/project/{pathv1}/email?{query}	Yes
getScreenSchemes(startAt, maxResults, id, callback)	Get screen schemes	{base_path}/{version}/screenscheme?{query}	Yes
createScreenScheme(body, callback)	Create screen scheme	{base_path}/{version}/screenscheme?{query}	Yes
updateScreenScheme(screenSchemeId, body, callback)	Update screen scheme	{base_path}/{version}/screenscheme/{pathv1}?{query}	Yes
deleteScreenScheme(screenSchemeId, callback)	Delete screen scheme	{base_path}/{version}/screenscheme/{pathv1}?{query}	Yes
getAvatarImageByType(type = 'issuetype', size = 'xsmall', format = 'png', callback)	Get avatar image by type	{base_path}/{version}/universal_avatar/view/type/{pathv1}?{query}	Yes
getAvatarImageByID(type = 'issuetype', id, size = 'xsmall', format = 'png', callback)	Get avatar image by ID	{base_path}/{version}/universal_avatar/view/type/{pathv1}/avatar/{pathv2}?{query}	Yes
getAvatarImageByOwner(type = 'issuetype', entityId, size = 'xsmall', format = 'png', callback)	Get avatar image by owner	{base_path}/{version}/universal_avatar/view/type/{pathv1}/owner/{pathv2}?{query}	Yes
getUserEmail(accountId, callback)	Get user email	{base_path}/{version}/user/email?{query}	Yes
getUserEmailBulk(accountId, callback)	Get user email bulk	{base_path}/{version}/user/email/bulk?{query}	Yes
getAllUsersDefault(startAt, maxResults, callback)	Get all users default	{base_path}/{version}/users?{query}	Yes
getAllUsers(startAt, maxResults, callback)	Get all users	{base_path}/{version}/users/search?{query}	Yes
getDynamicWebhooksForApp(startAt, maxResults, callback)	Get dynamic webhooks for app	{base_path}/{version}/webhook?{query}	Yes
registerDynamicWebhooks(body, callback)	Register dynamic webhooks	{base_path}/{version}/webhook?{query}	Yes
deleteWebhookById(body, callback)	Delete webhooks by ID	{base_path}/{version}/webhook?{query}	Yes
getFailedWebhooks(maxResults, after, callback)	Get failed webhooks	{base_path}/{version}/webhook/failed?{query}	Yes
refreshWebhooks(body, callback)	Extend webhook life	{base_path}/{version}/webhook/refresh?{query}	Yes
createWorkflow(body, callback)	Create workflow	{base_path}/{version}/workflow?{query}	Yes
getWorkflowsPaginated(startAt, maxResults, workflowName, expand, queryString, orderBy = 'name', isActive, callback)	Get workflows paginated	{base_path}/{version}/workflow/search?{query}	Yes
deleteInactiveWorkflow(entityId, callback)	Delete inactive workflow	{base_path}/{version}/workflow/{pathv1}?{query}	Yes
getWorkflowTransitionRuleConfigurations(startAt, maxResults, types, keys, workflowNames, withTags, draft, expand, callback)	Get workflow transition rule configurations	{base_path}/{version}/workflow/rule/config?{query}	Yes
updateWorkflowTransitionRuleConfigurations(body, callback)	Update workflow transition rule configurations	{base_path}/{version}/workflow/rule/config?{query}	Yes
deleteWorkflowTransitionRuleConfigurations(body, callback)	Delete workflow transition rule configurations	{base_path}/{version}/workflow/rule/config/delete?{query}	Yes
getAllWorkflowSchemes(startAt, maxResults, callback)	Get all workflow schemes	{base_path}/{version}/workflowscheme?{query}	Yes
getWorkflowSchemeProjectAssociations(projectId, callback)	Get workflow scheme project associations	{base_path}/{version}/workflowscheme/project?{query}	Yes
assignSchemeToProject(body, callback)	Assign workflow scheme to project	{base_path}/{version}/workflowscheme/project?{query}	Yes
publishDraftWorkflowScheme(id, validateOnly, body, callback)	Publish draft workflow scheme	{base_path}/{version}/workflowscheme/{pathv1}/draft/publish?{query}	Yes
getBanner(callback)	Get announcement banner configuration	{base_path}/{version}/announcementBanner?{query}	Yes
setBanner(body, callback)	Update announcement banner configuration	{base_path}/{version}/announcementBanner?{query}	Yes
getAllAvailableDashboardGadgets(callback)	Get available gadgets	{base_path}/{version}/dashboard/gadgets?{query}	Yes
getAllGadgets(dashboardId, moduleKey, uri, gadgetId, callback)	Get gadgets	{base_path}/{version}/dashboard/{pathv1}/gadget?{query}	Yes
addGadget(dashboardId, body, callback)	Add gadget to dashboard	{base_path}/{version}/dashboard/{pathv1}/gadget?{query}	Yes
updateGadget(dashboardId, gadgetId, body, callback)	Update gadget on dashboard	{base_path}/{version}/dashboard/{pathv1}/gadget/{pathv2}?{query}	Yes
removeGadget(dashboardId, gadgetId, callback)	Remove gadget from dashboard	{base_path}/{version}/dashboard/{pathv1}/gadget/{pathv2}?{query}	Yes
getTrashedFieldsPaginated(startAt, maxResults, id, query, expand = 'name', orderBy, callback)	Get fields in trash paginated	{base_path}/{version}/field/search/trashed?{query}	Yes
changeFilterOwner(id, body, callback)	Change filter owner	{base_path}/{version}/filter/{pathv1}/owner?{query}	Yes
createIssueSecurityScheme(body, callback)	Create issue security scheme	{base_path}/{version}/issuesecurityschemes?{query}	Yes
getSecurityLevels(startAt, maxResults, id, schemeId, onlyDefault, callback)	Get issue security levels	{base_path}/{version}/issuesecurityschemes/level?{query}	Yes
setDefaultLevels(body, callback)	Set default issue security levels	{base_path}/{version}/issuesecurityschemes/level/default?{query}	Yes
getSecurityLevelMembers(startAt, maxResults, id, schemeId, levelId, expand, callback)	Get issue security level members	{base_path}/{version}/issuesecurityschemes/level/member?{query}	Yes
searchProjectsUsingSecuritySchemes(startAt, maxResults, issueSecuritySchemeId, projectId, callback)	Get projects using issue security schemes	{base_path}/{version}/issuesecurityschemes/project?{query}	Yes
searchSecuritySchemes(startAt, maxResults, id, projectId, callback)	Search issue security schemes	{base_path}/{version}/issuesecurityschemes/search?{query}	Yes
updateIssueSecurityScheme(id, body, callback)	Update issue security scheme	{base_path}/{version}/issuesecurityschemes/{pathv1}?{query}	Yes
deleteSecurityScheme(schemeId, callback)	Delete issue security scheme	{base_path}/{version}/issuesecurityschemes/{pathv1}?{query}	Yes
addSecurityLevel(schemeId, body, callback)	Add issue security levels	{base_path}/{version}/issuesecurityschemes/{pathv1}/level?{query}	Yes
updateSecurityLevel(schemeId, levelId, body, callback)	Update issue security level	{base_path}/{version}/issuesecurityschemes/{pathv1}/level/{pathv2}?{query}	Yes
removeLevel(schemeId, levelId, replaceWith, callback)	Remove issue security level	{base_path}/{version}/issuesecurityschemes/{pathv1}/level/{pathv2}?{query}	Yes
addSecurityLevelMembers(schemeId, levelId, body, callback)	Add issue security level members	{base_path}/{version}/issuesecurityschemes/{pathv1}/level/{pathv2}/member?{query}	Yes
removeMemberFromSecurityLevel(schemeId, levelId, memberId, callback)	Remove member from issue security level	{base_path}/{version}/issuesecurityschemes/{pathv1}/level/{pathv2}/member/{pathv3}?{query}	Yes
sanitiseJqlQueries(body, callback)	Sanitize JQL queries	{base_path}/{version}/jql/sanitize?{query}	Yes
getPrecomputations(functionKey, startAt, maxResults, orderBy, filter, callback)	Get precomputations (apps)	{base_path}/{version}/jql/function/computation?{query}	Yes
updatePrecomputations(body, callback)	Update precomputations (apps)	{base_path}/{version}/jql/function/computation?{query}	Yes
getApproximateLicenseCount(callback)	Get approximate license count	{base_path}/{version}/license/approximateLicenseCount?{query}	Yes
getApproximateApplicationLicenseCount(applicationKey, callback)	Get approximate application license count	{base_path}/{version}/license/approximateLicenseCount/product/{pathv1}?{query}	Yes
createNotificationScheme(body, callback)	Create notification scheme	{base_path}/{version}/notificationscheme?{query}	Yes
getNotificationSchemeToProjectMappings(startAt, maxResults, notificationSchemeId, projectId, callback)	Get projects using notification schemes paginated	{base_path}/{version}/notificationscheme/project?{query}	Yes
updateNotificationScheme(id, body, callback)	Update notification scheme	{base_path}/{version}/notificationscheme/{pathv1}?{query}	Yes
addNotifications(id, body, callback)	Add notifications to notification scheme	{base_path}/{version}/notificationscheme/{pathv1}/notification?{query}	Yes
deleteNotificationScheme(notificationSchemeId, callback)	Delete notification scheme	{base_path}/{version}/notificationscheme/{pathv1}?{query}	Yes
removeNotificationFromNotificationScheme(notificationSchemeId, notificationId, callback)	Remove notification from notification scheme	{base_path}/{version}/notificationscheme/{pathv1}/notification/{pathv2}?{query}	Yes
createPriority(body, callback)	Create priority	{base_path}/{version}/priority?{query}	Yes
setDefaultPriority(body, callback)	Set default priority	{base_path}/{version}/priority/default?{query}	Yes
movePriorities(body, callback)	Move priorities	{base_path}/{version}/priority/move?{query}	Yes
searchPriorities(startAt, maxResults, id, onlyDefault, callback)	Search priorities	{base_path}/{version}/priority/search?{query}	Yes
updatePriority(id, body, callback)	Update priority	{base_path}/{version}/priority/{pathv1}?{query}	Yes
deletePriority(id, replaceWith, callback)	Delete priority	{base_path}/{version}/priority/{pathv1}?{query}	Yes
createResolution(body, callback)	Create resolution	{base_path}/{version}/resolution?{query}	Yes
setDefaultResolution(body, callback)	Set default resolution	{base_path}/{version}/resolution/default?{query}	Yes
moveResolutions(body, callback)	Move resolutions	{base_path}/{version}/resolution/move?{query}	Yes
searchResolutions(startAt, maxResults, id, onlyDefault, callback)	Search resolutions	{base_path}/{version}/resolution/search?{query}	Yes
updateResolution(id, body, callback)	Update resolution	{base_path}/{version}/resolution/{pathv1}?{query}	Yes
deleteResolution(id, replaceWith, callback)	Delete resolution	{base_path}/{version}/resolution/{pathv1}?{query}	Yes
getStatusesById(expand, id, callback)	Bulk get statuses	{base_path}/{version}/statuses?{query}	Yes
updateStatuses(body, callback)	Bulk update statuses	{base_path}/{version}/statuses?{query}	Yes
createStatuses(body, callback)	Bulk create statuses	{base_path}/{version}/statuses?{query}	Yes
deleteStatusesById(id, callback)	Bulk delete Statuses	{base_path}/{version}/statuses?{query}	Yes
search(expand, projectId, startAt, maxResults, searchString, statusCategory, callback)	Search statuses paginated	{base_path}/{version}/statuses/search?{query}	Yes
getUiModifications(startAt, maxResults, expand, callback)	Get UI modifications	{base_path}/{version}/uiModifications?{query}	Yes
createUiModification(body, callback)	Create UI modification	{base_path}/{version}/uiModifications?{query}	Yes
updateUiModification(uiModificationId, body, callback)	Update UI modification	{base_path}/{version}/uiModifications/{pathv1}?{query}	Yes
deleteUiModification(uiModificationId, callback)	Delete UI modification	{base_path}/{version}/uiModifications/{pathv1}?{query}	Yes
addonPropertiesResourceGetAddonPropertiesGet(addonKey, callback)	Get app properties	/rest/atlassian-connect/1/addons/{pathv1}/properties?{query}	Yes
addonPropertiesResourceGetAddonPropertyGet(addonKey, propertyKey, callback)	Get app property	/rest/atlassian-connect/1/addons/{pathv1}/properties/{pathv2}?{query}	Yes
addonPropertiesResourcePutAddonPropertyPut(addonKey, propertyKey, body, callback)	Set app property	/rest/atlassian-connect/1/addons/{pathv1}/properties/{pathv2}?{query}	Yes
addonPropertiesResourceDeleteAddonPropertyDelete(addonKey, propertyKey, callback)	Delete app property	/rest/atlassian-connect/1/addons/{pathv1}/properties/{pathv2}?{query}	Yes
addonPropertiesResourcePutAppPropertyPut(propertyKey, body, callback)	Set app property (Forge)	/rest/forge/1/app/properties/{pathv1}?{query}	Yes
addonPropertiesResourceDeleteAppPropertyDelete(propertyKey, callback)	Delete app property (Forge)	/rest/forge/1/app/properties/{pathv1}?{query}	Yes
dynamicModulesResourceGetModulesGet(callback)	Get modules	/rest/atlassian-connect/1/app/module/dynamic?{query}	Yes
dynamicModulesResourceRegisterModulesPost(body, callback)	Register modules	/rest/atlassian-connect/1/app/module/dynamic?{query}	Yes
dynamicModulesResourceRemoveModulesDelete(moduleKey, callback)	Remove modules	/rest/atlassian-connect/1/app/module/dynamic?{query}	Yes
appIssueFieldValueUpdateResourceUpdateIssueFieldsPut(body, callback)	Bulk update custom field value	/rest/atlassian-connect/1/migration/field?{query}	Yes
migrationResourceUpdateEntityPropertiesValuePut(entityType = 'IssueProperty', body, callback)	Bulk update entity properties	/rest/atlassian-connect/1/migration/properties/{pathv1}?{query}	Yes
migrationResourceWorkflowRuleSearchPost(body, callback)	Get workflow transition rule configurations	/rest/atlassian-connect/1/migration/workflow/rule/search?{query}	Yes

Authentication

This document will go through the steps for authenticating the Atlassian Jira adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Basic Authentication

The Atlassian Jira adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.

STEPS

Ensure you have access to a Atlassian Jira server and that it is running
Follow the steps in the README.md to import the adapter into IAP if you have not already done so

Use the properties below for the properties.authentication field

"authentication": {
"auth_method": "basic user_password",
"username": "<username>",
"password": "<password>",
"auth_field": "header.headers.Authorization",
"auth_field_format": "Basic {b64}{username}:{password}{/b64}",
"auth_logging": false,
}

Restart the adapter. If your properties were set correctly, the adapter should go online.

Troubleshooting

Make sure you copied over the correct username and password.
Turn on debug level logs for the adapter in IAP Admin Essentials.
Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
Investigate the logs - in particular:
- The FULL REQUEST log to make sure the proper headers are being sent with the request.
- The FULL BODY log to make sure the payload is accurate.
- The CALL RETURN log to see what the other system is telling us.
Credentials should be masked by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
Remember when you are done to turn auth_logging off as you do not want to log credentials.

Additional Information

Enhancements

Adding a Second Instance of an Adapter

You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.

Adding Adapter Calls

There are multiple ways to add calls to an existing adapter.

The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update.

mv updatePackage.zip adapter-jira
cd adapter-jira
npm run adapter:update

If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.

If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.

Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test

Adding Adapter Properties

While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.

Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Changing Adapter Authentication

Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.

Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Enhancing Adapter Integration Tests

The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.

Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.

As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.

Contributing

First off, thanks for taking the time to contribute!

The following is a set of rules for contributing.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.

How to Contribute

Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

Helpful Links

Adapter Technical Resources

Node Scripts

There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.

Run	Description
npm run adapter:install	Provides an easier way to install the adapter.
npm run adapter:checkMigrate	Checks whether your adapter can and should be migrated to the latest foundation.
npm run adapter:findPath	Can be used to see if the adapter supports a particular API call.
npm run adapter:migrate	Provides an easier way to update your adapter after you download the migration zip from Itential DevSite.
npm run adapter:update	Provides an easier way to update your adapter after you download the update zip from Itential DevSite.
npm run adapter:revert	Allows you to revert after a migration or update if it resulted in issues.
npm run troubleshoot	Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.
npm run connectivity	Provides a connectivity check to the Servicenow system.
npm run healthcheck	Checks whether the configured healthcheck call works to Servicenow.
npm run basicget	Checks whether the basic get calls works to Servicenow.

Troubleshoot

Run npm run troubleshoot to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.

You also have the option to run individual commands to perform specific test:

npm run healthcheck will perform a healthcheck request of with current setting.
npm run basicget will perform some non-parameter GET request with current setting.
npm run connectivity will perform networking diagnostics of the adatper endpoint.

Connectivity Issues

You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.

npm run troubleshoot

Verify the adapter properties are set up correctly.

Go into the Itential Platform GUI and verify/update the properties

Verify there is connectivity between the Itential Platform Server and Jira Server.

ping the ip address of Jira server
try telnet to the ip address port of Jira
execute a curl command to the other system

Verify the credentials provided for Jira.

login to Jira using the provided credentials

Verify the API of the call utilized for Jira Healthcheck.

Go into the Itential Platform GUI and verify/update the properties

Functional Issues

Adapter logs are located in /var/log/pronghorn. In older releases of the Itential Platform, there is a pronghorn.log file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.

Filter

Sort By

Vendor

Product

Method

Category

Project Type

Adapter for Integration to Jira

Overview

Atlassian Jira

Table of Contents

Getting Started

Helpful Background Information

Prerequisites

How to Install

Testing

Unit Testing

Integration Testing - Standalone

Integration Testing

Configuration

Example Properties

Connection Properties

Authentication Properties

Examples of authentication field format

Healthcheck Properties

Request Properties

SSL Properties

Throttle Properties

Proxy Properties

Mongo Properties

Device Broker Properties

Using this Adapter

Generic Adapter Calls

Adapter Cache Calls

Adapter Broker Calls

Specific Adapter Calls

About notification schemes

Context variables

Advanced settings

Look and feel

Other settings

About permission schemes and grants

Holder

Permissions

About notification schemes

Context variables

Advanced settings

Look and feel

Other settings

About permission schemes and grants

Holder

Permissions

About notification schemes

Context variables

Advanced settings

Look and feel

Other settings

About permission schemes and grants

Holder

Permissions

About notification schemes

Context variables

Advanced settings

Look and feel

Other settings

About permission schemes and grants

Holder

Permissions

About notification schemes

Context variables

Advanced settings

Look and feel

Other settings

About permission schemes and grants

Holder

Permissions

About notification schemes

Context variables

Advanced settings

Look and feel