Package org.odpi.openmetadata.viewservices.tex.server.spring

Class TexViewRESTResource

java.lang.Object

org.odpi.openmetadata.viewservices.tex.server.spring.TexViewRESTResource

@RestController
@RequestMapping("/servers/{viewServerName}/open-metadata/view-services/tex/users/{userId}")
public class TexViewRESTResource
extends Object

The TexViewRESTResource provides the Spring API endpoints of the Type Explorer Open Metadata View Service (OMVS). This interface provides an interfaces for enterprise architects.

Constructor Summary

Constructors

Constructor	Description
TexViewRESTResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
TexResourceEndpointListResponse	getResourceEndpoints(String viewServerName, String userId)	Get the configured resource endpoints
TypeExplorerResponse	getTypeExplorer(String viewServerName, String userId, TexTypesRequestBody body)	Load type information

Methods inherited from class java.lang.Object

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

Constructor Detail

TexViewRESTResource

public TexViewRESTResource()

Default constructor

Method Detail

getResourceEndpoints

@GetMapping("/resource-endpoints")
public TexResourceEndpointListResponse getResourceEndpoints(@PathVariable
                                                            String viewServerName,
                                                            @PathVariable
                                                            String userId)

Get the configured resource endpoints

Parameters:

viewServerName - name of the server running the view-service.

userId - user account under which to conduct operation.

Returns:

response object containing the list of resource endpoints or exception information

getTypeExplorer

@PostMapping("/types")
public TypeExplorerResponse getTypeExplorer(@PathVariable
                                            String viewServerName,
                                            @PathVariable
                                            String userId,
                                            @RequestBody
                                            TexTypesRequestBody body)

Load type information

Load type information from the repository server. This is used to populate filters.

Parameters:

viewServerName - name of the server running the view-service.

userId - user account under which to conduct operation.

body - request body containing parameters to formulate repository request

Returns:

response object containing the repository's type information or exception information