Package org.neotropic.kuwaiba.northbound.rest.bem

Interface ReportRestOpenApi

All Known Implementing Classes:

ReportRestController

@RequestMapping("/v2.1.1/reports/")
public interface ReportRestOpenApi

Swagger documentation for reports.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH	Path that includes the Kuwaiba version and core

Method Summary

Modifier and Type	Method	Description
long	createClassLevelReport(@NotNull @Valid String className, @NotNull @Valid String reportName, @NotNull @Valid String reportDescription, @Valid String script, @javax.validation.Valid int outputType, @javax.validation.Valid boolean enabled, @NotNull @Valid String sessionId)
long	createInventoryLevelReport(@NotNull @Valid String reportName, @NotNull @Valid String reportDescription, @Valid String script, @javax.validation.Valid int outputType, @javax.validation.Valid boolean enabled, @Valid List<StringPair> parameters, @NotNull @Valid String sessionId)
ChangeDescriptor	deleteReport(@javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @NotNull @Valid String sessionId)
byte[]	executeClassLevelReport(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @NotNull @Valid String sessionId)
byte[]	executeInventoryLevelReport(@javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @Valid List<StringPair> parameters, @NotNull @Valid String sessionId)
List<ReportMetadataLight>	getClassLevelReports(@NotNull @Valid String className, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive, @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeDisabled, @NotNull @Valid String sessionId)
List<ReportMetadataLight>	getInventoryLevelReports(@javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeDisabled, @NotNull @Valid String sessionId)
ReportMetadata	getReport(@javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @NotNull @Valid String sessionId)
ChangeDescriptor	updateReport(@javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @NotNull @Valid String reportName, @NotNull @Valid String reportDescription, @javax.validation.Valid boolean enabled, @javax.validation.Valid int outputType, @Valid String script, @NotNull @Valid String sessionId)
ChangeDescriptor	updateReportParameters(@javax.validation.constraints.NotNull,@javax.validation.Valid long reportId, @Valid List<StringPair> parameters, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and core

See Also:

Constant Field Values

Method Detail

createClassLevelReport

@RequestMapping(method=POST,
                value="createClassLevelReport/{className}/{reportName}/{reportDescription}/{script}/{outputType}/{enabled}/{sessionId}",
                produces="application/json")
long createClassLevelReport(@NotNull @Valid @PathVariable(value="className",required=true)
                            @NotNull @Valid String className,
                            @NotNull @Valid @PathVariable(value="reportName",required=true)
                            @NotNull @Valid String reportName,
                            @NotNull @Valid @PathVariable(value="reportDescription",required=true)
                            @NotNull @Valid String reportDescription,
                            @Valid @PathVariable(value="script",required=true)
                            @Valid String script,
                            @Valid @PathVariable(value="outputType",required=true)
                            @javax.validation.Valid int outputType,
                            @Valid @PathVariable(value="enabled",required=true)
                            @javax.validation.Valid boolean enabled,
                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                            @NotNull @Valid String sessionId)

createInventoryLevelReport

@RequestMapping(method=POST,
                value="createInventoryLevelReport/{reportName}/{reportDescription}/{script}/{outputType}/{enabled}/{sessionId}",
                produces="application/json")
long createInventoryLevelReport(@NotNull @Valid @PathVariable(value="reportName",required=true)
                                @NotNull @Valid String reportName,
                                @NotNull @Valid @PathVariable(value="reportDescription",required=true)
                                @NotNull @Valid String reportDescription,
                                @Valid @PathVariable(value="script",required=true)
                                @Valid String script,
                                @Valid @PathVariable(value="outputType",required=true)
                                @javax.validation.Valid int outputType,
                                @Valid @PathVariable(value="enabled",required=true)
                                @javax.validation.Valid boolean enabled,
                                @Valid @RequestBody
                                @Valid List<StringPair> parameters,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

deleteReport

@RequestMapping(method=DELETE,
                value="deleteReport/{reportId}/{sessionId}",
                produces="application/json")
ChangeDescriptor deleteReport(@NotNull @Valid @PathVariable(value="reportId",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

updateReport

@RequestMapping(method=PUT,
                value="updateReport/{reportId}/{reportName}/{reportDescription}/{enabled}/{outputType}/{script}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateReport(@NotNull @Valid @PathVariable(value="reportId",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                              @NotNull @Valid @PathVariable(value="reportName",required=true)
                              @NotNull @Valid String reportName,
                              @NotNull @Valid @PathVariable(value="reportDescription",required=true)
                              @NotNull @Valid String reportDescription,
                              @Valid @PathVariable(value="enabled",required=true)
                              @javax.validation.Valid boolean enabled,
                              @Valid @PathVariable(value="outputType",required=true)
                              @javax.validation.Valid int outputType,
                              @Valid @PathVariable(value="script",required=true)
                              @Valid String script,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

updateReportParameters

@RequestMapping(method=PUT,
                value="updateReportParameters/{reportId}/{sessionId}",
                produces="application/json")
ChangeDescriptor updateReportParameters(@NotNull @Valid @PathVariable(value="reportId",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                                        @Valid @RequestBody
                                        @Valid List<StringPair> parameters,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)

getClassLevelReports

@RequestMapping(method=GET,
                value="getClassLevelReports/{className}/{recursive}/{includeDisabled}/{sessionId}",
                produces="application/json")
List<ReportMetadataLight> getClassLevelReports(@NotNull @Valid @PathVariable(value="className",required=true)
                                               @NotNull @Valid String className,
                                               @NotNull @Valid @PathVariable(value="recursive",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid boolean recursive,
                                               @NotNull @Valid @PathVariable(value="includeDisabled",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeDisabled,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)

getInventoryLevelReports

@RequestMapping(method=GET,
                value="getInventoryLevelReports/{includeDisabled}/{sessionId}",
                produces="application/json")
List<ReportMetadataLight> getInventoryLevelReports(@NotNull @Valid @PathVariable(value="includeDisabled",required=true)
                                                   @javax.validation.constraints.NotNull,@javax.validation.Valid boolean includeDisabled,
                                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                   @NotNull @Valid String sessionId)

getReport

@RequestMapping(method=GET,
                value="getReport/{reportId}/{sessionId}",
                produces="application/json")
ReportMetadata getReport(@NotNull @Valid @PathVariable(value="reportId",required=true)
                         @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)

executeClassLevelReport

@RequestMapping(method=PUT,
                value="executeClassLevelReport/{objectClassName}/{objectId}/{reportId}/{sessionId}",
                produces="application/json")
byte[] executeClassLevelReport(@NotNull @Valid @PathVariable(value="objectClassName",required=true)
                               @NotNull @Valid String objectClassName,
                               @NotNull @Valid @PathVariable(value="objectId",required=true)
                               @NotNull @Valid String objectId,
                               @NotNull @Valid @PathVariable(value="reportId",required=true)
                               @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)

executeInventoryLevelReport

@RequestMapping(method=PUT,
                value="executeInventoryLevelReport/{reportId}/{sessionId}",
                produces="application/json")
byte[] executeInventoryLevelReport(@NotNull @Valid @PathVariable(value="reportId",required=true)
                                   @javax.validation.constraints.NotNull,@javax.validation.Valid long reportId,
                                   @Valid @RequestBody
                                   @Valid List<StringPair> parameters,
                                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                   @NotNull @Valid String sessionId)