Package io.camunda.optimize.rest

Class ReportRestService

java.lang.Object

io.camunda.optimize.rest.ReportRestService

@Validated
@RestController
@RequestMapping("/api/report")
public class ReportRestService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REPORT_PATH

Constructor Summary

Constructors

Constructor	Description
ReportRestService(ReportService reportService, ReportEvaluationService reportEvaluationService, SessionService sessionService, ReportRestMapper reportRestMapper)

Method Summary

Modifier and Type	Method	Description
IdResponseDto	copyReport(String id, String collectionId, String newReportName, jakarta.servlet.http.HttpServletRequest request)
IdResponseDto	createNewCombinedProcessReport(CombinedReportDefinitionRequestDto combinedReportDefinitionDto, jakarta.servlet.http.HttpServletRequest request)
IdResponseDto	createNewSingleDecisionReport(@Valid SingleDecisionReportDefinitionRequestDto singleDecisionReportDefinitionDto, jakarta.servlet.http.HttpServletRequest request)
IdResponseDto	createNewSingleProcessReport(@Valid SingleProcessReportDefinitionRequestDto definition, jakarta.servlet.http.HttpServletRequest request)
void	deleteReport(String reportId, boolean force, jakarta.servlet.http.HttpServletRequest request)
AuthorizedReportEvaluationResponseDto	evaluateProvidedReport(@Valid ReportDefinitionDto reportDefinitionDto, @Valid PaginationRequestDto paginationRequestDto, jakarta.servlet.http.HttpServletRequest request)
AuthorizedReportEvaluationResponseDto	evaluateReportByIdWithFilters(String reportId, @Valid PaginationRequestDto paginationRequestDto, AdditionalProcessReportEvaluationFilterDto reportEvaluationFilter, jakarta.servlet.http.HttpServletRequest request)
List<AuthorizedReportDefinitionResponseDto>	getAuthorizedPrivateReports(jakarta.servlet.http.HttpServletRequest request)
ConflictResponseDto	getDeleteConflicts(String reportId, jakarta.servlet.http.HttpServletRequest request)
AuthorizedReportDefinitionResponseDto	getReport(String reportId, jakarta.servlet.http.HttpServletRequest request)
void	updateCombinedProcessReport(String reportId, boolean force, CombinedReportDefinitionRequestDto updatedReport, jakarta.servlet.http.HttpServletRequest request)
void	updateSingleDecisionReport(String reportId, boolean force, @Valid SingleDecisionReportDefinitionRequestDto updatedReport, jakarta.servlet.http.HttpServletRequest request)
void	updateSingleProcessReport(String reportId, boolean force, @Valid SingleProcessReportDefinitionRequestDto updatedReport, 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

REPORT_PATH

public static final String REPORT_PATH

See Also:

• Constant Field Values

Constructor Details

ReportRestService

public ReportRestService(ReportService reportService,
 ReportEvaluationService reportEvaluationService,
 SessionService sessionService,
 ReportRestMapper reportRestMapper)

Method Details

createNewSingleProcessReport

@PostMapping("/process/single")
public IdResponseDto createNewSingleProcessReport(@Valid @RequestBody
 @Valid SingleProcessReportDefinitionRequestDto definition,
 jakarta.servlet.http.HttpServletRequest request)

createNewSingleDecisionReport

@PostMapping("/decision/single/")
public IdResponseDto createNewSingleDecisionReport(@Valid @RequestBody
 @Valid SingleDecisionReportDefinitionRequestDto singleDecisionReportDefinitionDto,
 jakarta.servlet.http.HttpServletRequest request)

createNewCombinedProcessReport

@PostMapping("/process/combined/")
public IdResponseDto createNewCombinedProcessReport(@RequestBody
 CombinedReportDefinitionRequestDto combinedReportDefinitionDto,
 jakarta.servlet.http.HttpServletRequest request)

copyReport

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

getAuthorizedPrivateReports

@GetMapping
public List<AuthorizedReportDefinitionResponseDto> getAuthorizedPrivateReports(jakarta.servlet.http.HttpServletRequest request)

getReport

@GetMapping("/{id}")
public AuthorizedReportDefinitionResponseDto getReport(@PathVariable("id")
 String reportId,
 jakarta.servlet.http.HttpServletRequest request)

evaluateReportByIdWithFilters

@PostMapping("/{id}/evaluate")
public AuthorizedReportEvaluationResponseDto evaluateReportByIdWithFilters(@PathVariable("id")
 String reportId,
 @Valid
 @Valid PaginationRequestDto paginationRequestDto,
 @RequestBody
 AdditionalProcessReportEvaluationFilterDto reportEvaluationFilter,
 jakarta.servlet.http.HttpServletRequest request)

evaluateProvidedReport

@PostMapping("/evaluate")
public AuthorizedReportEvaluationResponseDto evaluateProvidedReport(@Valid @RequestBody
 @Valid ReportDefinitionDto reportDefinitionDto,
 @Valid
 @Valid PaginationRequestDto paginationRequestDto,
 jakarta.servlet.http.HttpServletRequest request)

updateSingleProcessReport

@PutMapping("/process/single/{id}")
public void updateSingleProcessReport(@PathVariable("id")
 String reportId,
 @RequestParam(name="force",required=false)
 boolean force,
 @RequestBody @Valid
 @Valid SingleProcessReportDefinitionRequestDto updatedReport,
 jakarta.servlet.http.HttpServletRequest request)

updateSingleDecisionReport

@PutMapping("/decision/single/{id}")
public void updateSingleDecisionReport(@PathVariable("id")
 String reportId,
 @RequestParam(name="force",required=false)
 boolean force,
 @RequestBody @Valid
 @Valid SingleDecisionReportDefinitionRequestDto updatedReport,
 jakarta.servlet.http.HttpServletRequest request)

updateCombinedProcessReport

@PutMapping("/process/combined/{id}")
public void updateCombinedProcessReport(@PathVariable("id")
 String reportId,
 @RequestParam(name="force",required=false)
 boolean force,
 @RequestBody
 CombinedReportDefinitionRequestDto updatedReport,
 jakarta.servlet.http.HttpServletRequest request)

getDeleteConflicts

@GetMapping("/{id}/delete-conflicts")
public ConflictResponseDto getDeleteConflicts(@PathVariable("id")
 String reportId,
 jakarta.servlet.http.HttpServletRequest request)

deleteReport

@DeleteMapping("/{id}")
public void deleteReport(@PathVariable("id")
 String reportId,
 @RequestParam(name="force",required=false)
 boolean force,
 jakarta.servlet.http.HttpServletRequest request)