Package org.odpi.openmetadata.viewservices.solutionarchitect.server

Class SolutionArchitectRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.solutionarchitect.server.SolutionArchitectRESTServices
public class SolutionArchitectRESTServices extends TokenController
The SolutionArchitectRESTServices provides the server-side implementation of the Solution Architect Open Metadata View Service (OMVS). This interface provides access to information supply chains, solution blueprints, solution components and solution roles.

  • Constructor Details

    • SolutionArchitectRESTServices

      public SolutionArchitectRESTServices()
      Default constructor

  • Method Details

    • createInformationSupplyChain

      public GUIDResponse createInformationSupplyChain(String serverName, NewElementRequestBody requestBody)
      Create an information supply chain.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the information supply chain.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createInformationSupplyChainFromTemplate

      public GUIDResponse createInformationSupplyChainFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent an information supply chain using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateInformationSupplyChain

      public BooleanResponse updateInformationSupplyChain(String serverName, String informationSupplyChainGUID, UpdateElementRequestBody requestBody)
      Update the properties of an information supply chain.
      Parameters:
      serverName - name of called server.
      informationSupplyChainGUID - unique identifier of the information supply chain (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPeersInInformationSupplyChain

      public VoidResponse linkPeersInInformationSupplyChain(String serverName, String peerOneGUID, String peerTwoGUID, NewRelationshipRequestBody requestBody)
      Connect two peers in an information supply chains. The linked elements are of type 'Referenceable' to allow significant data stores to be included in the definition of the information supply chain.
      Parameters:
      serverName - name of called server
      peerOneGUID - unique identifier of the end one element in the relationship
      peerTwoGUID - unique identifier of the end two element in the relationship
      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.

    • unlinkPeersInInformationSupplyChain

      public VoidResponse unlinkPeersInInformationSupplyChain(String serverName, String peerOneGUID, String peerTwoGUID, DeleteRelationshipRequestBody requestBody)
      Detach two peers in an information supply chain from one another. The linked elements are of type 'Referenceable' to allow significant data stores to be included in the definition of the information supply chain.
      Parameters:
      serverName - name of called server
      peerOneGUID - unique identifier of the end one element in the relationship
      peerTwoGUID - unique identifier of the end two element in the relationship
      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.

    • deleteInformationSupplyChain

      public VoidResponse deleteInformationSupplyChain(String serverName, String informationSupplyChainGUID, DeleteElementRequestBody requestBody)
      Delete an information supply chain.
      Parameters:
      serverName - name of called server
      informationSupplyChainGUID - unique identifier of the element to delete
      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.

    • getInformationSupplyChainsByName

      public OpenMetadataRootElementsResponse getInformationSupplyChainsByName(String serverName, boolean addImplementation, FilterRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • findInformationSupplyChains

      public OpenMetadataRootElementsResponse findInformationSupplyChains(String serverName, boolean addImplementation, SearchStringRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • getInformationSupplyChainByGUID

      public OpenMetadataRootElementResponse getInformationSupplyChainByGUID(String serverName, String informationSupplyChainGUID, boolean addImplementation, GetRequestBody requestBody)
      Retrieve the list of information supply chain metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      informationSupplyChainGUID - unique identifier of the required element
      addImplementation - should details of the implementation of the information supply chain be extracted too?
      requestBody - time values for the query
      Returns:
      list of matching metadata elements or 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)

    • createSolutionBlueprint

      public GUIDResponse createSolutionBlueprint(String serverName, NewElementRequestBody requestBody)
      Create a solution blueprint.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the solution blueprint.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createSolutionBlueprintFromTemplate

      public GUIDResponse createSolutionBlueprintFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a solution blueprint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateSolutionBlueprint

      public BooleanResponse updateSolutionBlueprint(String serverName, String solutionBlueprintGUID, UpdateElementRequestBody requestBody)
      Update the properties of a solution blueprint.
      Parameters:
      serverName - name of called server.
      solutionBlueprintGUID - unique identifier of the solution blueprint (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkSolutionDesign

      public VoidResponse linkSolutionDesign(String serverName, String parentGUID, String solutionBlueprintGUID, NewRelationshipRequestBody requestBody)
      Attach a solution blueprint to the element that it describes.
      Parameters:
      serverName - name of called server
      parentGUID - unique identifier of the element being described
      solutionBlueprintGUID - unique identifier of the solution blueprint
      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.

    • detachSolutionDesign

      public VoidResponse detachSolutionDesign(String serverName, String parentGUID, String solutionBlueprintGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution blueprint from the element it describes.
      Parameters:
      serverName - name of called server
      parentGUID - unique identifier of the element being described
      solutionBlueprintGUID - unique identifier of the solution blueprint
      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.

    • deleteSolutionBlueprint

      public VoidResponse deleteSolutionBlueprint(String serverName, String solutionBlueprintGUID, DeleteElementRequestBody requestBody)
      Delete a solution blueprint.
      Parameters:
      serverName - name of called server
      solutionBlueprintGUID - unique identifier of the element to delete
      requestBody - description of the delete method.
      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.

    • getSolutionBlueprintsByName

      public OpenMetadataRootElementsResponse getSolutionBlueprintsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of solution blueprint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • getSolutionBlueprintByGUID

      public OpenMetadataRootElementResponse getSolutionBlueprintByGUID(String serverName, String solutionBlueprintGUID, GetRequestBody requestBody)
      Retrieve the list of solution blueprint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      solutionBlueprintGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • findSolutionBlueprints

      public OpenMetadataRootElementsResponse findSolutionBlueprints(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of solution blueprint metadata elements that contain the search string. The returned blueprints include a list of the components that are associated with it.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • linkSolutionComponentActor

      public VoidResponse linkSolutionComponentActor(String serverName, String solutionRoleGUID, String solutionComponentGUID, NewRelationshipRequestBody requestBody)
      Attach a solution component to a solution role.
      Parameters:
      serverName - name of called server
      solutionRoleGUID - unique identifier of the parent solution role.
      solutionComponentGUID - unique identifier of the nested solution component.
      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.

    • detachSolutionComponentActor

      public VoidResponse detachSolutionComponentActor(String serverName, String solutionRoleGUID, String solutionComponentGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a solution role.
      Parameters:
      serverName - name of called server
      solutionRoleGUID - unique identifier of the parent solution role.
      solutionComponentGUID - unique identifier of the nested solution component.
      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.

    • createSolutionComponent

      public GUIDResponse createSolutionComponent(String serverName, NewElementRequestBody requestBody)
      Create a solution component.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the solution component.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createSolutionComponentFromTemplate

      public GUIDResponse createSolutionComponentFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a solution component using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element 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)

    • updateSolutionComponent

      public BooleanResponse updateSolutionComponent(String serverName, String solutionComponentGUID, UpdateElementRequestBody requestBody)
      Update the properties of a solution component.
      Parameters:
      serverName - name of called server.
      solutionComponentGUID - unique identifier of the solution component (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkSubcomponent

      public VoidResponse linkSubcomponent(String serverName, String parentSolutionComponentGUID, String nestedSolutionComponentGUID, NewRelationshipRequestBody requestBody)
      Attach a solution component to a solution component.
      Parameters:
      serverName - name of called server
      parentSolutionComponentGUID - unique identifier of the parent solution component.
      nestedSolutionComponentGUID - unique identifier of the nested solution component.
      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.

    • detachSubcomponent

      public VoidResponse detachSubcomponent(String serverName, String parentSolutionComponentGUID, String nestedSolutionComponentGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a solution component.
      Parameters:
      serverName - name of called server
      parentSolutionComponentGUID - unique identifier of the parent solution component.
      nestedSolutionComponentGUID - unique identifier of the nested solution component.
      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.

    • linkSolutionLinkingWire

      public GUIDResponse linkSolutionLinkingWire(String serverName, String solutionComponentOneGUID, String solutionComponentTwoGUID, NewRelationshipRequestBody requestBody)
      Attach a solution component to a solution component.
      Parameters:
      serverName - name of called server
      solutionComponentOneGUID - unique identifier of the solution component at end 1
      solutionComponentTwoGUID - unique identifier of the solution component at end 2
      requestBody - description of the relationship.
      Returns:
      relationship GUID 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.

    • updateSolutionLinkingWire

      public VoidResponse updateSolutionLinkingWire(String serverName, String relationshipGUID, UpdateRelationshipRequestBody requestBody)
      Update the solution linking wire relationship.
      Parameters:
      serverName - name of the server instance to connect to
      relationshipGUID - unique identifier for the relationship
      requestBody - the properties of the relationship
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • detachAllSolutionLinkingWire

      public VoidResponse detachAllSolutionLinkingWire(String serverName, String solutionComponentOneGUID, String solutionComponentTwoGUID, DeleteRelationshipRequestBody requestBody)
      Delete all solution linking wire relationships between two metadata elements.
      Parameters:
      serverName - name of called server
      solutionComponentOneGUID - unique identifier of the solution component at end 1
      solutionComponentTwoGUID - unique identifier of the solution component at end 2
      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.

    • detachSolutionLinkingWire

      public VoidResponse detachSolutionLinkingWire(String serverName, String relationshipGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a solution component.
      Parameters:
      serverName - name of called server
      relationshipGUID - unique identifier of the relationship (returned from create)
      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.

    • deleteSolutionComponent

      public VoidResponse deleteSolutionComponent(String serverName, String solutionComponentGUID, DeleteElementRequestBody requestBody)
      Delete a solution component.
      Parameters:
      serverName - name of called server
      solutionComponentGUID - unique identifier of the element to delete
      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.

    • getSolutionComponentsByName

      public OpenMetadataRootElementsResponse getSolutionComponentsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of solution component metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • getSolutionComponentByGUID

      public OpenMetadataRootElementResponse getSolutionComponentByGUID(String serverName, String solutionComponentGUID, GetRequestBody requestBody)
      Retrieve the list of solution component metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      solutionComponentGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • findSolutionComponents

      public OpenMetadataRootElementsResponse findSolutionComponents(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of solution component metadata elements that contain the search string. The solutions components returned include information about the consumers, actors and other solution components that are associated with them.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • getSolutionComponentImplementations

      public RelatedMetadataElementsResponse getSolutionComponentImplementations(String serverName, String solutionComponentGUID, ResultsRequestBody requestBody)
      Retrieve the list of metadata elements that are associated with the solution component via the ImplementedBy relationship.
      Parameters:
      serverName - name of the service to route the request to
      solutionComponentGUID - unique identifier of the solution component to query
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or 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)

    • createDesignPattern

      public GUIDResponse createDesignPattern(String serverName, NewElementRequestBody requestBody)
      Create a new design pattern.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - details of the design pattern
      Returns:
      unique identifier of the design pattern or 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)

    • createDesignPatternFromTemplate

      public GUIDResponse createDesignPatternFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new design pattern using a template.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - details of the template and overrides
      Returns:
      unique identifier of the design pattern or 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)

    • updateDesignPattern

      public BooleanResponse updateDesignPattern(String serverName, String designPatternGUID, UpdateElementRequestBody requestBody)
      Update an existing design pattern.
      Parameters:
      serverName - name of the service to route the request to
      designPatternGUID - unique identifier of the design pattern to update
      requestBody - details of the design pattern
      Returns:
      void or 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)

    • linkNestedDesignPatterns

      public VoidResponse linkNestedDesignPatterns(String serverName, String parentDesignPatternGUID, String nestedDesignPatternGUID, NewRelationshipRequestBody requestBody)
      Link two design patterns together as parent and child.
      Parameters:
      serverName - name of the service to route the request to
      parentDesignPatternGUID - unique identifier of the parent design pattern
      nestedDesignPatternGUID - unique identifier of the child design pattern
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachNestedDesignPatterns

      public VoidResponse detachNestedDesignPatterns(String serverName, String parentDesignPatternGUID, String nestedDesignPatternGUID, DeleteRelationshipRequestBody requestBody)
      Remove the link between two design patterns.
      Parameters:
      serverName - name of the service to route the request to
      parentDesignPatternGUID - unique identifier of the parent design pattern
      nestedDesignPatternGUID - unique identifier of the child design pattern
      requestBody - options for the delete
      Returns:
      void or 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)

    • linkSpecializedDesignPatterns

      public VoidResponse linkSpecializedDesignPatterns(String serverName, String generalizedDesignPatternGUID, String specializedDesignPatternGUID, NewRelationshipRequestBody requestBody)
      Link two design patterns together as general and specialized.
      Parameters:
      serverName - name of the service to route the request to
      generalizedDesignPatternGUID - unique identifier of the generalized design pattern
      specializedDesignPatternGUID - unique identifier of the specialized design pattern
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachSpecializedDesignPatterns

      public VoidResponse detachSpecializedDesignPatterns(String serverName, String generalizedDesignPatternGUID, String specializedDesignPatternGUID, DeleteRelationshipRequestBody requestBody)
      Remove the link between two design patterns.
      Parameters:
      serverName - name of the service to route the request to
      generalizedDesignPatternGUID - unique identifier of the generalized design pattern
      specializedDesignPatternGUID - unique identifier of the specialized design pattern
      requestBody - options for the delete
      Returns:
      void or 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)

    • linkRelatedDesignPatterns

      public VoidResponse linkRelatedDesignPatterns(String serverName, String designPatternOneGUID, String designPatternTwoGUID, NewRelationshipRequestBody requestBody)
      Link two design patterns together as related.
      Parameters:
      serverName - name of the service to route the request to
      designPatternOneGUID - unique identifier of the first design pattern
      designPatternTwoGUID - unique identifier of the second design pattern
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachRelatedDesignPatterns

      public VoidResponse detachRelatedDesignPatterns(String serverName, String designPatternOneGUID, String designPatternTwoGUID, DeleteRelationshipRequestBody requestBody)
      Remove the link between two design patterns.
      Parameters:
      serverName - name of the service to route the request to
      designPatternOneGUID - unique identifier of the first design pattern
      designPatternTwoGUID - unique identifier of the second design pattern
      requestBody - options for the delete
      Returns:
      void or 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)

    • deleteDesignPattern

      public VoidResponse deleteDesignPattern(String serverName, String designPatternGUID, DeleteElementRequestBody requestBody)
      Delete an existing design pattern.
      Parameters:
      serverName - name of the service to route the request to
      designPatternGUID - unique identifier of the design pattern to delete
      requestBody - options for the delete
      Returns:
      void or 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)

    • getDesignPatternsByName

      public OpenMetadataRootElementsResponse getDesignPatternsByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of design patterns with a matching name.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - search string and paging options
      Returns:
      list of design patterns or 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)

    • getDesignPatternByGUID

      public OpenMetadataRootElementResponse getDesignPatternByGUID(String serverName, String designPatternGUID, GetRequestBody requestBody)
      Retrieve the design pattern with the matching unique identifier.
      Parameters:
      serverName - name of the service to route the request to
      designPatternGUID - unique identifier of the design pattern to retrieve
      requestBody - options for the get
      Returns:
      design pattern or 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)

    • findDesignPatterns

      public OpenMetadataRootElementsResponse findDesignPatterns(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of design patterns that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - search string and paging options
      Returns:
      list of design patterns or 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)

    • createConceptModelElement

      public GUIDResponse createConceptModelElement(String serverName, NewElementRequestBody requestBody)
      Create a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or 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)

    • createConceptModelElementFromTemplate

      public GUIDResponse createConceptModelElementFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a concept model element using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      unique identifier of the newly created element or 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)

    • updateConceptModelElement

      public BooleanResponse updateConceptModelElement(String serverName, String conceptModelElementGUID, UpdateElementRequestBody requestBody)
      Update the properties of a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      conceptModelElementGUID - unique identifier of the concept model element
      requestBody - properties for the request
      Returns:
      boolean - true if an update occurred or 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)

    • deleteConceptModelElement

      public VoidResponse deleteConceptModelElement(String serverName, String conceptModelElementGUID, DeleteElementRequestBody requestBody)
      Delete a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      conceptModelElementGUID - unique identifier of the concept model element
      requestBody - properties for the request
      Returns:
      void or 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)

    • getConceptModelElementsByName

      public OpenMetadataRootElementsResponse getConceptModelElementsByName(String serverName, FilterRequestBody requestBody)
      Returns the list of concept model elements with a particular name.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or 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)

    • findConceptModelElements

      public OpenMetadataRootElementsResponse findConceptModelElements(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of concept model element metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties for the request
      Returns:
      a list of elements or 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)

    • getConceptModelElementByGUID

      public OpenMetadataRootElementResponse getConceptModelElementByGUID(String serverName, String conceptModelElementGUID, GetRequestBody requestBody)
      Return the properties of a specific concept model element.
      Parameters:
      serverName - name of the server to route the request to
      conceptModelElementGUID - unique identifier of the concept model element
      requestBody - properties for the request
      Returns:
      matching element or 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)

    • linkConceptDesign

      public VoidResponse linkConceptDesign(String serverName, String elementGUID, String conceptModelGUID, NewRelationshipRequestBody requestBody)
      Attach a concept model to the element whose concepts it describes.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that the concept model describes
      conceptModelGUID - unique identifier of the concept model
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachConceptDesign

      public VoidResponse detachConceptDesign(String serverName, String elementGUID, String conceptModelGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept model from the element whose concepts it described.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element that the concept model describes
      conceptModelGUID - unique identifier of the concept model
      requestBody - delete options
      Returns:
      void or 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)

    • linkConceptBeadRelationshipEnd

      public VoidResponse linkConceptBeadRelationshipEnd(String serverName, String conceptBeadRelationshipGUID, String conceptBeadGUID, NewRelationshipRequestBody requestBody)
      Attach a concept bead to one of the ends of a concept bead relationship.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadRelationshipGUID - unique identifier of the concept bead relationship
      conceptBeadGUID - unique identifier of the concept bead at this end of the relationship
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachConceptBeadRelationshipEnd

      public VoidResponse detachConceptBeadRelationshipEnd(String serverName, String conceptBeadRelationshipGUID, String conceptBeadGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept bead from one of the ends of a concept bead relationship.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadRelationshipGUID - unique identifier of the concept bead relationship
      conceptBeadGUID - unique identifier of the concept bead at this end of the relationship
      requestBody - delete options
      Returns:
      void or 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)

    • linkTypedByConceptBead

      public VoidResponse linkTypedByConceptBead(String serverName, String conceptBeadAttributeGUID, String conceptBeadGUID, NewRelationshipRequestBody requestBody)
      Attach a concept bead attribute to the concept bead that acts as its type.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadAttributeGUID - unique identifier of the concept bead attribute
      conceptBeadGUID - unique identifier of the concept bead that provides the attribute's type
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachTypedByConceptBead

      public VoidResponse detachTypedByConceptBead(String serverName, String conceptBeadAttributeGUID, String conceptBeadGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept bead attribute from the concept bead that acted as its type.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadAttributeGUID - unique identifier of the concept bead attribute
      conceptBeadGUID - unique identifier of the concept bead that provides the attribute's type
      requestBody - delete options
      Returns:
      void or 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)

    • linkIsAConceptBead

      public VoidResponse linkIsAConceptBead(String serverName, String inheritingBeadGUID, String inheritedBeadGUID, NewRelationshipRequestBody requestBody)
      Attach a concept bead to the concept bead that it inherits from.
      Parameters:
      serverName - name of the server to route the request to
      inheritingBeadGUID - unique identifier of the concept bead that inherits
      inheritedBeadGUID - unique identifier of the concept bead that is inherited from
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachIsAConceptBead

      public VoidResponse detachIsAConceptBead(String serverName, String inheritingBeadGUID, String inheritedBeadGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept bead from the concept bead that it inherited from.
      Parameters:
      serverName - name of the server to route the request to
      inheritingBeadGUID - unique identifier of the concept bead that inherits
      inheritedBeadGUID - unique identifier of the concept bead that is inherited from
      requestBody - delete options
      Returns:
      void or 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)

    • linkConceptBeadAttributeLink

      public VoidResponse linkConceptBeadAttributeLink(String serverName, String conceptBeadGUID, String conceptBeadAttributeGUID, NewRelationshipRequestBody requestBody)
      Attach a concept bead attribute to its parent concept bead.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadGUID - unique identifier of the parent concept bead
      conceptBeadAttributeGUID - unique identifier of the concept bead attribute
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachConceptBeadAttributeLink

      public VoidResponse detachConceptBeadAttributeLink(String serverName, String conceptBeadGUID, String conceptBeadAttributeGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept bead attribute from its parent concept bead.
      Parameters:
      serverName - name of the server to route the request to
      conceptBeadGUID - unique identifier of the parent concept bead
      conceptBeadAttributeGUID - unique identifier of the concept bead attribute
      requestBody - delete options
      Returns:
      void or 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)

    • linkConceptBeadExtension

      public VoidResponse linkConceptBeadExtension(String serverName, String extendedBeadGUID, String extensionBeadGUID, NewRelationshipRequestBody requestBody)
      Attach a concept bead to a concept bead that extends it.
      Parameters:
      serverName - name of the server to route the request to
      extendedBeadGUID - unique identifier of the concept bead that is extended
      extensionBeadGUID - unique identifier of the concept bead that provides the extension
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachConceptBeadExtension

      public VoidResponse detachConceptBeadExtension(String serverName, String extendedBeadGUID, String extensionBeadGUID, DeleteRelationshipRequestBody requestBody)
      Detach a concept bead from a concept bead that extended it.
      Parameters:
      serverName - name of the server to route the request to
      extendedBeadGUID - unique identifier of the concept bead that is extended
      extensionBeadGUID - unique identifier of the concept bead that provides the extension
      requestBody - delete options
      Returns:
      void or 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)

    • linkSolutionComponentPort

      public VoidResponse linkSolutionComponentPort(String serverName, String solutionComponentGUID, String solutionPortGUID, NewRelationshipRequestBody requestBody)
      Attach a solution port to the solution component that exposes it.
      Parameters:
      serverName - name of the server to route the request to
      solutionComponentGUID - unique identifier of the solution component
      solutionPortGUID - unique identifier of the solution port
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachSolutionComponentPort

      public VoidResponse detachSolutionComponentPort(String serverName, String solutionComponentGUID, String solutionPortGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution port from the solution component that exposed it.
      Parameters:
      serverName - name of the server to route the request to
      solutionComponentGUID - unique identifier of the solution component
      solutionPortGUID - unique identifier of the solution port
      requestBody - delete options
      Returns:
      void or 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)

    • linkSolutionPortDelegation

      public VoidResponse linkSolutionPortDelegation(String serverName, String alignsToPortGUID, String delegationPortGUID, NewRelationshipRequestBody requestBody)
      Attach a solution port to the solution port that it delegates to.
      Parameters:
      serverName - name of the server to route the request to
      alignsToPortGUID - unique identifier of the solution port that is aligned to
      delegationPortGUID - unique identifier of the solution port that delegates
      requestBody - properties for the relationship
      Returns:
      void or 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)

    • detachSolutionPortDelegation

      public VoidResponse detachSolutionPortDelegation(String serverName, String alignsToPortGUID, String delegationPortGUID, DeleteRelationshipRequestBody requestBody)
      Detach a solution port from the solution port that it delegated to.
      Parameters:
      serverName - name of the server to route the request to
      alignsToPortGUID - unique identifier of the solution port that is aligned to
      delegationPortGUID - unique identifier of the solution port that delegates
      requestBody - delete options
      Returns:
      void or 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)