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
GUIDResponse	addMyProfile(String serverName, NewElementRequestBody requestBody)	Add the profile for this user.
OpenMetadataRootElementResponse	getMyProfile(String serverName)	Return the profile for this user.

Methods inherited from class java.lang.Object

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

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 there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addMyProfile

@PostMapping(path="")
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

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.