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

Class SolutionArchitectResource

java.lang.Object
org.odpi.openmetadata.viewservices.solutionarchitect.server.spring.SolutionArchitectResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/solution-architect") public class SolutionArchitectResource extends Object
The SolutionArchitectResource provides part of the server-side implementation of the Solution Architect OMVS. =

  • Constructor Details

    • SolutionArchitectResource

      public SolutionArchitectResource()
      Default constructor

  • Method Details

    • createInformationSupplyChain

      @PostMapping(path="/information-supply-chains") public GUIDResponse createInformationSupplyChain(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/from-template") public GUIDResponse createInformationSupplyChainFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/{informationSupplyChainGUID}/update") public BooleanResponse updateInformationSupplyChain(@PathVariable String serverName, @PathVariable String informationSupplyChainGUID, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/{peerOneGUID}/peer-links/{peerTwoGUID}/attach") public VoidResponse linkPeersInInformationSupplyChain(@PathVariable String serverName, @PathVariable String peerOneGUID, @PathVariable String peerTwoGUID, @RequestBody(required=false) 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.

    • unlinkPeerInformationSupplyChains

      @PostMapping(path="/information-supply-chains/{peerOneGUID}/peer-links/{peerTwoGUID}/detach") public VoidResponse unlinkPeerInformationSupplyChains(@PathVariable String serverName, @PathVariable String peerOneGUID, @PathVariable String peerTwoGUID, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/{informationSupplyChainGUID}/delete") public VoidResponse deleteInformationSupplyChain(@PathVariable String serverName, @PathVariable String informationSupplyChainGUID, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/by-name") public OpenMetadataRootElementsResponse getInformationSupplyChainsByName(@PathVariable String serverName, @RequestParam(required=false,defaultValue="true") boolean addImplementation, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of information supply chains with a particular name.
      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

      @PostMapping(path="/information-supply-chains/by-search-string") public OpenMetadataRootElementsResponse findInformationSupplyChains(@PathVariable String serverName, @RequestParam(required=false,defaultValue="true") boolean addImplementation, @RequestBody(required=false) 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

      @PostMapping(path="/information-supply-chains/{informationSupplyChainGUID}/retrieve") public OpenMetadataRootElementResponse getInformationSupplyChainByGUID(@PathVariable String serverName, @PathVariable String informationSupplyChainGUID, @RequestParam(required=false,defaultValue="true") boolean addImplementation, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific information supply chain.
      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 - 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)

    • createSolutionBlueprint

      @PostMapping(path="/solution-blueprints") public GUIDResponse createSolutionBlueprint(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/solution-blueprints/from-template") public GUIDResponse createSolutionBlueprintFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/solution-blueprints/{solutionBlueprintGUID}/update") public BooleanResponse updateSolutionBlueprint(@PathVariable String serverName, @PathVariable String solutionBlueprintGUID, @RequestBody(required=false) 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

      @PostMapping(path="/elements/{parentGUID}/solution-designs/{solutionBlueprintGUID}/attach") public VoidResponse linkSolutionDesign(@PathVariable String serverName, @PathVariable String parentGUID, @PathVariable String solutionBlueprintGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a solution blueprint to the element that ir 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

      @PostMapping(path="/elements/{parentGUID}/solution-designs/{solutionBlueprintGUID}/detach") public VoidResponse detachSolutionDesign(@PathVariable String serverName, @PathVariable String parentGUID, @PathVariable String solutionBlueprintGUID, @RequestBody(required=false) 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

      @PostMapping(path="/solution-blueprints/{solutionBlueprintGUID}/delete") public VoidResponse deleteSolutionBlueprint(@PathVariable String serverName, @PathVariable String solutionBlueprintGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a solution blueprint.
      Parameters:
      serverName - name of called server
      solutionBlueprintGUID - 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.

    • getSolutionBlueprintsByName

      @PostMapping(path="/solution-blueprints/by-name") public OpenMetadataRootElementsResponse getSolutionBlueprintsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of solution blueprints with a particular name.
      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

      @PostMapping(path="/solution-blueprints/{solutionBlueprintGUID}/retrieve") public OpenMetadataRootElementResponse getSolutionBlueprintByGUID(@PathVariable String serverName, @PathVariable String solutionBlueprintGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific solution blueprint.
      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

      @PostMapping(path="/solution-blueprints/by-search-string") public OpenMetadataRootElementsResponse findSolutionBlueprints(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/solution-roles/{solutionRoleGUID}/solution-component-actors/{dataFieldGUID}/attach") public VoidResponse linkSolutionComponentActor(@PathVariable String serverName, @PathVariable String solutionRoleGUID, @PathVariable String dataFieldGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a solution component to a solution role.
      Parameters:
      serverName - name of called server
      solutionRoleGUID - unique identifier of the first solution role
      dataFieldGUID - unique identifier of the second solution 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.

    • detachSolutionComponentActor

      @PostMapping(path="/solution-roles/{solutionRoleGUID}/solution-component-actors/{solutionComponentGUID}/detach") public VoidResponse detachSolutionComponentActor(@PathVariable String serverName, @PathVariable String solutionRoleGUID, @PathVariable String solutionComponentGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a solution role.
      Parameters:
      serverName - name of called server
      solutionRoleGUID - unique identifier of the first solution role
      solutionComponentGUID - unique identifier of the second solution 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.

    • createSolutionComponent

      @PostMapping(path="/solution-components") public GUIDResponse createSolutionComponent(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/solution-components/from-template") public GUIDResponse createSolutionComponentFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/solution-components/{solutionComponentGUID}/update") public BooleanResponse updateSolutionComponent(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @RequestBody(required=false) 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

      @PostMapping(path="/solution-components/{solutionComponentGUID}/subcomponents/{subcomponentGUID}/attach") public VoidResponse linkSubcomponent(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @PathVariable String subcomponentGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a solution component to a nested solution component.
      Parameters:
      serverName - name of called server
      solutionComponentGUID - unique identifier of the first solution component
      subcomponentGUID - unique identifier of the second 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

      @PostMapping(path="/solution-components/{parentSolutionComponentGUID}/subcomponents/{subcomponentGUID}/detach") public VoidResponse detachSubcomponent(@PathVariable String serverName, @PathVariable String parentSolutionComponentGUID, @PathVariable String subcomponentGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a solution component.
      Parameters:
      serverName - name of called server
      parentSolutionComponentGUID - unique identifier of the first solution component
      subcomponentGUID - unique identifier of the second 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

      @PostMapping(path="/solution-components/{solutionComponentOneGUID}/wired-to/{solutionComponentTwoGUID}/attach") public GUIDResponse linkSolutionLinkingWire(@PathVariable String serverName, @PathVariable String solutionComponentOneGUID, @PathVariable String solutionComponentTwoGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a solution component to a solution component as a peer in a solution.
      Parameters:
      serverName - name of called server
      solutionComponentOneGUID - unique identifier of the first solution component
      solutionComponentTwoGUID - unique identifier of the second solution component
      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

      @PostMapping(path="/relationships/{relationshipGUID}/update") public VoidResponse updateSolutionLinkingWire(@PathVariable String serverName, @PathVariable String relationshipGUID, @RequestBody 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

    • detachAllSolutionLinkingWires

      @PostMapping(path="/solution-components/{solutionComponentOneGUID}/wired-to/{solutionComponentTwoGUID}/detach") public VoidResponse detachAllSolutionLinkingWires(@PathVariable String serverName, @PathVariable String solutionComponentOneGUID, @PathVariable String solutionComponentTwoGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Delete all solution linking wire relationships between two metadata elements.
      Parameters:
      serverName - name of called server
      solutionComponentOneGUID - unique identifier of the first solution component
      solutionComponentTwoGUID - unique identifier of the second 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.

    • detachSolutionLinkingWire

      @PostMapping(path="/solution-components/wires/{relationshipGUID}/detach") public VoidResponse detachSolutionLinkingWire(@PathVariable String serverName, @PathVariable String relationshipGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a solution component from a peer solution component.
      Parameters:
      serverName - name of called server
      relationshipGUID - unique identifier of the first 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.

    • deleteSolutionComponent

      @PostMapping(path="/solution-components/{solutionComponentGUID}/delete") public VoidResponse deleteSolutionComponent(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @RequestBody(required=false) 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

      @PostMapping(path="/solution-components/by-name") public OpenMetadataRootElementsResponse getSolutionComponentsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of solution components with a particular name.
      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)

    • findSolutionComponents

      @PostMapping(path="/solution-components/by-search-string") public OpenMetadataRootElementsResponse findSolutionComponents(@PathVariable String serverName, @RequestBody(required=false) 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)

    • getSolutionComponentByGUID

      @PostMapping(path="/solution-components/{solutionComponentGUID}/retrieve") public OpenMetadataRootElementResponse getSolutionComponentByGUID(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific solution component.
      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)

    • getSolutionComponentImplementations

      @PostMapping(path="/solution-components/{solutionComponentGUID}/implementations") public RelatedMetadataElementsResponse getSolutionComponentImplementations(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns") public GUIDResponse createDesignPattern(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/from-template") public GUIDResponse createDesignPatternFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{designPatternGUID}/update") public BooleanResponse updateDesignPattern(@PathVariable String serverName, @PathVariable String designPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{parentDesignPatternGUID}/nested-design-patterns/{nestedDesignPatternGUID}/attach") public VoidResponse linkNestedDesignPatterns(@PathVariable String serverName, @PathVariable String parentDesignPatternGUID, @PathVariable String nestedDesignPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{parentDesignPatternGUID}/nested-design-patterns/{nestedDesignPatternGUID}/detach") public VoidResponse detachNestedDesignPatterns(@PathVariable String serverName, @PathVariable String parentDesignPatternGUID, @PathVariable String nestedDesignPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{generalizedDesignPatternGUID}/specialized-design-patterns/{specializedDesignPatternGUID}/attach") public VoidResponse linkSpecializedDesignPatterns(@PathVariable String serverName, @PathVariable String generalizedDesignPatternGUID, @PathVariable String specializedDesignPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{generalizedDesignPatternGUID}/specialized-design-patterns/{specializedDesignPatternGUID}/detach") public VoidResponse detachSpecializedDesignPatterns(@PathVariable String serverName, @PathVariable String generalizedDesignPatternGUID, @PathVariable String specializedDesignPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{designPatternOneGUID}/related-design-patterns/{designPatternTwoGUID}/attach") public VoidResponse linkRelatedDesignPatterns(@PathVariable String serverName, @PathVariable String designPatternOneGUID, @PathVariable String designPatternTwoGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{designPatternOneGUID}/related-design-patterns/{designPatternTwoGUID}/detach") public VoidResponse detachRelatedDesignPatterns(@PathVariable String serverName, @PathVariable String designPatternOneGUID, @PathVariable String designPatternTwoGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{designPatternGUID}/delete") public VoidResponse deleteDesignPattern(@PathVariable String serverName, @PathVariable String designPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/by-name") public OpenMetadataRootElementsResponse getDesignPatternsByName(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/{designPatternGUID}") public OpenMetadataRootElementResponse getDesignPatternByGUID(@PathVariable String serverName, @PathVariable String designPatternGUID, @RequestBody(required=false) 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

      @PostMapping(path="/design-patterns/by-search-string") public OpenMetadataRootElementsResponse findDesignPatterns(@PathVariable String serverName, @RequestBody(required=false) 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

      @PostMapping(path="/concept-model-elements") public GUIDResponse createConceptModelElement(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      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)

    • createConceptModelElementFromTemplate

      @PostMapping(path="/concept-model-elements/from-template") public GUIDResponse createConceptModelElementFromTemplate(@PathVariable String serverName, @RequestBody(required=false) 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:
      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)

    • updateConceptModelElement

      @PostMapping(path="/concept-model-elements/{conceptModelElementGUID}/update") public BooleanResponse updateConceptModelElement(@PathVariable String serverName, @PathVariable String conceptModelElementGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      conceptModelElementGUID - unique identifier
      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)

    • deleteConceptModelElement

      @PostMapping(path="/concept-model-elements/{conceptModelElementGUID}/delete") public VoidResponse deleteConceptModelElement(@PathVariable String serverName, @PathVariable String conceptModelElementGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a concept model element.
      Parameters:
      serverName - name of the server to route the request to
      conceptModelElementGUID - unique identifier
      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)

    • getConceptModelElementsByName

      @PostMapping(path="/concept-model-elements/by-name") public OpenMetadataRootElementsResponse getConceptModelElementsByName(@PathVariable String serverName, @RequestBody(required=false) 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:
      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)

    • findConceptModelElements

      @PostMapping(path="/concept-model-elements/by-search-string") public OpenMetadataRootElementsResponse findConceptModelElements(@PathVariable String serverName, @RequestBody(required=false) 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:
      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)

    • getConceptModelElementByGUID

      @PostMapping(path="/concept-model-elements/{conceptModelElementGUID}/retrieve") public OpenMetadataRootElementResponse getConceptModelElementByGUID(@PathVariable String serverName, @PathVariable String conceptModelElementGUID, @RequestBody(required=false) 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
      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)

    • linkConceptDesign

      @PostMapping(path="/elements/{elementGUID}/concept-designs/{conceptModelGUID}/attach") public VoidResponse linkConceptDesign(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String conceptModelGUID, @RequestBody(required=false) 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
      conceptModelGUID - unique identifier
      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)

    • detachConceptDesign

      @PostMapping(path="/elements/{elementGUID}/concept-designs/{conceptModelGUID}/detach") public VoidResponse detachConceptDesign(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String conceptModelGUID, @RequestBody(required=false) 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
      conceptModelGUID - unique identifier
      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)

    • linkConceptBeadRelationshipEnd

      @PostMapping(path="/concept-bead-relationships/{conceptBeadRelationshipGUID}/relationship-ends/{conceptBeadGUID}/attach") public VoidResponse linkConceptBeadRelationshipEnd(@PathVariable String serverName, @PathVariable String conceptBeadRelationshipGUID, @PathVariable String conceptBeadGUID, @RequestBody(required=false) 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
      conceptBeadGUID - unique identifier
      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)

    • detachConceptBeadRelationshipEnd

      @PostMapping(path="/concept-bead-relationships/{conceptBeadRelationshipGUID}/relationship-ends/{conceptBeadGUID}/detach") public VoidResponse detachConceptBeadRelationshipEnd(@PathVariable String serverName, @PathVariable String conceptBeadRelationshipGUID, @PathVariable String conceptBeadGUID, @RequestBody(required=false) 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
      conceptBeadGUID - unique identifier
      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)

    • linkTypedByConceptBead

      @PostMapping(path="/concept-bead-attributes/{conceptBeadAttributeGUID}/typed-by/{conceptBeadGUID}/attach") public VoidResponse linkTypedByConceptBead(@PathVariable String serverName, @PathVariable String conceptBeadAttributeGUID, @PathVariable String conceptBeadGUID, @RequestBody(required=false) 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
      conceptBeadGUID - unique identifier
      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)

    • detachTypedByConceptBead

      @PostMapping(path="/concept-bead-attributes/{conceptBeadAttributeGUID}/typed-by/{conceptBeadGUID}/detach") public VoidResponse detachTypedByConceptBead(@PathVariable String serverName, @PathVariable String conceptBeadAttributeGUID, @PathVariable String conceptBeadGUID, @RequestBody(required=false) 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
      conceptBeadGUID - unique identifier
      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)

    • linkIsAConceptBead

      @PostMapping(path="/concept-beads/{inheritingBeadGUID}/is-a/{inheritedBeadGUID}/attach") public VoidResponse linkIsAConceptBead(@PathVariable String serverName, @PathVariable String inheritingBeadGUID, @PathVariable String inheritedBeadGUID, @RequestBody(required=false) 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
      inheritedBeadGUID - unique identifier
      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)

    • detachIsAConceptBead

      @PostMapping(path="/concept-beads/{inheritingBeadGUID}/is-a/{inheritedBeadGUID}/detach") public VoidResponse detachIsAConceptBead(@PathVariable String serverName, @PathVariable String inheritingBeadGUID, @PathVariable String inheritedBeadGUID, @RequestBody(required=false) 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
      inheritedBeadGUID - unique identifier
      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)

    • linkConceptBeadAttributeLink

      @PostMapping(path="/concept-beads/{conceptBeadGUID}/attribute-links/{conceptBeadAttributeGUID}/attach") public VoidResponse linkConceptBeadAttributeLink(@PathVariable String serverName, @PathVariable String conceptBeadGUID, @PathVariable String conceptBeadAttributeGUID, @RequestBody(required=false) 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
      conceptBeadAttributeGUID - unique identifier
      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)

    • detachConceptBeadAttributeLink

      @PostMapping(path="/concept-beads/{conceptBeadGUID}/attribute-links/{conceptBeadAttributeGUID}/detach") public VoidResponse detachConceptBeadAttributeLink(@PathVariable String serverName, @PathVariable String conceptBeadGUID, @PathVariable String conceptBeadAttributeGUID, @RequestBody(required=false) 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
      conceptBeadAttributeGUID - unique identifier
      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)

    • linkConceptBeadExtension

      @PostMapping(path="/concept-beads/{extendedBeadGUID}/extensions/{extensionBeadGUID}/attach") public VoidResponse linkConceptBeadExtension(@PathVariable String serverName, @PathVariable String extendedBeadGUID, @PathVariable String extensionBeadGUID, @RequestBody(required=false) 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
      extensionBeadGUID - unique identifier
      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)

    • detachConceptBeadExtension

      @PostMapping(path="/concept-beads/{extendedBeadGUID}/extensions/{extensionBeadGUID}/detach") public VoidResponse detachConceptBeadExtension(@PathVariable String serverName, @PathVariable String extendedBeadGUID, @PathVariable String extensionBeadGUID, @RequestBody(required=false) 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
      extensionBeadGUID - unique identifier
      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)

    • linkSolutionComponentPort

      @PostMapping(path="/solution-components/{solutionComponentGUID}/solution-ports/{solutionPortGUID}/attach") public VoidResponse linkSolutionComponentPort(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @PathVariable String solutionPortGUID, @RequestBody(required=false) 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 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)

    • detachSolutionComponentPort

      @PostMapping(path="/solution-components/{solutionComponentGUID}/solution-ports/{solutionPortGUID}/detach") public VoidResponse detachSolutionComponentPort(@PathVariable String serverName, @PathVariable String solutionComponentGUID, @PathVariable String solutionPortGUID, @RequestBody(required=false) 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 - 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)

    • linkSolutionPortDelegation

      @PostMapping(path="/solution-ports/{alignsToPortGUID}/port-delegations/{delegationPortGUID}/attach") public VoidResponse linkSolutionPortDelegation(@PathVariable String serverName, @PathVariable String alignsToPortGUID, @PathVariable String delegationPortGUID, @RequestBody(required=false) 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 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)

    • detachSolutionPortDelegation

      @PostMapping(path="/solution-ports/{alignsToPortGUID}/port-delegations/{delegationPortGUID}/detach") public VoidResponse detachSolutionPortDelegation(@PathVariable String serverName, @PathVariable String alignsToPortGUID, @PathVariable String delegationPortGUID, @RequestBody(required=false) 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 - 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)