Class JiraSettingsService

This resource represents various settings in Jira. Use it to get and update Jira settings and properties.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings

Hierarchy

  • CommonHttpService
    • JiraSettingsService

Constructors

constructor

Methods

getAdvancedSettings getApplicationProperty getConfiguration setApplicationProperty initialize

Constructors

constructor

  • new JiraSettingsService(getClientInstance): JiraSettingsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns JiraSettingsService

Methods

getAdvancedSettings

  • getAdvancedSettings(): Promise<ApplicationProperty[]>

  • 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.

    Returns Promise<ApplicationProperty[]>

    Returned if the request is successful.

    example:

    [
      {
        "defaultValue": "",
        "desc": "Jira home directory",
        "id": "jira.home",
        "key": "jira.home",
        "name": "jira.home",
        "type": "string",
        "value": "/var/jira/jira-home"
      },
      {
        "defaultValue": "CLONE -",
        "id": "jira.clone.prefix",
        "key": "jira.clone.prefix",
        "name": "The prefix added to the Summary field of cloned issues",
        "type": "string",
        "value": "CLONE -"
      }
    ]

    Path

    GET /rest/api/3/application-properties/advanced-settings @scopes-current manage:jira-configuration @scopes-beta read:instance-configuration:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings#api-rest-api-3-application-properties-advanced-settings-get

getApplicationProperty

  • getApplicationProperty(params?): Promise<ApplicationProperty[]>

  • 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

    • params: {
          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.

    Returns Promise<ApplicationProperty[]>

    Returned if the request is successful.

    example:

    [
      {
        "defaultValue": "",
        "desc": "Jira home directory",
        "id": "jira.home",
        "key": "jira.home",
        "name": "jira.home",
        "type": "string",
        "value": "/var/jira/jira-home"
      },
      {
        "defaultValue": "CLONE -",
        "id": "jira.clone.prefix",
        "key": "jira.clone.prefix",
        "name": "The prefix added to the Summary field of cloned issues",
        "type": "string",
        "value": "CLONE -"
      }
    ]

    Path

    GET /rest/api/3/application-properties @scopes-current manage:jira-configuration @scopes-beta read:instance-configuration:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings#api-rest-api-3-application-properties-get

getConfiguration

  • getConfiguration(): Promise<Configuration>

  • Returns the global settings 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.

    Returns Promise<Configuration>

    Returned if the request is successful.

    example:

    {
      "attachmentsEnabled": true,
      "issueLinkingEnabled": true,
      "subTasksEnabled": false,
      "timeTrackingConfiguration": {
        "defaultUnit": "day",
        "timeFormat": "pretty",
        "workingDaysPerWeek": 5,
        "workingHoursPerDay": 8
      },
      "timeTrackingEnabled": true,
      "unassignedIssuesAllowed": false,
      "votingEnabled": true,
      "watchingEnabled": true
    }

    Path

    GET /rest/api/3/configuration @scopes-current read:jira-user @scopes-beta read:instance-configuration:jira, read:issue.time-tracking:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings#api-rest-api-3-configuration-get

setApplicationProperty

  • setApplicationProperty(params): Promise<ApplicationProperty>

  • 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 The string of text prefixed to 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 The date format 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 The date format 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.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
    feature. 7

    Look and feel

    The settings listed below adjust the look and feel.

    Key Description Default value
    jira.lf.date.time The [ time
    format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
    h:mm a
    jira.lf.date.day The [ day
    format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
    EEEE h:mm a
    jira.lf.date.complete The [ date and time
    format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
    dd/MMM/yy h:mm a
    jira.lf.date.dmy The [ date
    format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html).
    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.navigation.bgcolour The background color of the sidebar.
    #0747A6
    jira.lf.navigation.highlightcolour The color of the text and logo of the
    sidebar. #DEEBFF
    jira.lf.hero.button.base.bg.colour The background color of the hero
    button. #3b7fc4
    jira.title The text for the application title. The application title can
    also be set in General settings. Jira
    jira.option.globalsharing Whether filters and dashboards can be shared
    with anyone signed into Jira. true
    xflow.product.suggestions.enabled Whether to expose product suggestions
    for other Atlassian products within Jira. true

    Other settings

    Key Description Default value
    jira.issuenav.criteria.autoupdate Whether instant updates to search
    criteria is active. true

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

    Permissions required: Administer Jira global permission.

    Parameters

    Returns Promise<ApplicationProperty>

    Returned if the request is successful.

    Path

    PUT /rest/api/3/application-properties/{id} @scopes-current manage:jira-configuration @scopes-beta write:instance-configuration:jira, read:instance-configuration:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings#api-rest-api-3-application-properties-id-put

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods