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

Class MyProfileResource

java.lang.Object
org.odpi.openmetadata.viewservices.myprofile.server.spring.MyProfileResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/my-profile") public class MyProfileResource extends Object
The MyProfileResource provides part of the server-side implementation of the My Profile OMVS. =

  • Constructor Summary

    Constructors
    Constructor
    Description
    MyProfileResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createToDo(String serverName, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoRequestBody requestBody)
    Create a new to do action and link it to the supplied actor and targets (if applicable).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteToDo(String serverName, String toDoGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Delete an existing to do.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse
    findToDos(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusSearchString requestBody)
    Retrieve the "To Dos" that match the search string.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse
    getActionsForActionTarget(String serverName, String elementGUID, int startFrom, int pageSize, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
    Retrieve the "To Dos" that are chained off of an action target element.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse
    getActionsForSponsor(String serverName, String elementGUID, int startFrom, int pageSize, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
    Retrieve the "To Dos" that are chained off of a sponsor's element.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse
    getAssignedActions(String serverName, String actorGUID, int startFrom, int pageSize, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
    Retrieve the "To Dos" for a particular actor.
    org.odpi.openmetadata.viewservices.myprofile.rest.PersonalProfileResponse
    getMyProfile(String serverName)
    Return the profile for this user.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoResponse
    getToDo(String serverName, String toDoGUID)
    Retrieve a "To Do" by unique identifier.
    org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse
    getToDosByType(String serverName, String toDoType, int startFrom, int pageSize, org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
    Retrieve the "To Dos" that match the type name and status.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    reassignToDo(String serverName, String toDoGUID, String actorGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Assign a "To Do" to a new actor.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateActionTargetProperties(String serverName, String actionTargetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.properties.ActionTargetProperties actionTargetProperties)
    Update the properties associated with an Action Target for a "To Do".
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateToDo(String serverName, String toDoGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.communityprofile.properties.ToDoProperties toDoProperties)
    Update the properties associated with a "To Do".

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MyProfileResource

      public MyProfileResource()
      Default constructor

  • Method Details

    • getMyProfile

      @GetMapping(path="") public org.odpi.openmetadata.viewservices.myprofile.rest.PersonalProfileResponse getMyProfile(@PathVariable String serverName)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      Returns:
      profile response object 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.

    • createToDo

      @PostMapping(path="/to-dos") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createToDo(@PathVariable String serverName, @RequestBody org.odpi.openmetadata.viewservices.myprofile.rest.ToDoRequestBody requestBody)
      Create a new to do action and link it to the supplied actor 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

    • updateToDo

      @PostMapping(path="/to-dos/{toDoGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateToDo(@PathVariable String serverName, @PathVariable String toDoGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.properties.ToDoProperties toDoProperties)
      Update the properties associated with a "To Do".
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - unique identifier of the to do
      isMergeUpdate - should the toDoProperties overlay the existing stored properties or replace them
      toDoProperties - 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

      @PostMapping(path="/to-dos/action-targets/{actionTargetGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateActionTargetProperties(@PathVariable String serverName, @PathVariable String actionTargetGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.accessservices.communityprofile.properties.ActionTargetProperties actionTargetProperties)
      Update the properties associated with an Action Target for a "To Do".
      Parameters:
      serverName - name of the server instances for this request
      actionTargetGUID - unique identifier of the action target relationship
      isMergeUpdate - should the actionTargetProperties overlay the existing stored properties or replace them
      actionTargetProperties - 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

    • reassignToDo

      @PostMapping(path="/to-dos/{toDoGUID}/reassign/{actorGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse reassignToDo(@PathVariable String serverName, @PathVariable String toDoGUID, @PathVariable String actorGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Assign a "To Do" to a new actor. This will unassign all other actors previously assigned to the to do.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - 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

    • deleteToDo

      @PostMapping(path="/to-dos/{toDoGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteToDo(@PathVariable String serverName, @PathVariable String toDoGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Delete an existing to do.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - 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

    • getToDo

      @GetMapping(path="/to-dos/{toDoGUID}") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoResponse getToDo(@PathVariable String serverName, @PathVariable String toDoGUID)
      Retrieve a "To Do" by unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      toDoGUID - 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

      @PostMapping(path="/elements/{elementGUID}/action-targets/to-dos") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse getActionsForActionTarget(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody 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
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      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

      @PostMapping(path="/elements/{elementGUID}/sponsored/to-dos") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse getActionsForSponsor(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" that are chained off of a sponsor's element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element to start with
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      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

      @PostMapping(path="/actors/{actorGUID}/assigned/to-dos") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse getAssignedActions(@PathVariable String serverName, @PathVariable String actorGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody 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
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      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

    • findToDos

      @PostMapping(path="/to-dos/find-by-search-string") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse findToDos(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusSearchString requestBody)
      Retrieve the "To Dos" that match the search string.
      Parameters:
      serverName - name of the server instances for this request
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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

    • getToDosByType

      @PostMapping(path="/to-dos/types/{toDoType}") public org.odpi.openmetadata.viewservices.myprofile.rest.ToDoListResponse getToDosByType(@PathVariable String serverName, @PathVariable String toDoType, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) org.odpi.openmetadata.viewservices.myprofile.rest.ToDoStatusRequestBody requestBody)
      Retrieve the "To Dos" that match the type name and status.
      Parameters:
      serverName - name of the server instances for this request
      toDoType - type to search for
      startFrom - initial position of the results to return
      pageSize - maximum number of results to return
      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