Class GovernedAssetOMASResource
java.lang.Object
org.odpi.openmetadata.accessservices.securityofficer.spring.GovernedAssetOMASResource
@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-engine/users/{userId}")
public class GovernedAssetOMASResource
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreateSoftwareServerCapability
(String serverName, String userId, SoftwareServerCapabilityRequestBody requestBody) Create a Software Server Capability entitygetGovernedAsset
(String serverName, String userId, String assetGuid) Returns a single governed assetgetGovernedAssets
(String serverName, String userId, List<String> entityTypes, Integer offset, Integer pageSize) Returns the list of governed assetgetSoftwareServerCapabilityByGUID
(String serverName, String userId, String guid) Returns the Software Server Capability entity by global identifier
-
Constructor Details
-
GovernedAssetOMASResource
public GovernedAssetOMASResource()
-
-
Method Details
-
getGovernedAssets
@GetMapping(path="/assets", produces="application/json") public GovernedAssetListResponse getGovernedAssets(@PathVariable String serverName, @PathVariable String userId, @RequestParam(value="entityTypes",required=false) List<String> entityTypes, @RequestParam(value="offset",required=false) Integer offset, @RequestParam(value="pageSize",required=false) Integer pageSize) Returns the list of governed assetThese include the tag associations but not the definitions of those tags
- Parameters:
userId
- - String - userId of user making request.entityTypes
- - the type of the entities that are returned- Returns:
- GovernedAssetComponentList or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information offset the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getGovernedAsset
@GetMapping(path="/assets/{assetGuid}", produces="application/json") public GovernedAssetResponse getGovernedAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGuid) Returns a single governed assetThese include the tag associations but not the definitions of those tags
- Parameters:
userId
- - String - userId of user making request.assetGuid
- - Guid of the asset component to retrieve- Returns:
- GovernedAsset or InvalidParameterException - one of the parameters is null or invalid. UnrecognizedConnectionNameException - there is no connection defined for this name. AmbiguousConnectionNameException - there is more than one connection defined for this name. PropertyServerException - there is a problem retrieving information from the property (metadata) handlers. UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
createSoftwareServerCapability
@PostMapping(path="/software-server-capabilities") public StringResponse createSoftwareServerCapability(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @RequestBody SoftwareServerCapabilityRequestBody requestBody) Create a Software Server Capability entity- Parameters:
serverName
- - String - the name of server instance to calluserId
- - String - userId of user making request.requestBody
- - SoftwareServerCapabilityRequestBody- Returns:
- the Software Server entity created
-
getSoftwareServerCapabilityByGUID
@GetMapping(path="/software-server-capabilities/{guid}") public SoftwareServerCapabilityResponse getSoftwareServerCapabilityByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Returns the Software Server Capability entity by global identifier- Parameters:
serverName
- name of server instance to calluserId
- the name of the calling userguid
- guid of the software server- Returns:
- unique identifier of the created process
-