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

Class DigitalBusinessResource

java.lang.Object
org.odpi.openmetadata.viewservices.digitalbusiness.server.spring.DigitalBusinessResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/digital-business") public class DigitalBusinessResource extends Object
The DigitalBusinessResource provides part of the server-side implementation of the Digital Business OMVS. =

  • Constructor Details

    • DigitalBusinessResource

      public DigitalBusinessResource()
      Default constructor

  • Method Details

    • linkBusinessCapabilityDependency

      @PostMapping(path="/business-capabilities/{businessCapabilityGUID}/dependencies/{supportingBusinessCapabilityGUID}/attach") public VoidResponse linkBusinessCapabilityDependency(@PathVariable String serverName, @PathVariable String businessCapabilityGUID, @PathVariable String supportingBusinessCapabilityGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Link dependent business capabilities.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the first business capability definition
      supportingBusinessCapabilityGUID - unique identifier of the second business capability definition
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachBusinessCapabilityDependency

      @PostMapping(path="/business-capabilities/{businessCapabilityGUID}/dependencies/{supportingBusinessCapabilityGUID}/detach") public VoidResponse detachBusinessCapabilityDependency(@PathVariable String serverName, @PathVariable String businessCapabilityGUID, @PathVariable String supportingBusinessCapabilityGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach dependent business capabilities.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the first business capability definition
      supportingBusinessCapabilityGUID - unique identifier of the second business capability definition
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDigitalSupport

      @PostMapping(path="/business-capabilities/{businessCapabilityGUID}/digital-support/{elementGUID}/attach") public VoidResponse linkDigitalSupport(@PathVariable String serverName, @PathVariable String businessCapabilityGUID, @PathVariable String elementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a business capability to an element that provides digital support.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability
      elementGUID - unique identifier of the element
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDigitalSupport

      @PostMapping(path="/business-capabilities/{businessCapabilityGUID}/digital-support/{elementGUID}/detach") public VoidResponse detachDigitalSupport(@PathVariable String serverName, @PathVariable String businessCapabilityGUID, @PathVariable String elementGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a business capability definition from a hierarchical relationship.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability
      elementGUID - unique identifier of the element
      requestBody - description of the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • setBusinessSignificant

      @PostMapping(path="/elements/{elementGUID}/business-significant") public VoidResponse setBusinessSignificant(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element to indicate that it is significant to a particular business capability.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearBusinessSignificance

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