Package org.odpi.openmetadata.viewservices.governanceofficer.server.spring

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

Constructor	Description
GovernanceOfficerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
VoidResponse	attachSupportingDefinition(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, RelationshipRequestBody requestBody)	Attach a supporting governance definition.
GUIDResponse	createGovernanceDefinition(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create a governance definition.
GUIDResponse	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.
VoidResponse	deleteGovernanceDefinition(String serverName, String urlMarker, String governanceDefinitionGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)	Delete a governance definition.
VoidResponse	detachDesignFromImplementation(String serverName, String urlMarker, String designGUID, String implementationGUID, MetadataSourceRequestBody requestBody)	Detach a design object such as a solution component or governance definition from its implementation.
VoidResponse	detachImplementationResource(String serverName, String urlMarker, String designGUID, String implementationResourceGUID, MetadataSourceRequestBody requestBody)	Detach a design object such as a solution component or governance definition from one of its implementation resources.
VoidResponse	detachPeerDefinitions(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, MetadataSourceRequestBody requestBody)	Detach a governance definition from one of its peers.
VoidResponse	detachSupportingDefinition(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, MetadataSourceRequestBody requestBody)	Detach a governance definition from a supporting governance definition.
GovernanceDefinitionsResponse	findGovernanceDefinitions(String serverName, String urlMarker, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody)	Retrieve the list of governance definition metadata elements that contain the search string.
GovernanceDefinitionResponse	getGovernanceDefinitionByGUID(String serverName, String urlMarker, String governanceDefinitionGUID, AnyTimeRequestBody requestBody)	Return the properties of a specific governance definition.
GovernanceDefinitionGraphResponse	getGovernanceDefinitionInContext(String serverName, String urlMarker, String governanceDefinitionGUID, int startFrom, int pageSize, ResultsRequestBody requestBody)	Return the governance definition associated with a unique identifier and the other governance definitions linked to it.
GovernanceDefinitionsResponse	getGovernanceDefinitionsByName(String serverName, String urlMarker, int startFrom, int pageSize, FilterRequestBody requestBody)	Returns the list of governance definitions with a particular name.
VoidResponse	linkDesignToImplementation(String serverName, String urlMarker, String designGUID, String implementationGUID, RelationshipRequestBody requestBody)	Attach a design object such as a solution component or governance definition to its implementation via the ImplementedBy relationship.
VoidResponse	linkImplementationResource(String serverName, String urlMarker, String designGUID, String implementationResourceGUID, RelationshipRequestBody requestBody)	Attach a design object such as a solution component or governance definition to one of its implementation resources via the ImplementationResource relationship.
VoidResponse	linkPeerDefinitions(String serverName, String urlMarker, String governanceDefinitionOneGUID, String relationshipTypeName, String governanceDefinitionTwoGUID, RelationshipRequestBody requestBody)	Attach two peer governance definitions.
VoidResponse	updateGovernanceDefinition(String serverName, String urlMarker, String governanceDefinitionGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)	Update the properties of a governance definition.
VoidResponse	updateGovernanceDefinitionStatus(String serverName, String urlMarker, String governanceDefinitionGUID, GovernanceDefinitionStatusRequestBody requestBody)	Update the status of a governance definition.

Methods inherited from class java.lang.Object

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

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 marker

requestBody - 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 user

urlMarker - view service URL marker

requestBody - 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,
 @RequestParam(required=false,defaultValue="false")
 boolean replaceAllProperties,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of a governance definition.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the governance definition (returned from create)

replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.

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.

updateGovernanceDefinitionStatus

@PostMapping(path="/governance-definitions/{governanceDefinitionGUID}/update-status")
public VoidResponse updateGovernanceDefinitionStatus(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceDefinitionGUID,
 @RequestBody(required=false)
 GovernanceDefinitionStatusRequestBody requestBody)

Update the status of a governance definition.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the governance definition (returned from create)

requestBody - properties for the new status.

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)
 RelationshipRequestBody requestBody)

Attach two peer governance definitions.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceDefinitionOneGUID - unique identifier of the first governance definition

governanceDefinitionTwoGUID - unique identifier of the second governance definition

relationshipTypeName - name of the relationship to use

requestBody - 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)
 MetadataSourceRequestBody requestBody)

Detach a governance definition from one of its peers.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceDefinitionOneGUID - unique identifier of the first governance definition

governanceDefinitionTwoGUID - unique identifier of the second governance definition

relationshipTypeName - name of the relationship to use

requestBody - 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)
 RelationshipRequestBody requestBody)

Attach a supporting governance definition.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceDefinitionOneGUID - unique identifier of the first governance definition

governanceDefinitionTwoGUID - unique identifier of the second governance definition

relationshipTypeName - name of the relationship to use

requestBody - 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)
 MetadataSourceRequestBody requestBody)

Detach a governance definition from a supporting governance definition.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceDefinitionOneGUID - unique identifier of the first governance definition

governanceDefinitionTwoGUID - unique identifier of the second governance definition

relationshipTypeName - name of the relationship to use

requestBody - 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,
 @RequestParam(required=false,defaultValue="false")
 boolean cascadedDelete,
 @RequestBody(required=false)
 MetadataSourceRequestBody requestBody)

Delete a governance definition.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the element to delete

cascadedDelete - can governance definitions be deleted if data fields are attached?

requestBody - 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 GovernanceDefinitionsResponse getGovernanceDefinitionsByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestParam(required=false,defaultValue="0")
 int startFrom,
 @RequestParam(required=false,defaultValue="0")
 int pageSize,
 @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 to

urlMarker - view service URL marker

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - 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 GovernanceDefinitionsResponse findGovernanceDefinitions(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestParam(required=false,defaultValue="0")
 int startFrom,
 @RequestParam(required=false,defaultValue="0")
 int pageSize,
 @RequestParam(required=false,defaultValue="false")
 boolean startsWith,
 @RequestParam(required=false,defaultValue="false")
 boolean endsWith,
 @RequestParam(required=false,defaultValue="false")
 boolean ignoreCase,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Retrieve the list of governance definition metadata elements that contain the search string.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

startsWith - 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 point

pageSize - maximum results that can be returned

requestBody - 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 GovernanceDefinitionResponse getGovernanceDefinitionByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceDefinitionGUID,
 @RequestBody(required=false)
 AnyTimeRequestBody requestBody)

Return the properties of a specific governance definition.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the required element

requestBody - 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 GovernanceDefinitionGraphResponse getGovernanceDefinitionInContext(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceDefinitionGUID,
 @RequestParam(required=false,defaultValue="0")
 int startFrom,
 @RequestParam(required=false,defaultValue="0")
 int pageSize,
 @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 to

urlMarker - view service URL marker

governanceDefinitionGUID - unique identifier of the governance definition

startFrom - paging start

pageSize - max elements that can be returned

requestBody - 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)
 RelationshipRequestBody 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 server

urlMarker - view service URL marker

designGUID - unique identifier of the governance definition, solution component etc

implementationGUID - unique identifier of the implementation

requestBody - 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)
 MetadataSourceRequestBody 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 server

urlMarker - view service URL marker

designGUID - unique identifier of the governance definition, solution component etc

implementationGUID - unique identifier of the implementation

requestBody - 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)
 RelationshipRequestBody 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 server

urlMarker - view service URL marker

designGUID - unique identifier of the design object

implementationResourceGUID - unique identifier of the implementation resource

requestBody - 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)
 MetadataSourceRequestBody 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 server

urlMarker - view service URL marker

designGUID - unique identifier of the design object

implementationResourceGUID - unique identifier of the implementation resource

requestBody - 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.