Class GovernanceOfficerResource
java.lang.Object
org.odpi.openmetadata.viewservices.governanceofficer.server.spring.GovernanceOfficerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class GovernanceOfficerResource
extends Object
The GovernanceOfficerResource provides part of the server-side implementation of the Governance Officer OMVS.
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionattachSupportingDefinition
(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, NewRelationshipRequestBody requestBody) Attach a supporting governance definition.createGovernanceDefinition
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a governance definition.createGovernanceDefinitionFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a governance definition using an existing metadata element as a template.deleteGovernanceDefinition
(String serverName, String urlMarker, String governanceDefinitionGUID, DeleteRequestBody requestBody) Delete a governance definition.detachDesignFromImplementation
(String serverName, String urlMarker, String designGUID, String implementationGUID, DeleteRequestBody requestBody) Detach a design object such as a solution component or governance definition from its implementation.detachImplementationResource
(String serverName, String urlMarker, String designGUID, String implementationResourceGUID, DeleteRequestBody requestBody) Detach a design object such as a solution component or governance definition from one of its implementation resources.detachPeerDefinitions
(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, DeleteRequestBody requestBody) Detach a governance definition from one of its peers.detachSupportingDefinition
(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, DeleteRequestBody requestBody) Detach a governance definition from a supporting governance definition.findGovernanceDefinitions
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.getGovernanceDefinitionByGUID
(String serverName, String urlMarker, String governanceDefinitionGUID, GetRequestBody requestBody) Return the properties of a specific governance definition.getGovernanceDefinitionInContext
(String serverName, String urlMarker, String governanceDefinitionGUID, ResultsRequestBody requestBody) Return the governance definition associated with a unique identifier and the other governance definitions linked to it.getGovernanceDefinitionsByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Returns the list of governance definitions with a particular name.linkDesignToImplementation
(String serverName, String urlMarker, String designGUID, String implementationGUID, NewRelationshipRequestBody requestBody) Attach a design object such as a solution component or governance definition to its implementation via the ImplementedBy relationship.linkImplementationResource
(String serverName, String urlMarker, String designGUID, String implementationResourceGUID, NewRelationshipRequestBody requestBody) Attach a design object such as a solution component or governance definition to one of its implementation resources via the ImplementationResource relationship.linkPeerDefinitions
(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, NewRelationshipRequestBody requestBody) Attach two peer governance definitions.updateGovernanceDefinition
(String serverName, String urlMarker, String governanceDefinitionGUID, UpdateElementRequestBody requestBody) Update the properties of a governance definition.
-
Constructor Details
-
GovernanceOfficerResource
public GovernanceOfficerResource()Default constructor
-
-
Method Details
-
createGovernanceDefinition
@PostMapping(path="/governance-definitions") public GUIDResponse createGovernanceDefinition(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a governance definition.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- properties for the governance definition.- Returns:
- unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createGovernanceDefinitionFromTemplate
@PostMapping(path="/governance-definitions/from-template") public GUIDResponse createGovernanceDefinitionFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody) Create a new metadata element to represent a governance definition using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.- Parameters:
serverName
- calling userurlMarker
- view service URL markerrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element 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)
-
updateGovernanceDefinition
@PostMapping(path="/governance-definitions/{governanceDefinitionGUID}/update") public VoidResponse updateGovernanceDefinition(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a governance definition.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the governance definition (returned from create)requestBody
- properties for the new element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkPeerDefinitions
@PostMapping(path="/governance-definitions/{governanceDefinitionOneGUID}/peer-definitions/{relationshipTypeName}/{governanceDefinitionTwoGUID}/attach") public VoidResponse linkPeerDefinitions(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionOneGUID, @PathVariable String relationshipTypeName, @PathVariable String governanceDefinitionTwoGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach two peer governance definitions.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachPeerDefinitions
@PostMapping(path="/governance-definitions/{governanceDefinitionOneGUID}/peer-definitions/{relationshipTypeName}/{governanceDefinitionTwoGUID}/detach") public VoidResponse detachPeerDefinitions(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionOneGUID, @PathVariable String relationshipTypeName, @PathVariable String governanceDefinitionTwoGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a governance definition from one of its peers.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
attachSupportingDefinition
@PostMapping(path="/governance-definitions/{governanceDefinitionOneGUID}/supporting-definitions/{relationshipTypeName}/{governanceDefinitionTwoGUID}/attach") public VoidResponse attachSupportingDefinition(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionOneGUID, @PathVariable String relationshipTypeName, @PathVariable String governanceDefinitionTwoGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach a supporting governance definition.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachSupportingDefinition
@PostMapping(path="/governance-definitions/{governanceDefinitionOneGUID}/supporting-definitions/{relationshipTypeName}/{governanceDefinitionTwoGUID}/detach") public VoidResponse detachSupportingDefinition(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionOneGUID, @PathVariable String relationshipTypeName, @PathVariable String governanceDefinitionTwoGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a governance definition from a supporting governance definition.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markergovernanceDefinitionOneGUID
- unique identifier of the first governance definitiongovernanceDefinitionTwoGUID
- unique identifier of the second governance definitionrelationshipTypeName
- name of the relationship to userequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteGovernanceDefinition
@PostMapping(path="/governance-definitions/{governanceDefinitionGUID}/delete") public VoidResponse deleteGovernanceDefinition(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Delete a governance definition.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the element to deleterequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getGovernanceDefinitionsByName
@PostMapping(path="/governance-definitions/by-name") public OpenMetadataRootElementsResponse getGovernanceDefinitionsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of governance definitions with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- 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)
-
findGovernanceDefinitions
@PostMapping(path="/governance-definitions/by-search-string") public OpenMetadataRootElementsResponse findGovernanceDefinitions(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Retrieve the list of governance definition metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- 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)
-
getGovernanceDefinitionByGUID
@PostMapping(path="/governance-definitions/{governanceDefinitionGUID}/retrieve") public OpenMetadataRootElementResponse getGovernanceDefinitionByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the properties of a specific governance definition.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the required elementrequestBody
- 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)
-
getGovernanceDefinitionInContext
@PostMapping(path="/governance-definitions/{governanceDefinitionGUID}/in-context") public OpenMetadataRootElementResponse getGovernanceDefinitionInContext(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String governanceDefinitionGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the governance definition associated with a unique identifier and the other governance definitions linked to it.- Parameters:
serverName
- name of the server instance to connect tourlMarker
- view service URL markergovernanceDefinitionGUID
- unique identifier of the governance definitionrequestBody
- additional query parameters- Returns:
- governance definition and its linked elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the caller is not authorized to issue the request PropertyServerException the metadata service has problems
-
linkDesignToImplementation
@PostMapping(path="/designs/{designGUID}/implementations/{implementationGUID}/attach") public VoidResponse linkDesignToImplementation(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String designGUID, @PathVariable String implementationGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach a design object such as a solution component or governance definition to its implementation via the ImplementedBy relationship. Request body is optional.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdesignGUID
- unique identifier of the governance definition, solution component etcimplementationGUID
- unique identifier of the implementationrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachDesignFromImplementation
@PostMapping(path="/designs/{designGUID}/implementations/{implementationGUID}/detach") public VoidResponse detachDesignFromImplementation(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String designGUID, @PathVariable String implementationGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a design object such as a solution component or governance definition from its implementation. Request body is optional.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdesignGUID
- unique identifier of the governance definition, solution component etcimplementationGUID
- unique identifier of the implementationrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkImplementationResource
@PostMapping(path="/designs/{designGUID}/implementation-resources/{implementationResourceGUID}/attach") public VoidResponse linkImplementationResource(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String designGUID, @PathVariable String implementationResourceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach a design object such as a solution component or governance definition to one of its implementation resources via the ImplementationResource relationship. Request body is optional.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdesignGUID
- unique identifier of the design objectimplementationResourceGUID
- unique identifier of the implementation resourcerequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachImplementationResource
@PostMapping(path="/designs/{designGUID}/implementation-resources/{implementationResourceGUID}/detach") public VoidResponse detachImplementationResource(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String designGUID, @PathVariable String implementationResourceGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a design object such as a solution component or governance definition from one of its implementation resources. Request body is optional.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdesignGUID
- unique identifier of the design objectimplementationResourceGUID
- unique identifier of the implementation resourcerequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-