Package com.atlassian.jira.rest.v1.labels

Class IssueLabelsResource

java.lang.Object

com.atlassian.jira.rest.v1.labels.IssueLabelsResource

@Path("labels")
@Consumes({"application/json","application/xml","application/x-www-form-urlencoded"})
@Produces({"application/json","application/xml"})
public class IssueLabelsResource
extends Object

REST resource to interact with the labels for an issue.

Since:

v4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IssueLabelsResource.LabelListStruct
static class	IssueLabelsResource.LabelStruct
static class	IssueLabelsResource.SuggestionListStruct
static class	IssueLabelsResource.SuggestionStruct

Constructor Summary

Constructors

Constructor	Description
IssueLabelsResource(JiraAuthenticationContext jiraAuthenticationContext, LabelService labelService, I18nHelper i18nHelper, ApplicationProperties applicationProperties, XsrfInvocationChecker xsrfChecker)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getLabels(Long issueId, Long customFieldId)
jakarta.ws.rs.core.Response	getSuggestions(Long issueId, Long customFieldId, String token)
jakarta.ws.rs.core.Response	getSuggestions(Long customFieldId, String token)
jakarta.ws.rs.core.Response	setLabels(Long issueId, Long customFieldId, String concatenatedLabels)

Methods inherited from class java.lang.Object

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

Constructor Details

IssueLabelsResource

@Inject
public IssueLabelsResource(JiraAuthenticationContext jiraAuthenticationContext,
 LabelService labelService,
 I18nHelper i18nHelper,
 ApplicationProperties applicationProperties,
 XsrfInvocationChecker xsrfChecker)

Method Details

getLabels

@GET
@Path("{issueId}")
public jakarta.ws.rs.core.Response getLabels(@PathParam("issueId")
 Long issueId,
 @QueryParam("customFieldId")
 Long customFieldId)

getSuggestions

@GET
@Path("suggest")
public jakarta.ws.rs.core.Response getSuggestions(@QueryParam("customFieldId")
 Long customFieldId,
 @QueryParam("query")
 String token)

getSuggestions

@GET
@Path("{issueId}/suggest")
public jakarta.ws.rs.core.Response getSuggestions(@PathParam("issueId")
 Long issueId,
 @QueryParam("customFieldId")
 Long customFieldId,
 @QueryParam("query")
 String token)

setLabels

@POST
@Path("{issueId}")
public jakarta.ws.rs.core.Response setLabels(@PathParam("issueId")
 Long issueId,
 @QueryParam("customFieldId")
 Long customFieldId,
 @FormParam("labels")
 String concatenatedLabels)