Package com.atlassian.jira.rest.v2.admin

Class SettingsResource

java.lang.Object

com.atlassian.jira.rest.v2.admin.SettingsResource

@Path("settings")
@Consumes("application/json")
@Produces("application/json")
public class SettingsResource
extends Object

REST resource for changing the Jira system settings

Since:

v5.0.3

Constructor Summary

Constructors

Constructor	Description
SettingsResource(ApplicationProperties applicationProperties, ColumnService columnService, JiraAuthenticationContext jiraAuthenticationContext, GlobalPermissionManager globalPermissionManager, I18nHelper i18n)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getIssueNavigatorDefaultColumns()	Returns the default system columns for issue navigator.
void	setBaseURL(String baseURL)	Sets the base URL that is configured for this Jira instance.
jakarta.ws.rs.core.Response	setIssueNavigatorDefaultColumns(ColumnsBean columns)	Sets the default system columns for issue navigator.
jakarta.ws.rs.core.Response	setIssueNavigatorDefaultColumnsForm(List<String> fields)	Sets the default system columns for issue navigator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SettingsResource

@Inject
public SettingsResource(ApplicationProperties applicationProperties,
 ColumnService columnService,
 JiraAuthenticationContext jiraAuthenticationContext,
 GlobalPermissionManager globalPermissionManager,
 I18nHelper i18n)

Method Details

getIssueNavigatorDefaultColumns

@GET
@Path("columns")
public jakarta.ws.rs.core.Response getIssueNavigatorDefaultColumns()

Returns the default system columns for issue navigator. Admin permission will be required.

Returns:

column configuration

Since:

v6.1

setIssueNavigatorDefaultColumnsForm

@PUT
@Path("columns")
@Consumes("application/x-www-form-urlencoded")
public jakarta.ws.rs.core.Response setIssueNavigatorDefaultColumnsForm(@FormParam("columns")
 List<String> fields)

Sets the default system columns for issue navigator. Admin permission will be required.

Parameters:

fields - list of column ids

Returns:

jakarta.ws.rs.core.Response containing basic message and http return code

Since:

v6.1

setIssueNavigatorDefaultColumns

@PUT
@Path("columns")
@Consumes("application/json")
public jakarta.ws.rs.core.Response setIssueNavigatorDefaultColumns(ColumnsBean columns)

Sets the default system columns for issue navigator. Admin permission will be required.

Parameters:

columns - list of column ids

Returns:

jakarta.ws.rs.core.Response containing basic message and http return code

Since:

v6.1

setBaseURL

@PUT
@Path("baseUrl")
public void setBaseURL(String baseURL)

Sets the base URL that is configured for this Jira instance.

Parameters:

baseURL - a String containing the base URL that will be set for this Jira instance