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

    • deployITAsset

      @PostMapping("/assets/{assetGUID}/deployed-on/{destinationGUID}/attach") public VoidResponse deployITAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String destinationGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      destinationGUID - unique identifier of the destination asset
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • unDeployITAsset

      @PostMapping("/assets/{assetGUID}/deployed-on/{destinationGUID}/detach") public VoidResponse unDeployITAsset(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String destinationGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Remove a DeployedOn relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      destinationGUID - unique identifier of the destination asset
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • linkSoftwareCapability

      @PostMapping("/assets/{assetGUID}/supported-software-capabilities/{capabilityGUID}/attach") public VoidResponse linkSoftwareCapability(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String capabilityGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Create a relationship that links a software capability to an infrastructure asset like a software server.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the data set
      capabilityGUID - unique identifier of the data asset supplying the data
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • detachSoftwareCapability

      @PostMapping("/assets/{assetGUID}/supported-software-capabilities/{capabilityGUID}/detach") public VoidResponse detachSoftwareCapability(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String capabilityGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Remove a relationship that links a software capability to an infrastructure asset like a software server.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the data set
      capabilityGUID - unique identifier of the data asset supplying the data
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • linkDataSetContent

      @PostMapping("/data-sets/{dataSetGUID}/data-set-content/{dataContentAssetGUID}/attach") public VoidResponse linkDataSetContent(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String dataSetGUID, @PathVariable String dataContentAssetGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a data set to another asset (typically a data store) that is supplying the data.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      dataSetGUID - unique identifier of the data set
      dataContentAssetGUID - unique identifier of the data asset supplying the data
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • detachDataSetContent

      @PostMapping("/data-sets/{dataSetGUID}/data-set-content/{dataContentAssetGUID}/detach") public VoidResponse detachDataSetContent(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String dataSetGUID, @PathVariable String dataContentAssetGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a data set from another asset that was supplying the data and is no more.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      dataSetGUID - unique identifier of the data set
      dataContentAssetGUID - unique identifier of the data asset supplying the data
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void 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)

    • createAction

      @PostMapping(path="/actions") public GUIDResponse createAction(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) ActionRequestBody requestBody)
      Create a new action and link it to the supplied actor and targets (if applicable).
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - properties of the action
      Returns:
      unique identifier of the action or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • addActionTarget

      @PostMapping(path="/actions/{actionGUID}/action-targets/{metadataElementGUID}") public GUIDResponse addActionTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actionGUID, @PathVariable String metadataElementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Add an element to an action's workload.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      actionGUID - 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.

    • updateActionTargetProperties

      @PostMapping(path="/actions/action-targets/{actionTargetGUID}") public VoidResponse updateActionTargetProperties(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actionTargetGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody)
      Update the properties associated with an Action Target for an action.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actionTargetGUID - unique identifier of the action target relationship
      requestBody - properties to change
      Returns:
      void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionTarget

      @PostMapping(path="/action-targets/{relationshipGUID}") public OpenMetadataRelationshipResponse getActionTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String relationshipGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve a specific action target associated with an action.
      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.

    • getActionTargets

      @GetMapping(path="/actions/{actionGUID}/action-targets") public OpenMetadataRootElementsResponse getActionTargets(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actionGUID, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return a list of elements that are target elements for an action.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      actionGUID - 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.

    • getActionsForActionTarget

      @PostMapping(path="/elements/{elementGUID}/action-targets/actions") public OpenMetadataRootElementsResponse getActionsForActionTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Retrieve the "Actions" that are chained off of an action target element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element to start with
      requestBody - status of the action (null means current active)
      Returns:
      list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsForSponsor

      @PostMapping(path="/elements/{elementGUID}/sponsored/actions") public OpenMetadataRootElementsResponse getActionsForSponsor(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Retrieve the "Actions" that are chained off of a sponsor's element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element to start with
      requestBody - status of the action (null means current active)
      Returns:
      list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssignedActions

      @PostMapping(path="/actors/{actorGUID}/assigned/actions") public OpenMetadataRootElementsResponse getAssignedActions(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorGUID, @RequestBody(required=false) ActivityStatusRequestBody requestBody)
      Retrieve the actions for a particular actor.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actorGUID - unique identifier of the role
      requestBody - status of the action (null means current active)
      Returns:
      list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • findProcesses

      @PostMapping(path="/processes/find-by-search-string") public OpenMetadataRootElementsResponse findProcesses(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) ActivityStatusSearchString requestBody)
      Retrieve the processes that match the search string and activity status.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - status of the action (null means current active)
      Returns:
      list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getProcessesByCategory

      @PostMapping(path="/processes/by-category") public OpenMetadataRootElementsResponse getProcessesByCategory(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) ActivityStatusFilterRequestBody requestBody)
      Retrieve the actions that match the category name and status.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - status of the action (null means current active)
      Returns:
      list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

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

    • removeCatalogTarget

      @PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}/detach") public VoidResponse removeCatalogTarget(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String integrationConnectorGUID, @PathVariable String metadataElementGUID, @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
      integrationConnectorGUID - unique identifier of the integration service.
      metadataElementGUID - unique identifier of the metadata element that is a catalog target.
      requestBody - 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.