Package org.odpi.openmetadata.viewservices.myprofile.server

Class MyProfileRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.myprofile.server.MyProfileRESTServices
public class MyProfileRESTServices extends TokenController
The MyProfileRESTServices provides the server-side implementation of the My Profile Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • MyProfileRESTServices

      public MyProfileRESTServices()
      Default constructor

  • Method Details

    • getMyProfile

      public OpenMetadataRootElementResponse getMyProfile(String serverName)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      Returns:
      profile response object or null or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createAction

      public GUIDResponse createAction(String serverName, ActionRequestBody requestBody)
      Create a new to do action and link it to the supplied role and targets (if applicable).
      Parameters:
      serverName - name of the server instances for this request
      requestBody - properties of the to do action
      Returns:
      unique identifier of the to do or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • updateAction

      public VoidResponse updateAction(String serverName, String actionGUID, UpdateElementRequestBody requestBody)
      Update the properties associated with a "To Do".
      Parameters:
      serverName - name of the server instances for this request
      actionGUID - unique identifier of the to do
      requestBody - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • updateActionTargetProperties

      public VoidResponse updateActionTargetProperties(String serverName, String actionTargetGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties associated with an Action Target.
      Parameters:
      serverName - name of the server instances for this request
      actionTargetGUID - unique identifier of the action target relationship
      requestBody - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • reassignAction

      public VoidResponse reassignAction(String serverName, String actionGUID, String actorGUID, UpdateRelationshipRequestBody requestBody)
      Assign an action to a new actor.
      Parameters:
      serverName - name of the server instances for this request
      actionGUID - unique identifier of the to do
      actorGUID - actor to assign the action to
      requestBody - null request body
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • deleteAction

      public VoidResponse deleteAction(String serverName, String actionGUID, DeleteElementRequestBody requestBody)
      Delete an existing action.
      Parameters:
      serverName - name of the server instances for this request
      actionGUID - unique identifier of the to do
      requestBody - null request body
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionByGUID

      public OpenMetadataRootElementResponse getActionByGUID(String serverName, String actionGUID)
      Retrieve a action by unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      actionGUID - unique identifier of the to do
      Returns:
      to do bean or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForActionTarget

      public OpenMetadataRootElementsResponse getActionsForActionTarget(String serverName, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the "To Dos" that are chained off of an action target element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element to start with
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForSponsor

      public OpenMetadataRootElementsResponse getActionsForSponsor(String serverName, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the "To Dos" that are chained off of a sponsoring element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element to start with
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssignedActions

      public OpenMetadataRootElementsResponse getAssignedActions(String serverName, String actorGUID, ActivityStatusRequestBody requestBody)
      Retrieve the "To Dos" for a particular actor.
      Parameters:
      serverName - name of the server instances for this request
      actorGUID - unique identifier of the role
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • findActions

      public OpenMetadataRootElementsResponse findActions(String serverName, ActivityStatusSearchString requestBody)
      Retrieve the "To Dos" that match the search string.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsByCategory

      public OpenMetadataRootElementsResponse getActionsByCategory(String serverName, ActivityStatusFilterRequestBody requestBody)
      Retrieve the "To Dos" that match the category name and status.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call