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

Class TemplateManagerResource

java.lang.Object

org.odpi.openmetadata.viewservices.templatemanager.server.spring.TemplateManagerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/template-manager")
public class TemplateManagerResource
extends Object

The TemplateManagerResource provides part of the server-side implementation of the Template Manager OMVS.

Constructor Summary

Constructors

Constructor	Description
TemplateManagerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
OpenMetadataElementsResponse	findTemplates(String serverName, String elementTypeName, String viewServiceURLMarker, String accessServiceURLMarker, int startFrom, int pageSize, TemplateClassificationRequestBody requestBody)	Retrieve the elements with the template classification.

Methods inherited from class java.lang.Object

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

Constructor Details

TemplateManagerResource

public TemplateManagerResource()

Default constructor

Method Details

findTemplates

@PostMapping(path="/metadata-elements/by-search-string")
public OpenMetadataElementsResponse findTemplates(@PathVariable
 String serverName,
 @RequestParam(required=false)
 String elementTypeName,
 @RequestParam(required=false)
 String viewServiceURLMarker,
 @RequestParam(required=false,defaultValue="digital-architecture")
 String accessServiceURLMarker,
 @RequestParam(required=false,defaultValue="0")
 int startFrom,
 @RequestParam(required=false,defaultValue="0")
 int pageSize,
 @RequestBody
 TemplateClassificationRequestBody requestBody)

Retrieve the elements with the template classification. The request can include the .

Parameters:

serverName - name of server instance to route request to

elementTypeName - optional type name for the template

viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)

accessServiceURLMarker - optional access service URL marker used to identify which back end service to call

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - searchString to retrieve

Returns:

list of matching metadata elements (or null if no elements match the name) or InvalidParameterException the qualified name is null UserNotAuthorizedException the governance action service is not able to access the element PropertyServerException there is a problem accessing the metadata store