Function getApplicationProperty

getApplicationProperty(
    client: Client,
    parameters?: { key?: string; keyFilter?: string; permissionLevel?: string },
    options?: RequestOptions,
): Promise<
    {
        allowedValues?: string[];
        defaultValue?: string;
        desc?: string;
        example?: string;
        id?: string;
        key?: string;
        name?: string;
        type?: string;
        value?: string;
        [key: string]: unknown;
    }[],
>
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
- client: Client
- Optionalparameters: { key?: string; keyFilter?: string; permissionLevel?: string }
  - Optionalkey?: string
    
    The key of the application property.
  - OptionalkeyFilter?: 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..
  - OptionalpermissionLevel?: string
    
    The permission level of all items being returned in the list.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        allowedValues?: string[];
        defaultValue?: string;
        desc?: string;
        example?: string;
        id?: string;
        key?: string;
        name?: string;
        type?: string;
        value?: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/cloud/api/jiraSettings.ts:19

Function getApplicationProperty

Parameters

`Optional`key?: string

`Optional`keyFilter?: string

`Optional`permissionLevel?: string

Returns Promise<
    {
        allowedValues?: string[];
        defaultValue?: string;
        desc?: string;
        example?: string;
        id?: string;
        key?: string;
        name?: string;
        type?: string;
        value?: string;
        [key: string]: unknown;
    }[],
>

Settings

Function getApplicationProperty

Parameters

Optionalkey?: string

OptionalkeyFilter?: string

OptionalpermissionLevel?: string

Returns Promise< { allowedValues?: string[]; defaultValue?: string; desc?: string; example?: string; id?: string; key?: string; name?: string; type?: string; value?: string; [key: string]: unknown; }[],>

Settings

`Optional`key?: string

`Optional`keyFilter?: string

`Optional`permissionLevel?: string

Returns Promise<
{
allowedValues?: string[];
defaultValue?: string;
desc?: string;
example?: string;
id?: string;
key?: string;
name?: string;
type?: string;
value?: string;
[key: string]: unknown;
}[],
>