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

Class StewardshipActionResource

java.lang.Object
org.odpi.openmetadata.accessservices.stewardshipaction.server.spring.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 Summary

    Constructors
    Constructor
    Description
    StewardshipActionResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubResponse
    getConsolidatedDuplicate(String serverName, String userId, String elementGUID)
    Return details of the consolidated duplicate for a requested element.
    org.odpi.openmetadata.commonservices.ffdc.rest.ElementStubsResponse
    getContributingDuplicates(String serverName, String userId, String consolidatedDuplicateGUID, int startFrom, int pageSize)
    List the elements that are contributing to a consolidating duplicate element.
    org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse
    getOutTopicConnection(String serverName, String userId, String callerId)
    Return the connection object for the Stewardship Action OMAS's out topic.
    org.odpi.openmetadata.commonservices.ffdc.rest.DuplicatesResponse
    getPeerDuplicates(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
    List the elements that are linked as peer duplicates to the requested element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkElementsAsDuplicates(String serverName, String userId, String element1GUID, String element2GUID, org.odpi.openmetadata.commonservices.ffdc.rest.DuplicatesRequestBody requestBody)
    Create a simple relationship between two elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkElementToConsolidatedDuplicate(String serverName, String userId, String consolidatedDuplicateGUID, String contributingElementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    markAsConsolidatedDuplicate(String serverName, String userId, String consolidatedDuplicateGUID, org.odpi.openmetadata.commonservices.ffdc.rest.DuplicatesRequestBody requestBody)
    Mark an element as a consolidated duplicate (or update the properties if it is already marked as such).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    markElementAsKnownDuplicate(String serverName, String userId, String elementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Classify an element as a known duplicate.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConsolidatedDuplicate(String serverName, String userId, String consolidatedDuplicateGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the consolidated duplicate element and the links to the elements that contributed to its values.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unlinkElementFromConsolidatedDuplicate(String serverName, String userId, String consolidatedDuplicateGUID, String contributingElementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the relationship between two elements that marks them as duplicates.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unlinkElementsAsDuplicates(String serverName, String userId, String element1GUID, String element2GUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the relationship between two elements that marks them as duplicates.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unmarkElementAsKnownDuplicate(String serverName, String userId, String elementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the classification that identifies this element as a known duplicate.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StewardshipActionResource

      public StewardshipActionResource()
      Default constructor

  • Method Details

    • getOutTopicConnection

      @GetMapping(path="/topics/out-topic-connection/{callerId}") public org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkElementsAsDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unlinkElementsAsDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse markElementAsKnownDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unmarkElementAsKnownDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse markAsConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String consolidatedDuplicateGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkElementToConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String consolidatedDuplicateGUID, @PathVariable String contributingElementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unlinkElementFromConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String consolidatedDuplicateGUID, @PathVariable String contributingElementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConsolidatedDuplicate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String consolidatedDuplicateGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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