org.odpi.openmetadata.accessservices.governanceprogram.server.spring

Class GovernanceLeadershipResource

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.server.spring.GovernanceLeadershipResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/governance-program/users/{userId}/leadership")
public class GovernanceLeadershipResource
extends Object

The GovernanceProgramOMASGovernanceLeadershipResource provides a Spring based server-side REST API that supports the GovernanceLeadershipInterface. It delegates each request to the GovernanceProgramRESTServices. This provides the server-side implementation of the Governance Program Open Metadata Assess Service (OMAS) which is used to manage the full lifecycle of a governance program.

Constructor Summary

Constructors

Constructor and Description
GovernanceLeadershipResource() Default constructor

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	appointGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody) Link a person to a governance officer.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GUIDResponse	createGovernanceOfficer(String serverName, String userId, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerDetailsRequestBody requestBody) Create the governance officer appointment.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GUIDResponse	createPersonalProfile(String serverName, String userId, org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalDetailsRequestBody requestBody) Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	deleteGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerValidatorRequestBody requestBody) Remove the requested governance officer.
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	deletePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileValidatorRequestBody requestBody) Delete the personal profile.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse	getActiveGovernanceOfficers(String serverName, String userId) Return all of the active governance officers.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerResponse	getGovernanceOfficerByAppointmentId(String serverName, String userId, String appointmentId) Retrieve a governance officer by unique appointment id.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerResponse	getGovernanceOfficerByGUID(String serverName, String userId, String governanceOfficerGUID) Retrieve a governance officer description by unique guid.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse	getGovernanceOfficers(String serverName, String userId) Return all of the defined governance officers.
org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse	getGovernanceOfficersByDomain(String serverName, String userId, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceDomainRequestBody requestBody) Return all of the defined governance officers for a specific governance domain.
org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileResponse	getPersonalProfileByEmployeeNumber(String serverName, String userId, String employeeNumber) Retrieve a personal profile by personnel/serial/unique employee number of the individual.
org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileResponse	getPersonalProfileByGUID(String serverName, String userId, String profileGUID) Retrieve a personal profile by guid.
org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileListResponse	getPersonalProfilesByName(String serverName, String userId, String name) Return a list of candidate personal profiles for an individual.
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	relieveGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody) Unlink a person from a governance officer appointment.
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	updateGovernanceOfficer(String serverName, String userId, String governanceOfficerGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerDetailsRequestBody requestBody) Update selected fields for the governance officer.
org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse	updatePersonalProfile(String serverName, String userId, String profileGUID, org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalDetailsRequestBody requestBody) Update properties for the personal properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceLeadershipResource

public GovernanceLeadershipResource()

Default constructor

Method Detail

createPersonalProfile

@RequestMapping(method=POST,
                path="/personal-profiles")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GUIDResponse createPersonalProfile(@PathVariable
                                                                                                                                                                              String serverName,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @RequestBody
                                                                                                                                                                              org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalDetailsRequestBody requestBody)

Create a personal profile for an individual who is to be appointed to a governance role but does not have a profile in open metadata.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

requestBody - properties about the individual.

Returns:

Unique identifier for the personal profile or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

updatePersonalProfile

@RequestMapping(method=POST,
                path="/personal-profiles/{profileGUID}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse updatePersonalProfile(@PathVariable
                                                                                                                                                                                            String serverName,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String profileGUID,
                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                            org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalDetailsRequestBody requestBody)

Update properties for the personal properties. Null values result in empty fields in the profile.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

requestBody - properties about the individual.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or InvalidParameterException the full name is null or the employeeNumber does not match the profileGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

deletePersonalProfile

@RequestMapping(method=POST,
                path="/personal-profiles/{profileGUID}/delete")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse deletePersonalProfile(@PathVariable
                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                   String profileGUID,
                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileValidatorRequestBody requestBody)

Delete the personal profile.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

requestBody - personnel/serial/unique employee number of the individual.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or InvalidParameterException the employee number or full name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfileByGUID

@RequestMapping(method=GET,
                path="/personal-profiles/{profileGUID}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileResponse getPersonalProfileByGUID(@PathVariable
                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                         String profileGUID)

Retrieve a personal profile by guid.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

profileGUID - unique identifier for the profile.

Returns:

personal profile object or UnrecognizedGUIDException the unique identifier of the personal profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfileByEmployeeNumber

@RequestMapping(method=GET,
                path="/personal-profiles/by-employee-number/{employeeNumber}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileResponse getPersonalProfileByEmployeeNumber(@PathVariable
                                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                                         String employeeNumber)

Retrieve a personal profile by personnel/serial/unique employee number of the individual.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

employeeNumber - personnel/serial/unique employee number of the individual.

Returns:

