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) DeleteElementRequestBody 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)

    • addCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}") public GUIDResponse addCatalogTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Add a catalog target to an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - properties for the relationship.
      Returns:
      guid or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}/update") public VoidResponse updateCatalogTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipGUID, @RequestBody UpdateRelationshipRequestBody requestBody)
      Update a catalog target for an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the integration service.* @param requestBody properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}") public OpenMetadataRelationshipResponse getCatalogTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve a specific catalog target associated with an integration connector.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the relationship
      requestBody - details of how the retrieve should be processed
      Returns:
      details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      @GetMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets") public OpenMetadataRootElementsResponse getCatalogTargets(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String integrationConnectorGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - describe how results are to be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      @PostMapping(path="/catalog-targets/{relationshipGUID}/remove") public VoidResponse removeCatalogTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Unregister a catalog target from the integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      relationshipGUID - unique identifier of the relationship.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.