Package com.atlassian.jira.rest.v2.issue

Class ScreensResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.ScreensResource

@Path("screens")
@Consumes("application/json")
@Produces("application/json")
public class ScreensResource
extends Object

Since:

v5.2

Constructor Summary

Constructors

Constructor

Description

ScreensResource(FieldScreenManager fieldScreenManager, FieldManager fieldManager, JiraAuthenticationContext jiraAuthenticationContext, PermissionManager permissionManager, CustomFieldService customFieldService, ProjectManager projectManager, FieldScreenService fieldScreenService, AccessDisablingHelper accessDisablingHelper, XsrfInvocationChecker xsrfInvocationChecker, com.atlassian.plugins.rest.api.internal.expand.resolver.SelfExpandingEntityExpanderResolver selfExpandingEntityExpanderResolver, com.atlassian.plugins.rest.api.expand.EntityCrawler entityCrawler)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addField(Long screenId, Long tabId, AddFieldBean field)	Adds field to the given tab.
jakarta.ws.rs.core.Response	addFieldToDefaultScreen(String fieldId)	Adds field or custom field to the default tab
jakarta.ws.rs.core.Response	addTab(Long screenId, ScreenableTabBean tab)	Creates tab for given screen
jakarta.ws.rs.core.Response	deleteTab(Long screenId, Long tabId)	Deletes tab to give screen
jakarta.ws.rs.core.Response	getAllFields(Long screenId, Long tabId, String projectKey)	Gets all fields for a given tab
jakarta.ws.rs.core.Response	getAllScreens(String startAt, String maxResults, String expand, String searchQuery)	Gets available field screens
jakarta.ws.rs.core.Response	getAllTabs(Long screenId, String projectKey)	Returns a list of all tabs for the given screen
jakarta.ws.rs.core.Response	getFieldsToAdd(Long screenId)	Gets available fields for screen.
jakarta.ws.rs.core.Response	moveField(Long screenId, Long tabId, String id, MoveFieldBean moveField)	Moves field on the given tab
jakarta.ws.rs.core.Response	moveTab(Long screenId, Long tabId, Integer pos)	Moves tab position
jakarta.ws.rs.core.Response	removeField(Long screenId, Long tabId, String id)	Removes field from given tab
jakarta.ws.rs.core.Response	renameTab(Long screenId, Long tabId, ScreenableTabBean tab)	Renames tab on given screen
jakarta.ws.rs.core.Response	updateShowWhenEmptyIndicator(Long screenId, Long tabId, String fieldId, boolean newValue)	Update 'showWhenEmptyIndicator' for given field on screen

Methods inherited from class java.lang.Object

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

Constructor Details

ScreensResource

@Inject
public ScreensResource(FieldScreenManager fieldScreenManager,
 FieldManager fieldManager,
 JiraAuthenticationContext jiraAuthenticationContext,
 PermissionManager permissionManager,
 CustomFieldService customFieldService,
 ProjectManager projectManager,
 FieldScreenService fieldScreenService,
 AccessDisablingHelper accessDisablingHelper,
 XsrfInvocationChecker xsrfInvocationChecker,
 com.atlassian.plugins.rest.api.internal.expand.resolver.SelfExpandingEntityExpanderResolver selfExpandingEntityExpanderResolver,
 com.atlassian.plugins.rest.api.expand.EntityCrawler entityCrawler)

Method Details

getAllTabs

@GET
@Path("{screenId}/tabs")
public jakarta.ws.rs.core.Response getAllTabs(@PathParam("screenId")
 Long screenId,
 @QueryParam("projectKey")
 String projectKey)

Returns a list of all tabs for the given screen

Parameters:

screenId - id of screen

projectKey - the key of the project; this parameter is optional

Returns:

a response containing all tabs for screen

addTab

@POST
@Path("{screenId}/tabs")
public jakarta.ws.rs.core.Response addTab(@PathParam("screenId")
 Long screenId,
 ScreenableTabBean tab)

