Class: ApplicationPropertiesClient

ApplicationPropertiesClient(jiraClient)

new ApplicationPropertiesClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/application-properties'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

getProperties(optsopt, callbackopt) → {Promise}

Gets an application property.

Parameters:
Name Type Attributes Description
opts Object <optional>

The options used to make the request.

Properties
Name Type Attributes Description
key string <optional>

A String containing the property key.
permissionLevel string <optional>

When fetching a list specifies the permission level of all items in the list.
keyFilter string <optional>

When fetching a list allows the list to be filtered by the property's start of key e.g. "jira.lf.*" whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This is a regex
callback callback <optional>

Called when the properties are retrieved.
Source:
Returns:

Resolved when the properties are retrieved.

Type
Promise

getProperties(opts, callbackopt) → {Promise}

Modify an application property via PUT. The "value" field present in the PUT will override thee existing value.

Parameters:
Name Type Attributes Description
opts Object

The options for modifying the application property.

Properties
Name Type Description
id

The id of the property to be modified
property

The new data for the property. See https://docs.atlassian.com/jira/REST/latest/#d2e4891
callback <optional>

Called when the property has been modified
Source:
Returns:

Resolved when the property has been modified

Type
Promise