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

Class ProductManagerResource

java.lang.Object
org.odpi.openmetadata.viewservices.productmanager.server.spring.ProductManagerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/product-manager") public class ProductManagerResource extends Object
The ProductManagerResource provides part of the server-side implementation of the Product Manager OMVS. =

  • Constructor Details

    • ProductManagerResource

      public ProductManagerResource()
      Default constructor

  • Method Details

    • linkDigitalProductDependency

      @PostMapping(path="/digital-products/{consumerDigitalProductGUID}/product-dependencies/{consumedDigitalProductGUID}/attach") public GUIDResponse linkDigitalProductDependency(@PathVariable String serverName, @PathVariable String consumerDigitalProductGUID, @PathVariable String consumedDigitalProductGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link two dependent digital products.
      Parameters:
      serverName - name of called server
      consumerDigitalProductGUID - unique identifier of the digital product that has the dependency.
      consumedDigitalProductGUID - unique identifier of the digital product that it is using.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateDigitalProductDependency

      @PostMapping(path="/digital-product-dependencies/{digitalProductDependencyRelationshipGUID}/update") public VoidResponse updateDigitalProductDependency(@PathVariable String serverName, @PathVariable String digitalProductDependencyRelationshipGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody)
      Update the properties of a digital product dependency relationship.
      Parameters:
      serverName - name of the server to route the request to
      digitalProductDependencyRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDigitalProductDependency

      @PostMapping(path="/digital-product-dependencies/{digitalProductDependencyRelationshipGUID}/detach") public VoidResponse detachDigitalProductDependency(@PathVariable String serverName, @PathVariable String digitalProductDependencyRelationshipGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Remove a digital product dependency relationship.
      Parameters:
      serverName - name of the server to route the request to
      digitalProductDependencyRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkProductManager

      @PostMapping(path="/digital-products/{digitalProductGUID}/product-managers/{digitalProductManagerRoleGUID}/attach") public VoidResponse linkProductManager(@PathVariable String serverName, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerRoleGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a product manager to a digital product.
      Parameters:
      serverName - name of called server
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerRoleGUID - unique identifier of the product manager role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachProductManager

      @PostMapping(path="/digital-products/{digitalProductGUID}/product-managers/{digitalProductManagerRoleGUID}/detach") public VoidResponse detachProductManager(@PathVariable String serverName, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerRoleGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a product manager from a digital product.
      Parameters:
      serverName - name of called server
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerRoleGUID - unique identifier of the product manager role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDigitalProductDependency

      @PostMapping(path="/digital-products/{consumerDigitalProductGUID}/product-dependencies/{consumedDigitalProductGUID}/detach") public VoidResponse detachDigitalProductDependency(@PathVariable String serverName, @PathVariable String consumerDigitalProductGUID, @PathVariable String consumedDigitalProductGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Unlink dependent digital products.
      Parameters:
      serverName - name of called server
      consumerDigitalProductGUID - unique identifier of the digital product that has the dependency.
      consumedDigitalProductGUID - unique identifier of the digital product that it is using.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request. This is a multi-link relationship, so this request removes every digital product dependency relationship between the two elements. Use the request that takes the relationship's own unique identifier to remove just one of them.