@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}")
public class GovernanceActionProcessResource
extends Object
| Constructor and Description |
|---|
GovernanceActionProcessResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
createGovernanceActionProcess(String serverName,
String userId,
NewGovernanceActionProcessRequestBody requestBody)
Create a new metadata element to represent a governance action process.
|
GUIDResponse |
createGovernanceActionType(String serverName,
String userId,
GovernanceActionTypeProperties requestBody)
Create a new metadata element to represent a governance action type.
|
GovernanceActionProcessElementsResponse |
findGovernanceActionProcesses(String serverName,
String userId,
int startFrom,
int pageSize,
SearchStringRequestBody requestBody)
Retrieve the list of governance action process metadata elements that contain the search string.
|
GovernanceActionTypeElementsResponse |
findGovernanceActionTypes(String serverName,
String userId,
int startFrom,
int pageSize,
SearchStringRequestBody requestBody)
Retrieve the list of governance action type metadata elements that contain the search string.
|
GovernanceActionTypeElementResponse |
getFirstActionType(String serverName,
String userId,
String processGUID)
Return the governance action type that is the first step in a governance action process.
|
GovernanceActionProcessElementResponse |
getGovernanceActionProcessByGUID(String serverName,
String userId,
String processGUID)
Retrieve the governance action process metadata element with the supplied unique identifier.
|
GovernanceActionProcessElementsResponse |
getGovernanceActionProcessesByName(String serverName,
String userId,
int startFrom,
int pageSize,
NameRequestBody requestBody)
Retrieve the list of governance action process metadata elements with a matching qualified or display name.
|
GovernanceActionTypeElementResponse |
getGovernanceActionTypeByGUID(String serverName,
String userId,
String actionTypeGUID)
Retrieve the governance action type metadata element with the supplied unique identifier.
|
GovernanceActionTypeElementsResponse |
getGovernanceActionTypesByName(String serverName,
String userId,
int startFrom,
int pageSize,
NameRequestBody requestBody)
Retrieve the list of governance action type metadata elements with a matching qualified or display name.
|
NextGovernanceActionTypeElementsResponse |
getNextGovernanceActionTypes(String serverName,
String userId,
String actionTypeGUID,
int startFrom,
int pageSize)
Return the lust of next action type defined for the governance action process.
|
VoidResponse |
publishGovernanceActionProcess(String serverName,
String userId,
String processGUID,
NullRequestBody requestBody)
Update the zones for the asset so that it becomes visible to consumers.
|
VoidResponse |
removeFirstActionType(String serverName,
String userId,
String processGUID,
NullRequestBody requestBody)
Remove the link between a governance process and that governance action type that defines its first step.
|
VoidResponse |
removeGovernanceActionProcess(String serverName,
String userId,
String processGUID,
NullRequestBody requestBody)
Remove the metadata element representing a governance action process.
|
VoidResponse |
removeGovernanceActionType(String serverName,
String userId,
String actionTypeGUID,
NullRequestBody requestBody)
Remove the metadata element representing a governance action type.
|
VoidResponse |
removeNextActionType(String serverName,
String userId,
String actionLinkGUID,
NullRequestBody requestBody)
Remove a follow on step from a governance action process.
|
VoidResponse |
setupFirstActionType(String serverName,
String userId,
String processGUID,
String actionTypeGUID,
String requestBody)
Set up a link between an governance action process and a governance action type.
|
GUIDResponse |
setupNextActionType(String serverName,
String userId,
String currentActionTypeGUID,
String nextActionTypeGUID,
NextGovernanceActionTypeRequestBody requestBody)
Add a link between two governance action types to show that one follows on from the other when a governance action process
is executing.
|
VoidResponse |
updateGovernanceActionProcess(String serverName,
String userId,
String processGUID,
UpdateGovernanceActionProcessRequestBody requestBody)
Update the metadata element representing a governance action process.
|
VoidResponse |
updateGovernanceActionType(String serverName,
String userId,
String actionTypeGUID,
UpdateGovernanceActionTypeRequestBody requestBody)
Update the metadata element representing a governance action type.
|
VoidResponse |
updateNextActionType(String serverName,
String userId,
String nextActionLinkGUID,
NextGovernanceActionTypeRequestBody requestBody)
Update the properties of the link between two governance action types that shows that one follows on from the other when a governance
action process is executing.
|
VoidResponse |
withdrawGovernanceActionProcess(String serverName,
String userId,
String processGUID,
NullRequestBody requestBody)
Update the zones for the asset so that it is no longer visible to consumers.
|
public GovernanceActionProcessResource()
@PostMapping(path="/governance-action-processes/new") public GUIDResponse createGovernanceActionProcess(@PathVariable String serverName, @PathVariable String userId, @RequestBody NewGovernanceActionProcessRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userrequestBody - properties about the process to store and status value for the new process (default = ACTIVE)@PostMapping(path="/governance-action-processes/{processGUID}/update")
public VoidResponse updateGovernanceActionProcess(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@RequestBody
UpdateGovernanceActionProcessRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the metadata element to updaterequestBody - new properties for the metadata element@PostMapping(path="/governance-action-processes/{processGUID}/publish")
public VoidResponse publishGovernanceActionProcess(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the metadata element to publishrequestBody - null request body@PostMapping(path="/governance-action-processes/{processGUID}/withdraw")
public VoidResponse withdrawGovernanceActionProcess(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the metadata element to withdrawrequestBody - null request body@PostMapping(path="/governance-action-processes/{processGUID}/remove")
public VoidResponse removeGovernanceActionProcess(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the metadata element to removerequestBody - null request body@PostMapping(path="/governance-action-processes/by-search-string") public GovernanceActionProcessElementsResponse findGovernanceActionProcesses(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - string to find in the properties@PostMapping(path="/governance-action-processes/by-name") public GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - name to search for@GetMapping(path="/governance-action-processes/{processGUID}")
public GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the requested metadata element@PostMapping(path="/governance-action-types/new") public GUIDResponse createGovernanceActionType(@PathVariable String serverName, @PathVariable String userId, @RequestBody GovernanceActionTypeProperties requestBody)
serverName - name of the service to route the request touserId - calling userrequestBody - properties about the process to store@PostMapping(path="/governance-action-types/{actionTypeGUID}/update")
public VoidResponse updateGovernanceActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String actionTypeGUID,
@RequestBody
UpdateGovernanceActionTypeRequestBody requestBody)
serverName - name of the service to route the request touserId - calling useractionTypeGUID - unique identifier of the metadata element to updaterequestBody - new properties for the metadata element@PostMapping(path="/governance-action-types/{actionTypeGUID}/remove")
public VoidResponse removeGovernanceActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String actionTypeGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling useractionTypeGUID - unique identifier of the metadata element to remove@PostMapping(path="/governance-action-types/by-search-string") public GovernanceActionTypeElementsResponse findGovernanceActionTypes(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - string to find in the properties@PostMapping(path="/governance-action-types/by-name") public GovernanceActionTypeElementsResponse getGovernanceActionTypesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - name to search for@GetMapping(path="/governance-action-types/{actionTypeGUID}")
public GovernanceActionTypeElementResponse getGovernanceActionTypeByGUID(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String actionTypeGUID)
serverName - name of the service to route the request touserId - calling useractionTypeGUID - unique identifier of the governance action type@PostMapping(path="/governance-action-processes/{processGUID}/first-action-type/{actionTypeGUID}/new")
public VoidResponse setupFirstActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@PathVariable
String actionTypeGUID,
@RequestBody(required=false)
String requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the governance action processactionTypeGUID - unique identifier of the governance action typerequestBody - optional guard@GetMapping(path="/governance-action-processes/{processGUID}/first-action-type")
public GovernanceActionTypeElementResponse getFirstActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the governance action process@PostMapping(path="/governance-action-processes/{processGUID}/first-action-type/remove")
public VoidResponse removeFirstActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String processGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling userprocessGUID - unique identifier of the governance action process@PostMapping(path="/governance-action-types/{currentActionTypeGUID}/next-action-types/{nextActionTypeGUID}/new")
public GUIDResponse setupNextActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String currentActionTypeGUID,
@PathVariable
String nextActionTypeGUID,
@RequestBody
NextGovernanceActionTypeRequestBody requestBody)
serverName - name of the service to route the request touserId - calling usercurrentActionTypeGUID - unique identifier of the governance action type that defines the previous step in the governance action processnextActionTypeGUID - unique identifier of the governance action type that defines the next step in the governance action processrequestBody - guard required for this next step to proceed - or null for always run the next step plus flags.@PostMapping(path="/next-action-types/{nextActionLinkGUID}/update")
public VoidResponse updateNextActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String nextActionLinkGUID,
@RequestBody
NextGovernanceActionTypeRequestBody requestBody)
serverName - name of the service to route the request touserId - calling usernextActionLinkGUID - unique identifier of the relationship between the governance action typesrequestBody - guard required for this next step to proceed - or null for always run the next step - and flags@GetMapping(path="/governance-action-types/{actionTypeGUID}/next-action-type")
public NextGovernanceActionTypeElementsResponse getNextGovernanceActionTypes(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String actionTypeGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the service to route the request touserId - calling useractionTypeGUID - unique identifier of the current governance action typestartFrom - paging start pointpageSize - maximum results that can be returned@GetMapping(path="/governance-action-types/next-action-type/{actionLinkGUID}/remove")
public VoidResponse removeNextActionType(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String actionLinkGUID,
@RequestBody(required=false)
NullRequestBody requestBody)
serverName - name of the service to route the request touserId - calling useractionLinkGUID - unique identifier of the relationship between the governance action typesrequestBody - null request bodyCopyright © 2018–2021 LF AI & Data Foundation. All rights reserved.