Class ActionAuthorRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.actionauthor.server.ActionAuthorRESTServices
The ActionAuthorRESTServices provides the implementation of the Action Author Open Metadata View Service (OMVS).
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateGovernanceActionProcess
(String serverName, NewGovernanceActionProcessRequestBody requestBody) Create a new metadata element to represent a governance action process.createGovernanceActionProcessStep
(String serverName, GovernanceActionProcessStepProperties requestBody) Create a new metadata element to represent a governance action process step.createGovernanceActionType
(String serverName, GovernanceActionTypeProperties requestBody) Create a new metadata element to represent a governance action type.findGovernanceActionProcesses
(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process metadata elements that contain the search string.findGovernanceActionProcessSteps
(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process step metadata elements that contain the search string.findGovernanceActionTypes
(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action type metadata elements that contain the search string.getFirstActionProcessStep
(String serverName, String processGUID) Return the governance action process step that is the first step in a governance action process.getGovernanceActionProcessByGUID
(String serverName, String processGUID) Retrieve the governance action process metadata element with the supplied unique identifier.getGovernanceActionProcessesByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process metadata elements with a matching qualified or display name.getGovernanceActionProcessGraph
(String serverName, String processGUID, EffectiveTimeRequestBody requestBody) Retrieve the governance action process metadata element with the supplied unique identifier along with the flow definition describing its implementation.getGovernanceActionProcessStepByGUID
(String serverName, String processStepGUID) Retrieve the governance action process step metadata element with the supplied unique identifier.getGovernanceActionProcessStepsByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process step metadata elements with a matching qualified or display name.getGovernanceActionTypeByGUID
(String serverName, String governanceActionTypeGUID) Retrieve the governance action type metadata element with the supplied unique identifier.getGovernanceActionTypesByName
(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action type metadata elements with a matching qualified or display name.getNextProcessSteps
(String serverName, String processStepGUID, int startFrom, int pageSize) Return the list of next action process step defined for the governance action process.publishGovernanceActionProcess
(String serverName, String processGUID, NullRequestBody requestBody) Update the zones for the asset so that it becomes visible to consumers.removeFirstProcessStep
(String serverName, String processGUID, NullRequestBody requestBody) Remove the link between a governance process and that governance action process step that defines its first step.removeGovernanceActionProcess
(String serverName, String processGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action process.removeGovernanceActionProcessStep
(String serverName, String processStepGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action process step.removeGovernanceActionType
(String serverName, String governanceActionTypeGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action type.removeNextActionProcessStep
(String serverName, String actionLinkGUID, NullRequestBody requestBody) Remove a follow-on step from a governance action process.setupFirstActionProcessStep
(String serverName, String processGUID, String processStepGUID, FilterRequestBody requestBody) Set up a link between a governance action process and a governance action process step.setupNextActionProcessStep
(String serverName, String currentProcessStepGUID, String nextProcessStepGUID, NextGovernanceActionProcessStepRequestBody requestBody) Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.updateGovernanceActionProcess
(String serverName, String processGUID, UpdateGovernanceActionProcessRequestBody requestBody) Update the metadata element representing a governance action process.updateGovernanceActionProcessStep
(String serverName, String processStepGUID, UpdateGovernanceActionProcessStepRequestBody requestBody) Update the metadata element representing a governance action process step.updateGovernanceActionType
(String serverName, String governanceActionTypeGUID, UpdateGovernanceActionTypeRequestBody requestBody) Update the metadata element representing a governance action type.updateNextActionProcessStep
(String serverName, String nextProcessStepLinkGUID, NextGovernanceActionProcessStepRequestBody requestBody) Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.withdrawGovernanceActionProcess
(String serverName, String processGUID, NullRequestBody requestBody) Update the zones for the asset so that it is no longer visible to consumers.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
ActionAuthorRESTServices
public ActionAuthorRESTServices()Default constructor
-
-
Method Details
-
createGovernanceActionType
public GUIDResponse createGovernanceActionType(String serverName, GovernanceActionTypeProperties requestBody) Create a new metadata element to represent a governance action type.- Parameters:
serverName
- name of the service to route the request torequestBody
- properties about the process to store- Returns:
- unique identifier of the new governance action type or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGovernanceActionType
public VoidResponse updateGovernanceActionType(String serverName, String governanceActionTypeGUID, UpdateGovernanceActionTypeRequestBody requestBody) Update the metadata element representing a governance action type.- Parameters:
serverName
- name of the service to route the request togovernanceActionTypeGUID
- unique identifier of the metadata element to updaterequestBody
- new properties for the metadata element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeGovernanceActionType
public VoidResponse removeGovernanceActionType(String serverName, String governanceActionTypeGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action type.- Parameters:
serverName
- name of the service to route the request togovernanceActionTypeGUID
- unique identifier of the metadata element to removerequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findGovernanceActionTypes
public GovernanceActionTypesResponse findGovernanceActionTypes(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action type metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tostartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?startFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionTypesByName
public GovernanceActionTypesResponse getGovernanceActionTypesByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- name to search for- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionTypeByGUID
public GovernanceActionTypeResponse getGovernanceActionTypeByGUID(String serverName, String governanceActionTypeGUID) Retrieve the governance action type metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request togovernanceActionTypeGUID
- unique identifier of the governance action type- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGovernanceActionProcess
public GUIDResponse createGovernanceActionProcess(String serverName, NewGovernanceActionProcessRequestBody requestBody) Create a new metadata element to represent a governance action process.- Parameters:
serverName
- name of the service to route the request torequestBody
- properties about the process to store and status value for the new process (default = ACTIVE)- Returns:
- unique identifier of the new process or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGovernanceActionProcess
public VoidResponse updateGovernanceActionProcess(String serverName, String processGUID, UpdateGovernanceActionProcessRequestBody requestBody) Update the metadata element representing a governance action process.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the metadata element to updaterequestBody
- new properties for the metadata element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
publishGovernanceActionProcess
public VoidResponse publishGovernanceActionProcess(String serverName, String processGUID, NullRequestBody requestBody) Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the metadata element to publishrequestBody
- null request body- Returns:
- InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
withdrawGovernanceActionProcess
public VoidResponse withdrawGovernanceActionProcess(String serverName, String processGUID, NullRequestBody requestBody) Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the process is first created).- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the metadata element to withdrawrequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeGovernanceActionProcess
public VoidResponse removeGovernanceActionProcess(String serverName, String processGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action process.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the metadata element to removerequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findGovernanceActionProcesses
public GovernanceActionProcessElementsResponse findGovernanceActionProcesses(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tostartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?startFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionProcessesByName
public GovernanceActionProcessElementsResponse getGovernanceActionProcessesByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- name to search for- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionProcessByGUID
public GovernanceActionProcessElementResponse getGovernanceActionProcessByGUID(String serverName, String processGUID) Retrieve the governance action process metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the requested metadata element- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionProcessGraph
public GovernanceActionProcessGraphResponse getGovernanceActionProcessGraph(String serverName, String processGUID, EffectiveTimeRequestBody requestBody) Retrieve the governance action process metadata element with the supplied unique identifier along with the flow definition describing its implementation.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the requested metadata elementrequestBody
- effectiveTime- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGovernanceActionProcessStep
public GUIDResponse createGovernanceActionProcessStep(String serverName, GovernanceActionProcessStepProperties requestBody) Create a new metadata element to represent a governance action process step.- Parameters:
serverName
- name of the service to route the request torequestBody
- properties about the process to store- Returns:
- unique identifier of the new governance action process step or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGovernanceActionProcessStep
public VoidResponse updateGovernanceActionProcessStep(String serverName, String processStepGUID, UpdateGovernanceActionProcessStepRequestBody requestBody) Update the metadata element representing a governance action process step.- Parameters:
serverName
- name of the service to route the request toprocessStepGUID
- unique identifier of the metadata element to updaterequestBody
- new properties for the metadata element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeGovernanceActionProcessStep
public VoidResponse removeGovernanceActionProcessStep(String serverName, String processStepGUID, NullRequestBody requestBody) Remove the metadata element representing a governance action process step.- Parameters:
serverName
- name of the service to route the request toprocessStepGUID
- unique identifier of the metadata element to removerequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findGovernanceActionProcessSteps
public GovernanceActionProcessStepsResponse findGovernanceActionProcessSteps(String serverName, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process step metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tostartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?startFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionProcessStepsByName
public GovernanceActionProcessStepsResponse getGovernanceActionProcessStepsByName(String serverName, int startFrom, int pageSize, FilterRequestBody requestBody) Retrieve the list of governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- name to search for- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGovernanceActionProcessStepByGUID
public GovernanceActionProcessStepResponse getGovernanceActionProcessStepByGUID(String serverName, String processStepGUID) Retrieve the governance action process step metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request toprocessStepGUID
- unique identifier of the governance action process step- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupFirstActionProcessStep
public VoidResponse setupFirstActionProcessStep(String serverName, String processGUID, String processStepGUID, FilterRequestBody requestBody) Set up a link between a governance action process and a governance action process step. This defines the first step in the process.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the governance action processprocessStepGUID
- unique identifier of the governance action process steprequestBody
- optional guard- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getFirstActionProcessStep
public FirstGovernanceActionProcessStepResponse getFirstActionProcessStep(String serverName, String processGUID) Return the governance action process step that is the first step in a governance action process.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the governance action process- Returns:
- properties of the governance action process step or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeFirstProcessStep
public VoidResponse removeFirstProcessStep(String serverName, String processGUID, NullRequestBody requestBody) Remove the link between a governance process and that governance action process step that defines its first step.- Parameters:
serverName
- name of the service to route the request toprocessGUID
- unique identifier of the governance action processrequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setupNextActionProcessStep
public GUIDResponse setupNextActionProcessStep(String serverName, String currentProcessStepGUID, String nextProcessStepGUID, NextGovernanceActionProcessStepRequestBody requestBody) Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.- Parameters:
serverName
- name of the service to route the request tocurrentProcessStepGUID
- unique identifier of the governance action process step that defines the previous step in the governance action processnextProcessStepGUID
- unique identifier of the governance action process step 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.- Returns:
- unique identifier of the new link or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateNextActionProcessStep
public VoidResponse updateNextActionProcessStep(String serverName, String nextProcessStepLinkGUID, NextGovernanceActionProcessStepRequestBody requestBody) Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.- Parameters:
serverName
- name of the service to route the request tonextProcessStepLinkGUID
- unique identifier of the relationship between the governance action process stepsrequestBody
- guard required for this next step to proceed - or null for always run the next step - and flags- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNextProcessSteps
public NextGovernanceActionProcessStepsResponse getNextProcessSteps(String serverName, String processStepGUID, int startFrom, int pageSize) Return the list of next action process step defined for the governance action process.- Parameters:
serverName
- name of the service to route the request toprocessStepGUID
- unique identifier of the current governance action process stepstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- return the list of relationships and attached governance action process steps or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeNextActionProcessStep
public VoidResponse removeNextActionProcessStep(String serverName, String actionLinkGUID, NullRequestBody requestBody) Remove a follow-on step from a governance action process.- Parameters:
serverName
- name of the service to route the request toactionLinkGUID
- unique identifier of the relationship between the governance action process stepsrequestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-