Package io.camunda.optimize.rest

Class SharingPublicReaderRestService

java.lang.Object

io.camunda.optimize.rest.SharingPublicReaderRestService

@Validated
@RestController
@RequestMapping("/api/external")
public class SharingPublicReaderRestService
extends Object

Constructor Summary

Constructors

Constructor

Description

SharingPublicReaderRestService(SharingRestService protectedSharingRestService, LocalizationRestService localizationRestService, ProcessVariableRestService processVariableRestService, DecisionVariablesRestService decisionVariableRestService, FlowNodeRestService flowNodeRestService, CandidateGroupRestService candidateGroupRestService, UIConfigurationRestService uiConfigurationService, AssigneeRestService assigneeRestService, SettingsService settingsService)

Method Summary

Modifier and Type	Method	Description
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)
List<UserDto>	getAssigneesByIds(String commaSeparatedIdn)
List<GroupDto>	getCandidateGroupsByIds(String commaSeparatedIdn)
FlowNodeNamesResponseDto	getFlowNodeNames(FlowNodeIdsToNamesRequestDto request)
List<DecisionVariableNameResponseDto>	getInputVariableNames(@Valid List<DecisionVariableNameRequestDto> variableRequestDto)
byte[]	getLocalizationFile(String localeCode)
List<DecisionVariableNameResponseDto>	getOutputVariableNames(@Valid List<DecisionVariableNameRequestDto> variableRequestDto)
UIConfigurationResponseDto	getUIConfiguration()
List<ProcessVariableNameResponseDto>	getVariableNames(@Valid ProcessVariableNameRequestDto variableRequestDtos, jakarta.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Constructor Details

SharingPublicReaderRestService

public SharingPublicReaderRestService(SharingRestService protectedSharingRestService,
 LocalizationRestService localizationRestService,
 ProcessVariableRestService processVariableRestService,
 DecisionVariablesRestService decisionVariableRestService,
 FlowNodeRestService flowNodeRestService,
 CandidateGroupRestService candidateGroupRestService,
 UIConfigurationRestService uiConfigurationService,
 AssigneeRestService assigneeRestService,
 SettingsService settingsService)

Method Details

getUIConfiguration

@GetMapping("/ui-configuration")
public UIConfigurationResponseDto getUIConfiguration()

getLocalizationFile

@GetMapping("/localization")
public byte[] getLocalizationFile(@RequestParam(name="localeCode",required=false)
 String localeCode)

evaluateReport

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

evaluateReport

@PostMapping("/share/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("/share/dashboard/{shareId}/evaluate")
public DashboardDefinitionRestDto evaluateDashboard(@PathVariable("shareId")
 String dashboardShareId,
 jakarta.servlet.http.HttpServletRequest request)

getVariableNames

@PostMapping("/variables")
public List<ProcessVariableNameResponseDto> getVariableNames(@Valid @RequestBody
 @Valid ProcessVariableNameRequestDto variableRequestDtos,
 jakarta.servlet.http.HttpServletRequest request)

getInputVariableNames

@PostMapping("/decision-variables/inputs/names")
public List<DecisionVariableNameResponseDto> getInputVariableNames(@Valid @RequestBody
 @Valid List<DecisionVariableNameRequestDto> variableRequestDto)

getOutputVariableNames

@PostMapping("/decision-variables/outputs/names")
public List<DecisionVariableNameResponseDto> getOutputVariableNames(@Valid @RequestBody
 @Valid List<DecisionVariableNameRequestDto> variableRequestDto)

getFlowNodeNames

@PostMapping("/flow-node/flowNodeNames")
public FlowNodeNamesResponseDto getFlowNodeNames(@RequestBody
 FlowNodeIdsToNamesRequestDto request)

getCandidateGroupsByIds

@GetMapping("/candidateGroup")
public List<GroupDto> getCandidateGroupsByIds(@RequestParam(name="idIn",required=false)
 String commaSeparatedIdn)

getAssigneesByIds

@GetMapping("/assignee")
public List<UserDto> getAssigneesByIds(@RequestParam(name="idIn",required=false)
 String commaSeparatedIdn)