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

Class OrganizationResource

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.server.spring.OrganizationResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/community-profile/users/{userId}")
public class OrganizationResource
extends Object

The OrganizationResource provides a Spring based server-side REST API that supports the OrganizationManagementInterface. It delegates each request to the OrganizationRESTServices. This provides the server-side implementation of the Community Profile Open Metadata Assess Service (OMAS) which is used to manage information about people, roles and organizations.

Constructor Summary

Constructors

Constructor	Description
OrganizationResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
ActorProfileGraphResponse	getActorProfileByUserId(String serverName, String userId, String actorProfileUserId)	Return information about a specific actor profile.
ActorRoleResponse	getPersonRoleByGUID(String serverName, String userId, String personRoleGUID)	Return information about a specific person role.

Methods inherited from class java.lang.Object

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

Constructor Details

OrganizationResource

public OrganizationResource()

Default constructor

Method Details

getActorProfileByUserId

@GetMapping(path="/profiles/user-ids/{actorProfileUserId}")
public ActorProfileGraphResponse getActorProfileByUserId(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String actorProfileUserId)

Return information about a specific actor profile.

Parameters:

serverName - called server

userId - calling user

actorProfileUserId - unique identifier for the userId

Returns:

properties of the actor profile InvalidParameterException actorProfileUserId or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

getPersonRoleByGUID

@GetMapping(path="/person-roles/{personRoleGUID}")
public ActorRoleResponse getPersonRoleByGUID(@PathVariable
 String serverName,
 @PathVariable
 String userId,
 @PathVariable
 String personRoleGUID)

Return information about a specific person role.

Parameters:

serverName - called server

userId - calling user

personRoleGUID - unique identifier for the person role

Returns:

properties of the person role InvalidParameterException personRoleGUID or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem