Function: getApplicationProperty()

function getApplicationProperty(
   client, 
   parameters?, 
   options?
): Promise<object[]>;

Defined in: src/cloud/api/jiraSettings.ts:19

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.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ key?: string; keyFilter?: string; permissionLevel?: string; }	-
parameters.key?	string	The key of the application property.
parameters.keyFilter?	string	When a key isn't provided, this filters the list of results by the application property key using a regular expression. For example, using jira.lf.* will return all application properties with keys that start with jira.lf..
parameters.permissionLevel?	string	The permission level of all items being returned in the list.
options?	RequestOptions	-

Returns

Promise<object[]>