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 Details

    • TemplateManagerResource

      public TemplateManagerResource()
      Default constructor

  • Method Details

    • addTemplateClassification

      @PostMapping(path="/elements/{elementGUID}/template") public VoidResponse addTemplateClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element as suitable to be used as a template for cataloguing elements of a similar types.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeTemplateClassification

      @PostMapping(path="/elements/{elementGUID}/template/remove") public VoidResponse removeTemplateClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the Template classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addTemplateSubstituteClassification

      @PostMapping(path="/elements/{elementGUID}/template-substitute") public VoidResponse addTemplateSubstituteClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element as suitable to be used as a template substitute for cataloguing elements of a similar types.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to classify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeTemplateSubstituteClassification

      @PostMapping(path="/elements/{elementGUID}/template-substitute/remove") public VoidResponse removeTemplateSubstituteClassification(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the TemplateSubstitute classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to declassify
      requestBody - properties for the request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkSourcedFrom

      @PostMapping(path="/elements/{elementGUID}/sourced-from/{templateGUID}/attach") public VoidResponse linkSourcedFrom(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String templateGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a template to an element that was created from it.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • detachSourcedFrom

      @PostMapping(path="/elements/{elementGUID}/sourced-from/{templateGUID}/detach") public VoidResponse detachSourcedFrom(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String templateGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach the source template for an element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkCatalogTemplate

      @PostMapping(path="/elements/{elementGUID}/catalog-template/{templateGUID}/attach") public VoidResponse linkCatalogTemplate(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String templateGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a template to an element that this template is relevant to. For example, a project.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • detachCatalogTemplate

      @PostMapping(path="/elements/{elementGUID}/catalog-template/{templateGUID}/detach") public VoidResponse detachCatalogTemplate(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String templateGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a template for an element that this template is relevant to. For example, a project.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      requestBody - properties for relationship request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem