Package io.camunda.optimize.rest

Class PublicApiRestService

java.lang.Object

io.camunda.optimize.rest.PublicApiRestService

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DASHBOARD_EXPORT_DEFINITION_SUB_PATH
static final String	DASHBOARD_SUB_PATH
static final String	EXPORT_SUB_PATH
static final String	IMPORT_SUB_PATH
static final String	LABELS_SUB_PATH
static final String	PUBLIC_PATH
static final String	REPORT_EXPORT_DEFINITION_SUB_PATH
static final String	REPORT_SUB_PATH

Constructor Summary

Constructors

Constructor	Description
PublicApiRestService(JsonReportResultExportService jsonReportResultExportService, EntityExportService entityExportService, EntityImportService entityImportService, ReportService reportService, DashboardService dashboardService, ProcessVariableLabelService processVariableLabelService, SettingsService settingsService)

Method Summary

Modifier and Type	Method	Description
void	deleteDashboardDefinition(String dashboardId)
void	deleteReportDefinition(String reportId)
void	disableShare()
void	enableShare()
List<OptimizeEntityExportDto>	exportDashboardDefinition(Set<String> dashboardIds)
PaginatedDataExportDto	exportReportData(String reportId, @Valid PaginationScrollableRequestDto paginationRequestDto)
List<ReportDefinitionExportDto>	exportReportDefinition(Set<String> reportIds)
List<IdResponseDto>	getDashboardIds(String collectionId)
List<IdResponseDto>	getReportIds(String collectionId)
List<EntityIdResponseDto>	importEntities(String collectionId, String exportedDtoJson)
void	modifyVariableLabels(@Valid DefinitionVariableLabelsDto definitionVariableLabelsDto)

Methods inherited from class java.lang.Object

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

Field Details

PUBLIC_PATH

public static final String PUBLIC_PATH

See Also:

• Constant Field Values

EXPORT_SUB_PATH

public static final String EXPORT_SUB_PATH

See Also:

• Constant Field Values

IMPORT_SUB_PATH

public static final String IMPORT_SUB_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

LABELS_SUB_PATH

public static final String LABELS_SUB_PATH

See Also:

• Constant Field Values

DASHBOARD_EXPORT_DEFINITION_SUB_PATH

public static final String DASHBOARD_EXPORT_DEFINITION_SUB_PATH

See Also:

• Constant Field Values

REPORT_EXPORT_DEFINITION_SUB_PATH

public static final String REPORT_EXPORT_DEFINITION_SUB_PATH

See Also:

• Constant Field Values

Constructor Details

PublicApiRestService

public PublicApiRestService(JsonReportResultExportService jsonReportResultExportService,
 EntityExportService entityExportService,
 EntityImportService entityImportService,
 ReportService reportService,
 DashboardService dashboardService,
 ProcessVariableLabelService processVariableLabelService,
 SettingsService settingsService)

Method Details

getReportIds

@GetMapping("/report")
public List<IdResponseDto> getReportIds(@RequestParam(name="collectionId",required=false)
 String collectionId)

getDashboardIds

@GetMapping("/dashboard")
public List<IdResponseDto> getDashboardIds(@RequestParam(name="collectionId",required=false)
 String collectionId)

exportReportData

@GetMapping("/export/report/{reportId}/result/json")
public PaginatedDataExportDto exportReportData(@PathVariable("reportId")
 String reportId,
 @Valid
 @Valid PaginationScrollableRequestDto paginationRequestDto)

exportReportDefinition

@PostMapping("/export/report/definition/json")
public List<ReportDefinitionExportDto> exportReportDefinition(@RequestBody
 Set<String> reportIds)

exportDashboardDefinition

@PostMapping("/export/dashboard/definition/json")
public List<OptimizeEntityExportDto> exportDashboardDefinition(@RequestBody
 Set<String> dashboardIds)

importEntities

@PostMapping("/import")
public List<EntityIdResponseDto> importEntities(@RequestParam(name="collectionId",required=false)
 String collectionId,
 String exportedDtoJson)

deleteReportDefinition

@DeleteMapping("/report/{reportId}")
public void deleteReportDefinition(@PathVariable("reportId")
 String reportId)

deleteDashboardDefinition

@DeleteMapping("/dashboard/{dashboardId}")
public void deleteDashboardDefinition(@PathVariable("dashboardId")
 String dashboardId)

modifyVariableLabels

@PostMapping("/variables/labels")
public void modifyVariableLabels(@Valid
 @Valid DefinitionVariableLabelsDto definitionVariableLabelsDto)

enableShare

@PostMapping("/share/enable")
public void enableShare()

disableShare

@PostMapping("/share/disable")
public void disableShare()