Skip to content

Latest commit

 

History

History
129 lines (71 loc) · 9.83 KB

JiraSettingsApi.md

File metadata and controls

129 lines (71 loc) · 9.83 KB

\JiraSettingsApi

All URIs are relative to https://your-domain.atlassian.net

Method HTTP request Description
get_advanced_settings GET /rest/api/2/application-properties/advanced-settings Get advanced settings
get_application_property GET /rest/api/2/application-properties Get application property
get_configuration GET /rest/api/2/configuration Get global settings
set_application_property PUT /rest/api/2/application-properties/{id} Set application property

get_advanced_settings

Veccrate::models::ApplicationProperty get_advanced_settings() Get advanced settings

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.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::ApplicationProperty

Authorization

OAuth2, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_application_property

Veccrate::models::ApplicationProperty get_application_property(key, permission_level, key_filter) Get application property

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

Name Type Description Required Notes
key Option<String> The key of the application property.
permission_level Option<String> The permission level of all items being returned in the list.
key_filter Option<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..

Return type

Veccrate::models::ApplicationProperty

Authorization

OAuth2, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_configuration

crate::models::Configuration get_configuration() Get global settings

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. This operation can be accessed anonymously. Permissions required: None.

Parameters

This endpoint does not need any parameter.

Return type

crate::models::Configuration

Authorization

OAuth2, basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

set_application_property

crate::models::ApplicationProperty set_application_property(id, simple_application_property_bean) Set application property

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.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 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. | h:mm a | | jira.lf.date.day | The day format. | EEEE h:mm a | | jira.lf.date.complete | The date and time format. | dd/MMM/yy h:mm a | | jira.lf.date.dmy | 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.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

Name Type Description Required Notes
id String The key of the application property to update. [required]
simple_application_property_bean SimpleApplicationPropertyBean [required]

Return type

crate::models::ApplicationProperty

Authorization

OAuth2, basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]