Package io.camunda.optimize.rest

Class ExportRestService

java.lang.Object

io.camunda.optimize.rest.ExportRestService

@Validated
@RestController
@RequestMapping("/api/export")
public class ExportRestService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPORT_PATH

Constructor Summary

Constructors

Constructor	Description
ExportRestService(CsvExportService csvExportService, EntityExportService entityExportService, SessionService sessionService, AbstractIdentityService identityService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<byte[]>	getCsvReport(String reportId, String fileName, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<List<OptimizeEntityExportDto>>	getJsonDashboard(String dashboardId, String fileName, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<List<ReportDefinitionExportDto>>	getJsonReport(String reportId, String fileName, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<byte[]>	getRawDataCsv(String fileName, @Valid ProcessRawDataCsvExportRequestDto request, jakarta.servlet.http.HttpServletRequest servletRequest)	This endpoint returns only the columns specified in the includedColumns list in the request.

Methods inherited from class java.lang.Object

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

Field Details

EXPORT_PATH

public static final String EXPORT_PATH

See Also:

• Constant Field Values

Constructor Details

ExportRestService

public ExportRestService(CsvExportService csvExportService,
 EntityExportService entityExportService,
 SessionService sessionService,
 AbstractIdentityService identityService)

Method Details

getJsonReport

@GetMapping("report/json/{reportId}/{fileName}")
public org.springframework.http.ResponseEntity<List<ReportDefinitionExportDto>> getJsonReport(@PathVariable("reportId")
 String reportId,
 @PathVariable("fileName")
 String fileName,
 jakarta.servlet.http.HttpServletRequest request)

getJsonDashboard

@GetMapping("dashboard/json/{dashboardId}/{fileName}")
public org.springframework.http.ResponseEntity<List<OptimizeEntityExportDto>> getJsonDashboard(@PathVariable("dashboardId")
 String dashboardId,
 @PathVariable("fileName")
 String fileName,
 jakarta.servlet.http.HttpServletRequest request)

getCsvReport

@GetMapping(path="csv/{reportId}/{fileName}",
            produces={"application/octet-stream","application/json"})
public org.springframework.http.ResponseEntity<byte[]> getCsvReport(@PathVariable("reportId")
 String reportId,
 @PathVariable("fileName")
 String fileName,
 jakarta.servlet.http.HttpServletRequest request)

getRawDataCsv

@PostMapping(path="csv/process/rawData/{fileName}",
             produces={"application/octet-stream","application/json"})
public org.springframework.http.ResponseEntity<byte[]> getRawDataCsv(@PathVariable("fileName")
 String fileName,
 @Valid @RequestBody
 @Valid ProcessRawDataCsvExportRequestDto request,
 jakarta.servlet.http.HttpServletRequest servletRequest)

This endpoint returns only the columns specified in the includedColumns list in the request. All other columns (dto fields, new and existing variables not in includedColumns) are to be excluded. It is used for example to return process instance Ids in the branch analysis export.