InformationViewOMASResource (Information View OMAS Spring 1.7 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.informationview.server.spring.InformationViewOMASResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/information-view/users/{userId}/")
 @Validated
public class InformationViewOMASResource
extends Object

Constructor Summary

Constructors
Constructor and Description

InformationViewOMASResource()

Constructors
Constructor and Description
`InformationViewOMASResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InformationViewOMASAPIResponse`	`lookupExternalTool(String serverName, String userId, @Valid RegistrationRequestBody requestBody)` Return the SoftwareServerCapability entity for the external tool described in the payload
`InformationViewOMASAPIResponse`	`registerExternalTool(String serverName, String userId, @Valid RegistrationRequestBody requestBody)` Create a SoftwareServerCapability entity containing the properties submitted in the request and describing the external tool
`InformationViewOMASAPIResponse`	`retrieveDatabases(String serverName, String userId, @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom, @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)` Returns the list of databases
`InformationViewOMASAPIResponse`	`retrieveDataView(String serverName, String userId, @NotBlank(message="data view id should not be blank") String dataViewId)` Retrieve the metadata representation of the data view with the specified data view id
`InformationViewOMASAPIResponse`	`retrieveReport(String serverName, String userId, @NotBlank(message="report id should not be blank") String reportId)` Retrieve the report metadata representation for the report with the specified report id
`InformationViewOMASAPIResponse`	`retrieveTableColumns(String serverName, String userId, @NotBlank(message="guid of the table should not be blank") String tableGuid, @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom, @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)` Retrieve list of columns for a table using pagination
`InformationViewOMASAPIResponse`	`retrieveTableContext(String serverName, String userId, @NotBlank(message="guid of the table should not be blank") String tableGuid)` Retrieve the full context of a table
`InformationViewOMASAPIResponse`	`retrieveTablesForDatabase(String serverName, String userId, @NotBlank(message="guid of the database should not be blank") String databaseGuid, @PositiveOrZero(message="startFrom should be a positive number") int startFrom, @PositiveOrZero(message="pageSize should be a positive number") int pageSize)` Retrieve list of tables for a database
`InformationViewOMASAPIResponse`	`submitDataView(String serverName, String userId, @Valid DataViewRequestBody requestBody)` Create the metadata for the data view
`InformationViewOMASAPIResponse`	`submitReport(String serverName, String userId, @Valid ReportRequestBody requestBody)` Save the report metadata representation

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- InformationViewOMASResource
```
public InformationViewOMASResource()
```

Method Detail

submitReport

@PostMapping(path="/report")
public InformationViewOMASAPIResponse submitReport(@PathVariable(value="serverName")
                                                                                String serverName,
                                                                                @PathVariable(value="userId")
                                                                                String userId,
                                                                                @Valid @RequestBody
                                                                                @Valid ReportRequestBody requestBody)

Save the report metadata representation

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; requestBody - The json representing the structure of the report and basic report properties
Returns:: Success or Failure response describing the error based on status of the operation

submitDataView

@PostMapping(path="/dataview")
public InformationViewOMASAPIResponse submitDataView(@PathVariable(value="serverName")
                                                                                    String serverName,
                                                                                    @PathVariable(value="userId")
                                                                                    String userId,
                                                                                    @RequestBody @Valid
                                                                                    @Valid DataViewRequestBody requestBody)

Create the metadata for the data view

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; requestBody - The json representing the structure of the report and basic report properties
Returns:: Success or Failure response describing the error based on status of the operation

retrieveDatabases

@GetMapping(path="/databases")
public InformationViewOMASAPIResponse retrieveDatabases(@PathVariable(value="serverName")
                                                                                       String serverName,
                                                                                       @PathVariable(value="userId")
                                                                                       String userId,
                                                                                       @PositiveOrZero(message="startFrom should be a positive number") @RequestParam
                                                                                       @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom,
                                                                                       @PositiveOrZero(message="pageSize should be a positive number") @RequestParam
                                                                                       @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)

Returns the list of databases

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return
Returns:: list of databases

retrieveTablesForDatabase

@GetMapping(path="databases/{database}/tables")
public InformationViewOMASAPIResponse retrieveTablesForDatabase(@PathVariable(value="serverName")
                                                                                                                String serverName,
                                                                                                                @PathVariable(value="userId")
                                                                                                                String userId,
                                                                                                                @NotBlank(message="guid of the database should not be blank") @PathVariable(value="database")
                                                                                                                @NotBlank(message="guid of the database should not be blank") String databaseGuid,
                                                                                                                @PositiveOrZero(message="startFrom should be a positive number") @RequestParam
                                                                                                                @PositiveOrZero(message="startFrom should be a positive number") int startFrom,
                                                                                                                @PositiveOrZero(message="pageSize should be a positive number") @RequestParam
                                                                                                                @PositiveOrZero(message="pageSize should be a positive number") int pageSize)

Retrieve list of tables for a database

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; databaseGuid - guid of database for which we want to retrieve the list of tables; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return
Returns:: list of tables belonging to the database

retrieveTableContext

@GetMapping(path="tables/{table}")
public InformationViewOMASAPIResponse retrieveTableContext(@PathVariable(value="serverName")
                                                                                              String serverName,
                                                                                              @PathVariable(value="userId")
                                                                                              String userId,
                                                                                              @NotBlank(message="guid of the table should not be blank") @PathVariable(value="table")
                                                                                              @NotBlank(message="guid of the table should not be blank") String tableGuid)

Retrieve the full context of a table

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; tableGuid - guid of the table entity
Returns:: the full context of the table, including host, database, schema, table name and list of columns with business terms assigned

retrieveTableColumns

@GetMapping(path="tables/{table}/columns")
public InformationViewOMASAPIResponse retrieveTableColumns(@PathVariable(value="serverName")
                                                                                                      String serverName,
                                                                                                      @PathVariable(value="userId")
                                                                                                      String userId,
                                                                                                      @NotBlank(message="guid of the table should not be blank") @PathVariable(value="table")
                                                                                                      @NotBlank(message="guid of the table should not be blank") String tableGuid,
                                                                                                      @PositiveOrZero(message="startFrom should be a positive number") @RequestParam
                                                                                                      @PositiveOrZero(message="startFrom should be a positive number") Integer startFrom,
                                                                                                      @PositiveOrZero(message="pageSize should be a positive number") @RequestParam
                                                                                                      @PositiveOrZero(message="pageSize should be a positive number") Integer pageSize)

Retrieve list of columns for a table using pagination

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; tableGuid - guid of the table; startFrom - starting element (used in paging through large result sets); pageSize - maximum number of results to return
Returns:: list of columns belonging to the table

registerExternalTool

@PostMapping(path="register")
public InformationViewOMASAPIResponse registerExternalTool(@PathVariable(value="serverName")
                                                                                         String serverName,
                                                                                         @PathVariable(value="userId")
                                                                                         String userId,
                                                                                         @Valid @RequestBody
                                                                                         @Valid RegistrationRequestBody requestBody)

Create a SoftwareServerCapability entity containing the properties submitted in the request and describing the external tool

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; requestBody - payload containing the registration details to create
Returns:: response containing guid of SoftwareServerCapability entity assigned to the external tool

lookupExternalTool

@PostMapping(path="registration/lookup")
public InformationViewOMASAPIResponse lookupExternalTool(@PathVariable(value="serverName")
                                                                                                  String serverName,
                                                                                                  @PathVariable(value="userId")
                                                                                                  String userId,
                                                                                                  @Valid @RequestBody
                                                                                                  @Valid RegistrationRequestBody requestBody)

Return the SoftwareServerCapability entity for the external tool described in the payload

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; requestBody - payload containing the registration details to lookup
Returns:: response containing properties of the external tool used at registration step

retrieveReport

@GetMapping(path="/report")
public InformationViewOMASAPIResponse retrieveReport(@PathVariable(value="serverName")
                                                                                 String serverName,
                                                                                 @PathVariable(value="userId")
                                                                                 String userId,
                                                                                 @NotBlank(message="report id should not be blank") @RequestParam
                                                                                 @NotBlank(message="report id should not be blank") String reportId)

Retrieve the report metadata representation for the report with the specified report id

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; reportId - - id of the report to retrieve
Returns:: response containing the report metadata representation or the error in case of failure to retrieve it

retrieveDataView

@GetMapping(path="/dataview")
public InformationViewOMASAPIResponse retrieveDataView(@PathVariable(value="serverName")
                                                                                     String serverName,
                                                                                     @PathVariable(value="userId")
                                                                                     String userId,
                                                                                     @NotBlank(message="data view id should not be blank") @RequestParam
                                                                                     @NotBlank(message="data view id should not be blank") String dataViewId)

Retrieve the metadata representation of the data view with the specified data view id

Parameters:: serverName - unique identifier for requested server.; userId - the unique identifier for the user; dataViewId - id of the data view
Returns:: response containing the data view metadata representation or the error in case of failure to retrieve it

Class InformationViewOMASResource

Constructor Summary