Package org.odpi.openmetadata.accessservices.stewardshipaction.server.spring

Class StewardshipActionResource

  • @RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/stewardship-action/users/{userId}")
public class StewardshipActionResource
extends Object
    The StewardshipActionResource provides the server-side implementation of the Stewardship Action Open Metadata Assess Service (OMAS).

    • Constructor Detail

      • StewardshipActionResource

        public StewardshipActionResource()
        Default constructor

    • Method Detail

      • getOutTopicConnection

        @GetMapping(path="/topics/out-topic-connection/{callerId}")
public ConnectionResponse getOutTopicConnection​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String callerId)
        Return the connection object for the Stewardship Action OMAS's out topic.
        Parameters:
        serverName - name of the server to route the request to
        userId - identifier of calling user
        callerId - unique identifier of the caller
        Returns:
        connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

      • linkElementsAsDuplicates

        @PostMapping(path="/elements/{element1GUID}/peer-duplicate-of/{element2GUID}")
public VoidResponse linkElementsAsDuplicates​(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String element1GUID,
                                             @PathVariable
                                             String element2GUID,
                                             @RequestBody
                                             DuplicatesRequestBody requestBody)
        Create a simple relationship between two elements. These elements must be of the same type. If the relationship already exists, the properties are updated.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        element1GUID - unique identifier of first element
        element2GUID - unique identifier of second element
        requestBody - parameters for the relationship
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • unlinkElementsAsDuplicates

        @PostMapping(path="/elements/{element1GUID}/peer-duplicate-of/{element2GUID}/delete")
public VoidResponse unlinkElementsAsDuplicates​(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String element1GUID,
                                               @PathVariable
                                               String element2GUID,
                                               @RequestBody(required=false)
                                               NullRequestBody requestBody)
        Remove the relationship between two elements that marks them as duplicates.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        element1GUID - unique identifier of first element
        element2GUID - unique identifier of second element
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • markElementAsKnownDuplicate

        @PostMapping(path="/elements/{elementGUID}/known-duplicate")
public VoidResponse markElementAsKnownDuplicate​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String elementGUID,
                                                @RequestBody(required=false)
                                                NullRequestBody requestBody)
        Classify an element as a known duplicate. This will mean that it is included in duplicate processing during metadata retrieval requests.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        elementGUID - unique identifier of the element
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid, or the elements are of different types PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • unmarkElementAsKnownDuplicate

        @PostMapping(path="/elements/{elementGUID}/known-duplicate/delete")
public VoidResponse unmarkElementAsKnownDuplicate​(@PathVariable
                                                  String serverName,
                                                  @PathVariable
                                                  String userId,
                                                  @PathVariable
                                                  String elementGUID,
                                                  @RequestBody(required=false)
                                                  NullRequestBody requestBody)
        Remove the classification that identifies this element as a known duplicate.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        elementGUID - unique identifier of the element
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getPeerDuplicates

        @GetMapping(path="/elements/{elementGUID}/peer-duplicates")
public DuplicatesResponse getPeerDuplicates​(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String elementGUID,
                                            @RequestParam
                                            int startFrom,
                                            @RequestParam
                                            int pageSize)
        List the elements that are linked as peer duplicates to the requested element.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        elementGUID - element to query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of linked duplicates or InvalidParameterException one of the parameters is null or invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • markAsConsolidatedDuplicate

        @PostMapping(path="/elements/{consolidatedDuplicateGUID}/consolidated-duplicate")
public VoidResponse markAsConsolidatedDuplicate​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String consolidatedDuplicateGUID,
                                                @RequestBody
                                                DuplicatesRequestBody requestBody)
        Mark an element as a consolidated duplicate (or update the properties if it is already marked as such). This method assumes that a standard create method has been used to create the element first using the values from contributing elements. It is just adding the ConsolidatedDuplicate classification to the element.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of the element that contains the consolidated information from a collection of elements that are all duplicates of one another.
        requestBody - properties for the relationship
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • linkElementToConsolidatedDuplicate

        @PostMapping(path="/elements/consolidated-duplicate/{consolidatedDuplicateGUID}/contributing-element/{contributingElementGUID}")
public VoidResponse linkElementToConsolidatedDuplicate​(@PathVariable
                                                       String serverName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String consolidatedDuplicateGUID,
                                                       @PathVariable
                                                       String contributingElementGUID,
                                                       @RequestBody(required=false)
                                                       NullRequestBody requestBody)
        Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.
        Parameters:
        serverName - name of the service to route the request to
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of consolidated duplicate
        contributingElementGUID - unique identifier of duplicate element
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • unlinkElementFromConsolidatedDuplicate

        @PostMapping(path="/elements/consolidated-duplicate/{consolidatedDuplicateGUID}/contributing-element/{contributingElementGUID}/delete")
public VoidResponse unlinkElementFromConsolidatedDuplicate​(@PathVariable
                                                           String serverName,
                                                           @PathVariable
                                                           String userId,
                                                           @PathVariable
                                                           String consolidatedDuplicateGUID,
                                                           @PathVariable
                                                           String contributingElementGUID,
                                                           @RequestBody(required=false)
                                                           NullRequestBody requestBody)
        Remove the relationship between two elements that marks them as duplicates.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of consolidated duplicate
        contributingElementGUID - unique identifier of duplicate element
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getContributingDuplicates

        @GetMapping(path="/elements/consolidated-duplicate/{consolidatedDuplicateGUID}/contributing-elements")
public ElementStubsResponse getContributingDuplicates​(@PathVariable
                                                      String serverName,
                                                      @PathVariable
                                                      String userId,
                                                      @PathVariable
                                                      String consolidatedDuplicateGUID,
                                                      @RequestParam
                                                      int startFrom,
                                                      @RequestParam
                                                      int pageSize)
        List the elements that are contributing to a consolidating duplicate element.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        consolidatedDuplicateGUID - element to query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of contributing duplicates or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • getConsolidatedDuplicate

        @GetMapping(path="/elements/{elementGUID}/consolidated-duplicate")
public ElementStubResponse getConsolidatedDuplicate​(@PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String elementGUID)
        Return details of the consolidated duplicate for a requested element.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        elementGUID - element to query
        Returns:
        header of consolidated duplicated or null if none or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

      • removeConsolidatedDuplicate

        @PostMapping(path="/elements/{consolidatedDuplicateGUID}/consolidated-duplicate/delete")
public VoidResponse removeConsolidatedDuplicate​(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String consolidatedDuplicateGUID,
                                                @RequestBody(required=false)
                                                NullRequestBody requestBody)
        Remove the consolidated duplicate element and the links to the elements that contributed to its values.
        Parameters:
        serverName - name of the service to route the request to.
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of element to remove
        requestBody - null request body
        Returns:
        void or InvalidParameterException one of the parameters is null or invalid or the elements are not linked as duplicates PropertyServerException problem accessing property server UserNotAuthorizedException security access problem