Package io.camunda.optimize.rest

Class DashboardRestService

java.lang.Object

io.camunda.optimize.rest.DashboardRestService

@Validated
@RestController
@RequestMapping("/api/dashboard")
public class DashboardRestService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DASHBOARD_PATH
static final String	INSTANT_PREVIEW_PATH

Constructor Summary

Constructors

Constructor	Description
DashboardRestService(DashboardService dashboardService, InstantPreviewDashboardService instantPreviewDashboardService, SessionService sessionService, DashboardRestMapper dashboardRestMapper)

Method Summary

Modifier and Type	Method	Description
IdResponseDto	copyDashboard(String dashboardId, String collectionId, String newDashboardName, jakarta.servlet.http.HttpServletRequest request)
IdResponseDto	createNewDashboard(@Valid DashboardDefinitionRestDto dashboardDefinitionDto, jakarta.servlet.http.HttpServletRequest request)
void	deleteDashboard(String dashboardId, jakarta.servlet.http.HttpServletRequest request)
AuthorizedDashboardDefinitionResponseDto	getDashboard(String dashboardId, jakarta.servlet.http.HttpServletRequest request)
AuthorizedDashboardDefinitionResponseDto	getInstantDashboard(String processDefinitionKey, String dashboardJsonTemplateFilename, jakarta.servlet.http.HttpServletRequest request)
AuthorizedDashboardDefinitionResponseDto	getManagementDashboard(jakarta.servlet.http.HttpServletRequest request)
void	updateDashboard(String dashboardId, @Valid DashboardDefinitionRestDto updatedDashboard, jakarta.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Details

DASHBOARD_PATH

public static final String DASHBOARD_PATH

See Also:

• Constant Field Values

INSTANT_PREVIEW_PATH

public static final String INSTANT_PREVIEW_PATH

See Also:

• Constant Field Values

Constructor Details

DashboardRestService

public DashboardRestService(DashboardService dashboardService,
 InstantPreviewDashboardService instantPreviewDashboardService,
 SessionService sessionService,
 DashboardRestMapper dashboardRestMapper)

Method Details

createNewDashboard

@PostMapping
public IdResponseDto createNewDashboard(@Valid @RequestBody
 @Valid DashboardDefinitionRestDto dashboardDefinitionDto,
 jakarta.servlet.http.HttpServletRequest request)

copyDashboard

@PostMapping(path="/{id}/copy")
public IdResponseDto copyDashboard(@PathVariable("id")
 String dashboardId,
 @RequestParam(name="collectionId",required=false)
 String collectionId,
 @RequestParam(name="name",required=false)
 String newDashboardName,
 jakarta.servlet.http.HttpServletRequest request)

getDashboard

@GetMapping(path="/{id}")
public AuthorizedDashboardDefinitionResponseDto getDashboard(@PathVariable(name="id")
 String dashboardId,
 jakarta.servlet.http.HttpServletRequest request)

getInstantDashboard

@GetMapping(path="/instant/{procDefKey}")
public AuthorizedDashboardDefinitionResponseDto getInstantDashboard(@PathVariable("procDefKey")
 String processDefinitionKey,
 @RequestParam(name="template",required=false)
 String dashboardJsonTemplateFilename,
 jakarta.servlet.http.HttpServletRequest request)

getManagementDashboard

@GetMapping(path="/management")
public AuthorizedDashboardDefinitionResponseDto getManagementDashboard(jakarta.servlet.http.HttpServletRequest request)

updateDashboard

@PutMapping(path="/{id}")
public void updateDashboard(@PathVariable("id")
 String dashboardId,
 @Valid @RequestBody
 @Valid DashboardDefinitionRestDto updatedDashboard,
 jakarta.servlet.http.HttpServletRequest request)

deleteDashboard

@DeleteMapping(path="/{id}")
public void deleteDashboard(@PathVariable("id")
 String dashboardId,
 jakarta.servlet.http.HttpServletRequest request)