com.atlassian.jira.rest.v2.i18n.terminology

Class TerminologyResource

java.lang.Object

com.atlassian.jira.rest.v2.i18n.terminology.TerminologyResource

public final class TerminologyResource
extends Object

Enables customizing the default words "epic" and "sprint".

Since:

v8.14

Field Summary

Fields

Modifier and Type	Field and Description
static javax.ws.rs.core.CacheControl	CACHE_CONTROL_NEVER

Constructor Summary

Constructors

Constructor and Description
TerminologyResource(TerminologyEntryReader terminologyEntryReader, TerminologyEntryWriter terminologyEntryWriter, FeatureManager featureManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllTerminologyEntries() Returns the list of all defined names for the default words "epic" and "sprint".
javax.ws.rs.core.Response	getTerminologyEntry(String originalName) Returns epic or sprint name as specified in the {originalName} path param.
javax.ws.rs.core.Response	setTerminologyEntries(Collection<TerminologyRequestBean> terminologyRequestBeans) Change epic/sprint names from {"originalName"} to {"newName"}.

Methods inherited from class java.lang.Object

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

Field Detail

CACHE_CONTROL_NEVER

public static final javax.ws.rs.core.CacheControl CACHE_CONTROL_NEVER

Constructor Detail

TerminologyResource

public TerminologyResource(TerminologyEntryReader terminologyEntryReader,
                           TerminologyEntryWriter terminologyEntryWriter,
                           FeatureManager featureManager)

Method Detail

getAllTerminologyEntries

@ExperimentalApi
public javax.ws.rs.core.Response getAllTerminologyEntries()

Returns the list of all defined names for the default words "epic" and "sprint".

Returns:

Returns the list of all defined names for the default words "epic" and "sprint".

Since:

v8.14

getTerminologyEntry

@ExperimentalApi
public javax.ws.rs.core.Response getTerminologyEntry(String originalName)

Returns epic or sprint name as specified in the {originalName} path param.

Returns:

Returns epic or sprint name.

Since:

v8.14

setTerminologyEntries

@ExperimentalApi
public javax.ws.rs.core.Response setTerminologyEntries(Collection<TerminologyRequestBean> terminologyRequestBeans)

Change epic/sprint names from {"originalName"} to {"newName"}. The {"newName"} will be displayed in Jira instead of {"originalName"}.

{"originalName"} must be equal to "epic" or "sprint". There can be only one entry per unique {"originalName"}.

{"newName"} can only consist of alphanumeric characters and spaces e.g. {"newName": "iteration number 2"}.

{"newName"} must be between 1 to 100 characters. It can't use the already defined {"newName"} values or restricted JQL words .

To reset {"newName"} to the default value, enter the {"originalName"} value as the value for {"newName"}. For example, if you want to return to {"originalName": "sprint"}, enter {"newName": "sprint"}.

Since:

v8.15