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

Class AssetMakerResource

java.lang.Object
org.odpi.openmetadata.viewservices.assetmaker.server.spring.AssetMakerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class AssetMakerResource extends Object
The AssetMakerResource provides part of the server-side implementation of the Asset Maker OMVS. =

  • Constructor Details

    • AssetMakerResource

      public AssetMakerResource()
      Default constructor

  • Method Details

    • createAsset

      @PostMapping(path="/assets") public GUIDResponse createAsset(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create an asset.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the asset.
      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.

    • createAssetFromTemplate

      @PostMapping(path="/assets/from-template") public GUIDResponse createAssetFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent an asset 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)

    • updateAsset

      @PostMapping(path="/assets/{assetGUID}/update") public VoidResponse updateAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of an asset.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset (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.

    • deleteAsset

      @PostMapping(path="/assets/{assetGUID}/delete") public VoidResponse deleteAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @RequestBody(required=false) DeleteRequestBody requestBody)
      Delete an asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the element to delete
      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.

    • getAssetsByName

      @PostMapping(path="/assets/by-name") public OpenMetadataRootElementsResponse getAssetsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of assets with a particular name.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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)

    • findAssets

      @PostMapping(path="/assets/by-search-string") public OpenMetadataRootElementsResponse findAssets(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of asset metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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)

    • getAssetByGUID

      @PostMapping(path="/assets/{assetGUID}/retrieve") public OpenMetadataRootElementResponse getAssetByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific asset.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      assetGUID - 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)