@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/governance-program/users/{userId}/leadership")
public class GovernanceRolesResource
extends Object
| Constructor and Description |
|---|
GovernanceRolesResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
appointGovernanceRole(String serverName,
String userId,
String governanceRoleGUID,
AppointmentRequestBody requestBody)
Link a person to a governance role.
|
GUIDResponse |
createGovernanceRole(String serverName,
String userId,
GovernanceRoleProperties requestBody)
Create the governance role appointment.
|
VoidResponse |
deleteGovernanceRole(String serverName,
String userId,
String governanceRoleGUID,
NullRequestBody requestBody)
Remove the requested governance role.
|
GovernanceRoleAppointeeListResponse |
getCurrentGovernanceRoleAppointments(String serverName,
String userId,
int domainIdentifier,
int startFrom,
int pageSize)
Return all of the governance roles and their incumbents (if any).
|
GovernanceRoleResponse |
getGovernanceRoleByGUID(String serverName,
String userId,
String governanceRoleGUID)
Retrieve a governance role description by unique guid.
|
GovernanceRoleListResponse |
getGovernanceRoleByRoleId(String serverName,
String userId,
String roleId)
Retrieve the properties of a governance role using its unique name.
|
GovernanceRoleHistoryResponse |
getGovernanceRoleHistoryByGUID(String serverName,
String userId,
String governanceRoleGUID)
Retrieve a governance role description by unique guid along with the history of who has been appointed
to the role.
|
GovernanceRoleListResponse |
getGovernanceRolesByDomainId(String serverName,
String userId,
int domainIdentifier,
int startFrom,
int pageSize)
Return all of the defined governance roles.
|
GovernanceRoleListResponse |
getGovernanceRolesByTitle(String serverName,
String userId,
String title,
int startFrom,
int pageSize)
Retrieve all of the governance roles for a particular title.
|
VoidResponse |
linkRoleToResource(String serverName,
String userId,
String governanceRoleGUID,
String resourceGUID,
NullRequestBody requestBody)
Link a governance role to the description of a resource that the role is responsible for.
|
VoidResponse |
linkRoleToResponsibility(String serverName,
String userId,
String governanceRoleGUID,
String responsibilityGUID,
NullRequestBody requestBody)
Link a governance role to a governance control that defines a governance responsibility that a person fulfils.
|
VoidResponse |
relieveGovernanceRole(String serverName,
String userId,
String governanceRoleGUID,
String appointmentGUID,
AppointmentRequestBody requestBody)
Unlink a person from a governance role appointment.
|
VoidResponse |
unlinkRoleFromResource(String serverName,
String userId,
String governanceRoleGUID,
String resourceGUID,
NullRequestBody requestBody)
Remove the link between a governance role and a resource.
|
VoidResponse |
unlinkRoleFromResponsibility(String serverName,
String userId,
String governanceRoleGUID,
String responsibilityGUID,
NullRequestBody requestBody)
Remove the link between a governance role and a governance responsibility.
|
VoidResponse |
updateGovernanceRole(String serverName,
String userId,
String governanceRoleGUID,
boolean isMergeUpdate,
GovernanceRoleProperties requestBody)
Update selected fields for the governance role.
|
@PostMapping(path="/governance-roles") public GUIDResponse createGovernanceRole(@PathVariable String serverName, @PathVariable String userId, @RequestBody GovernanceRoleProperties requestBody)
serverName - name of server instance to calluserId - the name of the calling user.requestBody - properties of the governance role.@PostMapping(path="/governance-roles/{governanceRoleGUID}")
public VoidResponse updateGovernanceRole(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@RequestParam
boolean isMergeUpdate,
@RequestBody
GovernanceRoleProperties requestBody)
serverName - name of server instance to calluserId - the name of the calling user.governanceRoleGUID - unique identifier (guid) of the governance role.isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?requestBody - properties of the governance role@PostMapping(path="/governance-roles/{governanceRoleGUID}/governance-responsibility/{responsibilityGUID}/link")
public VoidResponse linkRoleToResponsibility(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@PathVariable
String responsibilityGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to calluserId - calling usergovernanceRoleGUID - unique identifier of the governance roleresponsibilityGUID - unique identifier of the governance responsibility controlrequestBody - null request body@PostMapping(path="/governance-roles/{governanceRoleGUID}/governance-responsibility/{responsibilityGUID}/unlink")
public VoidResponse unlinkRoleFromResponsibility(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@PathVariable
String responsibilityGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to calluserId - calling usergovernanceRoleGUID - unique identifier of the governance roleresponsibilityGUID - unique identifier of the governance responsibility controlrequestBody - null request body@PostMapping(path="/governance-roles/{governanceRoleGUID}/resource/{resourceGUID}/link")
public VoidResponse linkRoleToResource(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@PathVariable
String resourceGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to calluserId - calling usergovernanceRoleGUID - unique identifier of the governance roleresourceGUID - unique identifier of the resource descriptionrequestBody - null request body@PostMapping(path="/governance-roles/{governanceRoleGUID}/resource/{resourceGUID}/unlink")
public VoidResponse unlinkRoleFromResource(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@PathVariable
String resourceGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to calluserId - calling usergovernanceRoleGUID - unique identifier of the governance roleresourceGUID - unique identifier of the resource descriptionrequestBody - null request body@PostMapping(path="/governance-roles/{governanceRoleGUID}/delete")
public VoidResponse deleteGovernanceRole(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of server instance to calluserId - the name of the calling usergovernanceRoleGUID - unique identifier (guid) of the governance rolerequestBody - properties to verify this is the right governance role@GetMapping(path="/governance-roles/{governanceRoleGUID}")
public GovernanceRoleResponse getGovernanceRoleByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID)
serverName - name of server instance to calluserId - the name of the calling usergovernanceRoleGUID - unique identifier (guid) of the governance role@GetMapping(path="/governance-roles/{governanceRoleGUID}/history")
public GovernanceRoleHistoryResponse getGovernanceRoleHistoryByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID)
serverName - name of server instance to calluserId - the name of the calling usergovernanceRoleGUID - unique identifier (guid) of the governance role@GetMapping(path="/governance-roles/by-role-id/{roleId}")
public GovernanceRoleListResponse getGovernanceRoleByRoleId(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String roleId)
serverName - name of server instance to calluserId - the name of the calling userroleId - the unique identifier (qualifiedName) of the governance role@GetMapping(path="/governance-roles/by-domain/{title}")
public GovernanceRoleListResponse getGovernanceRolesByDomainId(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
int domainIdentifier,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of server instance to calluserId - the name of the calling user.domainIdentifier - domain of interest - 0 is all domains@GetMapping(path="/governance-roles/by-title/{title}")
public GovernanceRoleListResponse getGovernanceRolesByTitle(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String title,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of server instance to calluserId - calling usertitle - short description of the rolestartFrom - where to start from in the list of definitionspageSize - max number of results to return in one call@GetMapping(path="/governance-roles/by-domain/{domainIdentifier}/current-appointments")
public GovernanceRoleAppointeeListResponse getCurrentGovernanceRoleAppointments(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
int domainIdentifier,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of server instance to calluserId - the name of the calling user@PostMapping(path="/governance-roles/{governanceRoleGUID}/appoint")
public GUIDResponse appointGovernanceRole(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@RequestBody
AppointmentRequestBody requestBody)
serverName - name of server instance to calluserId - the name of the calling user.governanceRoleGUID - unique identifier (guid) of the governance role.requestBody - unique identifier for the profile and start date.@PostMapping(path="/governance-roles/{governanceRoleGUID}/relieve/{appointmentGUID}")
public VoidResponse relieveGovernanceRole(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String governanceRoleGUID,
@PathVariable
String appointmentGUID,
@RequestBody
AppointmentRequestBody requestBody)
serverName - name of server instance to calluserId - the name of the calling usergovernanceRoleGUID - unique identifier (guid) of the governance roleappointmentGUID - unique identifier (guid) of the appointment relationshiprequestBody - unique identifier for the profile and end date.Copyright © 2018–2021 LF AI & Data Foundation. All rights reserved.