Package io.camunda.optimize.rest

Class SharingRestService

java.lang.Object

io.camunda.optimize.rest.SharingRestService

@Validated
@RestController
@RequestMapping("/api/share")
public class SharingRestService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DASHBOARD_SUB_PATH
static final String	EVALUATE_SUB_PATH
static final String	REPORT_SUB_PATH
static final String	SHARE_PATH

Constructor Summary

Constructors

Constructor	Description
SharingRestService(SharingService sharingService, SettingsService settingsService, SessionService sessionService, ReportRestMapper reportRestMapper, DashboardRestMapper dashboardRestMapper, EventReportingService eventReportingService, org.springframework.core.env.Environment environment)

Method Summary

Modifier and Type	Method	Description
ShareSearchResultResponseDto	checkShareStatus(ShareSearchRequestDto searchRequest)
IdResponseDto	createNewDashboardShare(DashboardShareRestDto createSharingDto, jakarta.servlet.http.HttpServletRequest request)
IdResponseDto	createNewReportShare(ReportShareRestDto createSharingDto, jakarta.servlet.http.HttpServletRequest request)
void	deleteDashboardShare(String dashboardShareId)
void	deleteReportShare(String reportShareId)
DashboardDefinitionRestDto	evaluateDashboard(String dashboardShareId, jakarta.servlet.http.HttpServletRequest request)
AuthorizedReportEvaluationResponseDto	evaluateReport(String reportShareId, @Valid PaginationRequestDto paginationRequestDto, jakarta.servlet.http.HttpServletRequest request)
AuthorizedReportEvaluationResponseDto	evaluateReport(String dashboardShareId, String reportId, AdditionalProcessReportEvaluationFilterDto reportEvaluationFilter, @Valid PaginationRequestDto paginationRequestDto, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<DashboardShareRestDto>	findShareForDashboard(String dashboardId)
org.springframework.http.ResponseEntity<ReportShareRestDto>	findShareForReport(String reportId)
String	isAuthorizedToShareDashboard(String dashboardId, jakarta.servlet.http.HttpServletRequest request)	Returns status code - 200: if user that performs the request is allowed to share the dashboard - 403: if the user does not have the authorization to share the dashboard - 404: if the dashboard for the id does not exist - 500: if there were problems checking the authorizations.

Methods inherited from class java.lang.Object

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

Field Details

SHARE_PATH

public static final String SHARE_PATH

See Also:

• Constant Field Values

REPORT_SUB_PATH

public static final String REPORT_SUB_PATH

See Also:

• Constant Field Values

DASHBOARD_SUB_PATH

public static final String DASHBOARD_SUB_PATH

See Also:

• Constant Field Values

EVALUATE_SUB_PATH

public static final String EVALUATE_SUB_PATH

See Also:

• Constant Field Values

Constructor Details

SharingRestService

public SharingRestService(SharingService sharingService,
 SettingsService settingsService,
 SessionService sessionService,
 ReportRestMapper reportRestMapper,
 DashboardRestMapper dashboardRestMapper,
 EventReportingService eventReportingService,
 org.springframework.core.env.Environment environment)

Method Details

createNewReportShare

@PostMapping("/report")
public IdResponseDto createNewReportShare(@RequestBody
 ReportShareRestDto createSharingDto,
 jakarta.servlet.http.HttpServletRequest request)

createNewDashboardShare

@PostMapping("/dashboard")
public IdResponseDto createNewDashboardShare(@RequestBody
 DashboardShareRestDto createSharingDto,
 jakarta.servlet.http.HttpServletRequest request)

deleteReportShare

@DeleteMapping("/report/{shareId}")
public void deleteReportShare(@PathVariable("shareId")
 String reportShareId)

deleteDashboardShare

@DeleteMapping("/dashboard/{shareId}")
public void deleteDashboardShare(@PathVariable("shareId")
 String dashboardShareId)

findShareForReport

@GetMapping("/report/{reportId}")
public org.springframework.http.ResponseEntity<ReportShareRestDto> findShareForReport(@PathVariable("reportId")
 String reportId)

findShareForDashboard

@GetMapping("/dashboard/{dashboardId}")
public org.springframework.http.ResponseEntity<DashboardShareRestDto> findShareForDashboard(@PathVariable("dashboardId")
 String dashboardId)

evaluateReport

@PostMapping("/report/{shareId}/evaluate")
public AuthorizedReportEvaluationResponseDto evaluateReport(@PathVariable("shareId")
 String reportShareId,
 @Valid @RequestBody
 @Valid PaginationRequestDto paginationRequestDto,
 jakarta.servlet.http.HttpServletRequest request)

evaluateReport

@PostMapping("/dashboard/{shareId}/report/{reportId}/evaluate")
public AuthorizedReportEvaluationResponseDto evaluateReport(@PathVariable("shareId")
 String dashboardShareId,
 @PathVariable("reportId")
 String reportId,
 @RequestBody
 AdditionalProcessReportEvaluationFilterDto reportEvaluationFilter,
 @Valid
 @Valid PaginationRequestDto paginationRequestDto,
 jakarta.servlet.http.HttpServletRequest request)

evaluateDashboard

@GetMapping("/dashboard/{shareId}/evaluate")
public DashboardDefinitionRestDto evaluateDashboard(@PathVariable("shareId")
 String dashboardShareId,
 jakarta.servlet.http.HttpServletRequest request)

isAuthorizedToShareDashboard

@GetMapping("/dashboard/{dashboardId}/isAuthorizedToShare")
public String isAuthorizedToShareDashboard(@PathVariable("dashboardId")
 String dashboardId,
 jakarta.servlet.http.HttpServletRequest request)

Returns status code - 200: if user that performs the request is allowed to share the dashboard - 403: if the user does not have the authorization to share the dashboard - 404: if the dashboard for the id does not exist - 500: if there were problems checking the authorizations.

checkShareStatus

@PostMapping("/status")
public ShareSearchResultResponseDto checkShareStatus(@RequestBody
 ShareSearchRequestDto searchRequest)