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 Details

    • MyProfileResource

      public MyProfileResource()
      Default constructor

  • Method Details

    • getMyProfile

      @GetMapping(path="") public OpenMetadataRootElementResponse 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 a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyProfile

      @PostMapping(path="") public OpenMetadataRootElementResponse getMyProfile(@PathVariable String serverName, @RequestBody(required=false) GetRequestBody requestBody)
      Return the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyAssignedActions

      @PostMapping(path="/assigned-actions") public OpenMetadataRootElementsResponse getMyAssignedActions(@PathVariable String serverName, @RequestParam(value="includeUserIds",required=false,defaultValue="true") boolean includeUserIds, @RequestParam(value="includeRoles",required=false,defaultValue="true") boolean includeRoles, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Return the list of actions that have been assigned to the user's profile, roles, or user identity
      Parameters:
      serverName - name of the server instances for this request
      includeUserIds - get actions for linked userIds
      includeRoles - get actions for linked roles
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMySponsoredActions

      @PostMapping(path="/sponsored-actions") public OpenMetadataRootElementsResponse getMySponsoredActions(@PathVariable String serverName, @RequestParam(value="includeUserIds",required=false,defaultValue="true") boolean includeUserIds, @RequestParam(value="includeRoles",required=false,defaultValue="true") boolean includeRoles, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Return the list of actions linked to the user's profile, roles, or user identity that this user has sponsored.
      Parameters:
      serverName - name of the server instances for this request
      includeUserIds - get actions for linked userIds
      includeRoles - get actions for linked roles
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyRequestedActions

      @PostMapping(path="/requested-actions") public OpenMetadataRootElementsResponse getMyRequestedActions(@PathVariable String serverName, @RequestParam(value="includeUserIds",required=false,defaultValue="true") boolean includeUserIds, @RequestParam(value="includeRoles",required=false,defaultValue="true") boolean includeRoles, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Return the list of actions linked to the user's profile, roles, or user identity that this user has requested.
      Parameters:
      serverName - name of the server instances for this request
      includeUserIds - get actions for linked userIds
      includeRoles - get actions for linked roles
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyActors

      @PostMapping(path="/actors") public OpenMetadataRootElementsResponse getMyActors(@PathVariable String serverName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return the list of actors linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyUserIdentities

      @PostMapping(path="/actors/user-identities") public OpenMetadataRootElementsResponse getMyUserIdentities(@PathVariable String serverName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return the list of user identities linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyRoles

      @PostMapping(path="/actors/assigned-roles") public OpenMetadataRootElementsResponse getMyRoles(@PathVariable String serverName, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return the list of assigned roles linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getMyResources

      @PostMapping(path="/assigned-resources") public OpenMetadataRootElementsResponse getMyResources(@PathVariable String serverName, @RequestParam(value="includeUserIds",required=false,defaultValue="true") boolean includeUserIds, @RequestParam(value="includeRoles",required=false,defaultValue="true") boolean includeRoles, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return the list of assigned resources linked to the user's profile.
      Parameters:
      serverName - name of the server instances for this request
      includeUserIds - get actions for linked userIds
      includeRoles - get actions for linked roles
      requestBody - optional properties to restrict search by and control how the results are formatted
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • logMyActivity

      @PostMapping(path="/log-my-activity") public GUIDResponse logMyActivity(@PathVariable String serverName, @RequestBody(required=false) NewAttachmentRequestBody requestBody)
      Add the supplied notification to the user's activity log.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - details of the user profile to add
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • journalMyActivity

      @PostMapping(path="/journal-my-activity") public GUIDResponse journalMyActivity(@PathVariable String serverName, @RequestBody(required=false) NewAttachmentRequestBody requestBody)
      Add the supplied notification to the user's journal.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - details of the user profile to add
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • blogMyActivity

      @PostMapping(path="/blog-my-activity") public GUIDResponse blogMyActivity(@PathVariable String serverName, @RequestBody(required=false) NewAttachmentRequestBody requestBody)
      Add the supplied notification to the user's blog.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - details of the user profile to add
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addMyProfile

      @PostMapping(path="/new") public GUIDResponse addMyProfile(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Add the profile for this user.
      Parameters:
      serverName - name of the server instances for this request
      requestBody - details of the user profile to add
      Returns:
      profile response object or InvalidParameterException the userId is null or invalid or PropertyServerException a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.