Package com.atlassian.jira.rest.v1.menus

Class MenuResource

java.lang.Object

com.atlassian.jira.rest.v1.menus.MenuResource

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

REST endpoint to get a list of Sections and links for a menu. This uses SimpleLinkManager to generate list of links.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MenuResource.Link
static class	MenuResource.Menu
static class	MenuResource.Section

Constructor Summary

Constructors

Constructor	Description
MenuResource(SimpleLinkManager simpleLinkManager, JiraAuthenticationContext authenticationContext, UserProjectHistoryManager userProjectHistoryManager)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getMenuList(jakarta.servlet.http.HttpServletRequest request, String location, Boolean inAdminMode)	Gets a list of MenuResource.Section and sub links MenuResource.Link for a menu.

Methods inherited from class java.lang.Object

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

Constructor Details

MenuResource

@Inject
public MenuResource(SimpleLinkManager simpleLinkManager,
 JiraAuthenticationContext authenticationContext,
 UserProjectHistoryManager userProjectHistoryManager)

Method Details

getMenuList

@GET
@Path("{location}")
public jakarta.ws.rs.core.Response getMenuList(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @PathParam("location")
 String location,
 @QueryParam("inAdminMode")
 Boolean inAdminMode)

Gets a list of MenuResource.Section and sub links MenuResource.Link for a menu. These are wrapped in a MenuResource.Menu

Parameters:

request - The request for the resource

location - The location that the menu is retreiving for.

Returns:

a list of MenuResource.Section and sub links MenuResource.Link for a menu. These are wrapped in a MenuResource.Menu