personal profile object or InvalidParameterException the employee number is null or EmployeeNumberNotUniqueException more than one personal profile was found or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getPersonalProfilesByName

@RequestMapping(method=GET,
                path="/personal-profiles/by-name/{name}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.PersonalProfileListResponse getPersonalProfilesByName(@PathVariable
                                                                                                                                                                                                               String serverName,
                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                               String userId,
                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                               String name)

Return a list of candidate personal profiles for an individual. It matches on full name and known name. The name may include wild card parameters.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

name - name of individual.

Returns:

list of personal profile objects or InvalidParameterException the name is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

createGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GUIDResponse createGovernanceOfficer(@PathVariable
                                                                                                                                                                                  String serverName,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String userId,
                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                  org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerDetailsRequestBody requestBody)

Create the governance officer appointment.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

requestBody - properties of the governance officer.

Returns:

Unique identifier (guid) of the governance officer or InvalidParameterException the governance domain or appointment id is null or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

updateGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse updateGovernanceOfficer(@PathVariable
                                                                                                                                                                                                          String serverName,
                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                          String governanceOfficerGUID,
                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                          org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerDetailsRequestBody requestBody)

Update selected fields for the governance officer.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - properties of the governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the title is null or the governanceDomain/appointmentId does not match the the existing values associated with the governanceOfficerGUID or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

deleteGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/delete")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse deleteGovernanceOfficer(@PathVariable
                                                                                                                                                                                                                 String serverName,
                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                 String governanceOfficerGUID,
                                                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                                                 org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerValidatorRequestBody requestBody)

Remove the requested governance officer.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - properties to verify this is the right governance officer

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or InvalidParameterException the appointmentId or governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByGUID

@RequestMapping(method=GET,
                path="/governance-officers/{governanceOfficerGUID}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerResponse getGovernanceOfficerByGUID(@PathVariable
                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String governanceOfficerGUID)

Retrieve a governance officer description by unique guid.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

Returns:

governance officer object or UnrecognizedGUIDException the unique identifier of the governance officer is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficerByAppointmentId

@RequestMapping(method=GET,
                path="/governance-officers/by-appointment-id/{appointmentId}")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerResponse getGovernanceOfficerByAppointmentId(@PathVariable
                                                                                                                                                                                                                                            String serverName,
                                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                                            String appointmentId)

Retrieve a governance officer by unique appointment id.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

appointmentId - the unique appointment identifier of the governance officer.

Returns:

governance officer object or InvalidParameterException the appointmentId or governance domain is either null or invalid or AppointmentIdNotUniqueException more than one governance officer entity was retrieved for this appointmentId PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficers

@RequestMapping(method=GET,
                path="/governance-officers")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse getGovernanceOfficers(@PathVariable
                                                                                                                                                                                                String serverName,
                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                String userId)

Return all of the defined governance officers.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getActiveGovernanceOfficers

@RequestMapping(method=GET,
                path="/governance-officers/active")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse getActiveGovernanceOfficers(@PathVariable
                                                                                                                                                                                                             String serverName,
                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                             String userId)

Return all of the active governance officers.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

Returns:

list of governance officer objects or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

getGovernanceOfficersByDomain

@RequestMapping(method=POST,
                path="/governance-officers/by-domain")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceOfficerListResponse getGovernanceOfficersByDomain(@PathVariable
                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.governanceprogram.rest.GovernanceDomainRequestBody requestBody)

Return all of the defined governance officers for a specific governance domain. In a small organization there is typically only one governance officer. However a large organization may have multiple governance officers, each with a different scope. The governance officer with a null scope is the overall leader.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

requestBody - domain of interest

Returns:

list of governance officer objects or InvalidParameterException the governance domain is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

appointGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/appoint")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse appointGovernanceOfficer(@PathVariable
                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String governanceOfficerGUID,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)

Link a person to a governance officer. Only one person may be appointed at any one time.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - unique identifier for the profile and start date.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.

relieveGovernanceOfficer

@RequestMapping(method=POST,
                path="/governance-officers/{governanceOfficerGUID}/relieve")
public org.odpi.openmetadata.accessservices.governanceprogram.rest.VoidResponse relieveGovernanceOfficer(@PathVariable
                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String governanceOfficerGUID,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.governanceprogram.rest.AppointmentRequestBody requestBody)

Unlink a person from a governance officer appointment.

Parameters:

serverName - name of server instance to call

userId - the name of the calling user.

governanceOfficerGUID - unique identifier (guid) of the governance officer.

requestBody - unique identifier for the profile and end date.

Returns:

void response or UnrecognizedGUIDException the unique identifier of the governance officer or profile is either null or invalid or InvalidParameterException the profile is not linked to this governance officer or PropertyServerException the server is not available or UserNotAuthorizedException the calling user is not authorized to issue the call.