Creates tab for given screen

Parameters:

screenId - id of screen

Returns:

a response containing newly created tab

renameTab

@PUT
@Path("{screenId}/tabs/{tabId}")
public jakarta.ws.rs.core.Response renameTab(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 ScreenableTabBean tab)

Renames tab on given screen

Parameters:

screenId - id of screen

Returns:

a response containing renamed tab

deleteTab

@DELETE
@Path("{screenId}/tabs/{tabId}")
public jakarta.ws.rs.core.Response deleteTab(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId)

Deletes tab to give screen

Parameters:

screenId - id of screen

tabId - id of tab

Returns:

A response containing no content

moveTab

@POST
@Path("{screenId}/tabs/{tabId}/move/{pos}")
public jakarta.ws.rs.core.Response moveTab(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 @PathParam("pos")
 Integer pos)

Moves tab position

Parameters:

screenId - id of screen

tabId - id of tab

pos - position of tab

Returns:

A response containing no content

getAllFields

@GET
@Path("{screenId}/tabs/{tabId}/fields")
public jakarta.ws.rs.core.Response getAllFields(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 @QueryParam("projectKey")
 String projectKey)

Gets all fields for a given tab

Parameters:

screenId - id of screen

tabId - id of tab

projectKey - the key of the project; this parameter is optional

Returns:

a response containing all fields for given tab

updateShowWhenEmptyIndicator

@PUT
@Path("{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}")
public jakarta.ws.rs.core.Response updateShowWhenEmptyIndicator(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 @PathParam("id")
 String fieldId,
 @PathParam("newValue")
 boolean newValue)

Update 'showWhenEmptyIndicator' for given field on screen

Parameters:

screenId - id of screen

tabId - id of tab

fieldId - id of field

newValue - new value of 'showWhenEmptyIndicator'

getFieldsToAdd

@GET
@Path("{screenId}/availableFields")
public jakarta.ws.rs.core.Response getFieldsToAdd(@PathParam("screenId")
 Long screenId)

Gets available fields for screen. i.e ones that haven't already been added.

Parameters:

screenId - id of screen

Returns:

a response containing available fields

removeField

@DELETE
@Path("{screenId}/tabs/{tabId}/fields/{id}")
public jakarta.ws.rs.core.Response removeField(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 @PathParam("id")
 String id)

Removes field from given tab

Parameters:

screenId - id of screen

tabId - id of tab

Returns:

no content

moveField

@POST
@Path("{screenId}/tabs/{tabId}/fields/{id}/move")
public jakarta.ws.rs.core.Response moveField(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 @PathParam("id")
 String id,
 MoveFieldBean moveField)

Moves field on the given tab

Parameters:

screenId - id of screen

tabId - id of tab

Returns:

no content

addField

@POST
@Path("{screenId}/tabs/{tabId}/fields")
public jakarta.ws.rs.core.Response addField(@PathParam("screenId")
 Long screenId,
 @PathParam("tabId")
 Long tabId,
 AddFieldBean field)

Adds field to the given tab.

Parameters:

screenId - id of screen

tabId - id of tab

Returns:

no content

addFieldToDefaultScreen

@POST
@Path("addToDefault/{fieldId}")
public jakarta.ws.rs.core.Response addFieldToDefaultScreen(@PathParam("fieldId")
 String fieldId)

Adds field or custom field to the default tab

Parameters:

fieldId - id of field / custom field

Returns:

no content

getAllScreens

@GET
public jakarta.ws.rs.core.Response getAllScreens(@QueryParam("startAt")
 String startAt,
 @QueryParam("maxResults")
 String maxResults,
 @QueryParam("expand")
 String expand,
 @QueryParam("search")
 String searchQuery)

Gets available field screens

Parameters:

startAt - offset from which the response starts

maxResults - amount of field screens to return

Returns:

a response containing either list of field screens, or paginated list of field screens