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

Class AssetMakerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.assetmaker.server.AssetMakerRESTServices
public class AssetMakerRESTServices extends TokenController
The AssetMakerRESTServices provides the server-side implementation of the Asset Maker Open Metadata View Service (OMVS). This interface provides access to a person's profile, roles and network.

  • Constructor Details

    • AssetMakerRESTServices

      public AssetMakerRESTServices()
      Default constructor

  • Method Details

    • createAsset

      public GUIDResponse createAsset(String serverName, String urlMarker, 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createAssetFromTemplate

      public GUIDResponse createAssetFromTemplate(String serverName, String urlMarker, 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 a problem reported in the open metadata server(s)

    • updateAsset

      public BooleanResponse updateAsset(String serverName, String urlMarker, String assetGUID, 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:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteAsset

      public VoidResponse deleteAsset(String serverName, String urlMarker, String assetGUID, 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getAssetsByName

      public OpenMetadataRootElementsResponse getAssetsByName(String serverName, String urlMarker, FilterRequestBody 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 a problem reported in the open metadata server(s)

    • getProcessesByCategory

      public OpenMetadataRootElementsResponse getProcessesByCategory(String serverName, String urlMarker, ActivityStatusFilterRequestBody requestBody)
      Retrieve the processes 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 to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getAssetByGUID

      public OpenMetadataRootElementResponse getAssetByGUID(String serverName, String urlMarker, String assetGUID, GetRequestBody 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
      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 a problem reported in the open metadata server(s)

    • findAssets

      public OpenMetadataRootElementsResponse findAssets(String serverName, String urlMarker, 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 a problem reported in the open metadata server(s)

    • findProcesses

      public OpenMetadataRootElementsResponse findProcesses(String serverName, String urlMarker, ActivityStatusSearchString requestBody)
      Retrieve the processes that match the search string.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      requestBody - status of the to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • findInfrastructure

      public OpenMetadataRootElementsResponse findInfrastructure(String serverName, String urlMarker, DeploymentStatusSearchString requestBody)
      Retrieve the infrastructure assets that match the search string and optional status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getInfrastructureByCategory

      public OpenMetadataRootElementsResponse getInfrastructureByCategory(String serverName, String urlMarker, DeploymentStatusFilterRequestBody requestBody)
      Retrieve the infrastructure assets that match the category name and status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkReportOriginator

      public VoidResponse linkReportOriginator(String serverName, String urlMarker, String originatorGUID, String reportGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that identifies the originator of a report.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      originatorGUID - unique identifier of the originator
      reportGUID - unique identifier of the report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • unlinkReportOriginator

      public VoidResponse unlinkReportOriginator(String serverName, String urlMarker, String originatorGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)
      Remove a ReportOriginator relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      originatorGUID - unique identifier of the originator
      reportGUID - unique identifier of the report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkReportDependency

      public VoidResponse linkReportDependency(String serverName, String urlMarker, String priorReportGUID, String reportGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that identifies the prior publishing of a report.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      priorReportGUID - unique identifier of the earlier report
      reportGUID - unique identifier of the new report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • unlinkReportDependency

      public VoidResponse unlinkReportDependency(String serverName, String urlMarker, String priorReportGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)
      Remove a ReportDependency relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      priorReportGUID - unique identifier of the prior report
      reportGUID - unique identifier of the new report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkReportSubject

      public VoidResponse linkReportSubject(String serverName, String urlMarker, String subjectGUID, String reportGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that identifies the subject of a report.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      subjectGUID - unique identifier of the subject
      reportGUID - unique identifier of the report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • unlinkReportSubject

      public VoidResponse unlinkReportSubject(String serverName, String urlMarker, String subjectGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)
      Remove a ReportSubject relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      subjectGUID - unique identifier of the subject
      reportGUID - unique identifier of the report
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • deployITAsset

      public VoidResponse deployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • unDeployITAsset

      public VoidResponse unDeployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSoftwareCapability

      public VoidResponse linkSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSoftwareCapability

      public VoidResponse detachSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • findDataAssets

      public OpenMetadataRootElementsResponse findDataAssets(String serverName, String urlMarker, ContentStatusSearchString requestBody)
      Retrieve the data assets that match the search string and optional status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getDataAssetsByCategory

      public OpenMetadataRootElementsResponse getDataAssetsByCategory(String serverName, String urlMarker, ContentStatusFilterRequestBody requestBody)
      Retrieve the data assets that match the category name and status.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDataSetContent

      public VoidResponse linkDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDataSetContent

      public VoidResponse detachDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, 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 - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • createAction

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

    • addActionTarget

      public GUIDResponse addActionTarget(String serverName, String urlMarker, String actionGUID, String metadataElementGUID, 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:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateActionTargetProperties

      public VoidResponse updateActionTargetProperties(String serverName, String urlMarker, String actionTargetGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties associated with an Action Target.
      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

      public OpenMetadataRelationshipResponse getActionTarget(String serverName, String urlMarker, String relationshipGUID, 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 - describes ho the results should be returned
      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 the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getActionTargets

      public OpenMetadataRootElementsResponse getActionTargets(String serverName, String urlMarker, String integrationConnectorGUID, ActivityStatusRequestBody requestBody)
      Retrieve the details of the metadata elements identified as action targets with an action.
      Parameters:
      serverName - name of the service to route the request to.
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector.
      requestBody - describes how results are to be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getActionsForActionTarget

      public OpenMetadataRootElementsResponse getActionsForActionTarget(String serverName, String urlMarker, String elementGUID, 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 to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • assignAction

      public VoidResponse assignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody)
      Assign an action to a new actor.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actionGUID - unique identifier of the to do
      actorGUID - actor to assign the action to
      requestBody - null request body
      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

    • reassignAction

      public VoidResponse reassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody)
      Assign an action to a new actor.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actionGUID - unique identifier of the to do
      actorGUID - actor to assign the action to
      requestBody - null request body
      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

    • unassignAction

      public VoidResponse unassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, DeleteRelationshipRequestBody requestBody)
      Remove an action from an actor.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      actionGUID - unique identifier of the to do
      actorGUID - actor to assign the action to
      requestBody - null request body
      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

    • getActionsForSponsor

      public OpenMetadataRootElementsResponse getActionsForSponsor(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the actions that are chained off a sponsoring 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 to do (null means current active)
      Returns:
      list of to do beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

    • getActionsFromRequester

      public OpenMetadataRootElementsResponse getActionsFromRequester(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)
      Retrieve the actions that are chained off a requester'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 to do (null means current active)
      Returns:
      list of to do 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

      public OpenMetadataRootElementsResponse getAssignedActions(String serverName, String urlMarker, String actorGUID, 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 to do (null means current active)
      Returns:
      list of to do 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

      public GUIDResponse addCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String metadataElementGUID, 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:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • updateCatalogTarget

      public VoidResponse updateCatalogTarget(String serverName, String urlMarker, String relationshipGUID, 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 relationship.
      requestBody - properties for the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

    • getCatalogTarget

      public OpenMetadataRelationshipResponse getCatalogTarget(String serverName, String urlMarker, String relationshipGUID, 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 - describes ho the results should be returned
      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 the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • getCatalogTargets

      public OpenMetadataRootElementsResponse getCatalogTargets(String serverName, String urlMarker, String integrationConnectorGUID, 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 - describes how results are to be returned
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String urlMarker, String relationshipGUID, 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 integration connector.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • removeCatalogTarget

      public VoidResponse removeCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String elementGUID, 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 connector.
      elementGUID - unique identifier of the target element.
      requestBody - null request body.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • createSoftwareCapability

      public GUIDResponse createSoftwareCapability(String serverName, String urlMarker, NewElementRequestBody requestBody)
      Create a software capability.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      requestBody - properties for the software capability.
      Returns:
      unique identifier of the newly created element

    • createSoftwareCapabilityFromTemplate

      public GUIDResponse createSoftwareCapabilityFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a software capability using an existing metadata element as a template.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element

    • updateSoftwareCapability

      public BooleanResponse updateSoftwareCapability(String serverName, String urlMarker, String softwareCapabilityGUID, UpdateElementRequestBody requestBody)
      Update the properties of a software capability.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      softwareCapabilityGUID - unique identifier of the software capability
      requestBody - properties for the updated element
      Returns:
      boolean response

    • getSoftwareCapabilityByGUID

      public OpenMetadataRootElementResponse getSoftwareCapabilityByGUID(String serverName, String urlMarker, String softwareCapabilityGUID, GetRequestBody requestBody)
      Retrieve a specific software capability.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      softwareCapabilityGUID - unique identifier of the required element
      requestBody - options to control the query
      Returns:
      retrieved software capability

    • findSoftwareCapabilities

      public OpenMetadataRootElementsResponse findSoftwareCapabilities(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of software capability metadata elements that contain the search string.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements

    • getSoftwareCapabilitiesByName

      public OpenMetadataRootElementsResponse getSoftwareCapabilitiesByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of software capabilities with a particular name.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements

    • getSoftwareCapabilitiesByDeployedImplementationType

      public OpenMetadataRootElementsResponse getSoftwareCapabilitiesByDeployedImplementationType(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of software capabilities with a particular deployed implementation type.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements

    • getSoftwareCapabilitiesForInfrastructure

      public OpenMetadataRootElementsResponse getSoftwareCapabilitiesForInfrastructure(String serverName, String urlMarker, String infrastructureGUID, ResultsRequestBody requestBody)
      Retrieve the list of software capabilities attached to a specific infrastructure element.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      infrastructureGUID - unique identifier of the infrastructure element
      requestBody - options to control the query
      Returns:
      list of matching metadata elements

    • addCapabilityAssetUse

      public VoidResponse addCapabilityAssetUse(String serverName, String urlMarker, String softwareCapabilityGUID, String assetGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that represents the use of an asset by a software capability.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      softwareCapabilityGUID - unique identifier of the software capability
      assetGUID - unique identifier of the asset
      requestBody - optional effective time and relationship properties
      Returns:
      void response

    • removeCapabilityAssetUse

      public VoidResponse removeCapabilityAssetUse(String serverName, String urlMarker, String softwareCapabilityGUID, String assetGUID, DeleteRelationshipRequestBody requestBody)
      Remove the relationship that represents the use of an asset by a software capability.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      softwareCapabilityGUID - unique identifier of the software capability
      assetGUID - unique identifier of the asset
      requestBody - optional effective time
      Returns:
      void response

    • getCapabilityUse

      public OpenMetadataRootElementsResponse getCapabilityUse(String serverName, String urlMarker, String assetGUID, ResultsRequestBody requestBody)
      Retrieve the software capabilities using a particular asset.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options to control the query
      Returns:
      list of matching metadata elements

    • linkSupportedGovernanceService

      public GUIDResponse linkSupportedGovernanceService(String serverName, String urlMarker, String governanceEngineGUID, String governanceServiceGUID, NewRelationshipRequestBody requestBody)
      Create a relationship that registers a governance service with a governance engine. This is a multi-link relationship so the unique identifier of the new relationship is returned.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      governanceEngineGUID - unique identifier of the governance engine
      governanceServiceGUID - unique identifier of the governance service
      requestBody - properties for the relationship
      Returns:
      unique identifier of the new relationship or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the relationship.

    • updateSupportedGovernanceService

      public VoidResponse updateSupportedGovernanceService(String serverName, String urlMarker, String supportedGovernanceServiceGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of a SupportedGovernanceService relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      supportedGovernanceServiceGUID - unique identifier of the relationship
      requestBody - new properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the relationship.

    • detachSupportedGovernanceService

      public VoidResponse detachSupportedGovernanceService(String serverName, String urlMarker, String supportedGovernanceServiceGUID, DeleteRelationshipRequestBody requestBody)
      Remove a SupportedGovernanceService relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      supportedGovernanceServiceGUID - unique identifier of the relationship
      requestBody - external source information
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem removing the relationship.

    • getGovernanceEngines

      public OpenMetadataRootElementsResponse getGovernanceEngines(String serverName, String urlMarker, String governanceServiceGUID, ResultsRequestBody requestBody)
      Retrieve the governance engines connected to a particular governance service.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      governanceServiceGUID - unique identifier of the governance service
      requestBody - options to control the query
      Returns:
      list of matching metadata elements

    • getIntegrationGroups

      public OpenMetadataRootElementsResponse getIntegrationGroups(String serverName, String urlMarker, String integrationConnectorGUID, ResultsRequestBody requestBody)
      Retrieve the integration groups connected to a particular integration connector.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      integrationConnectorGUID - unique identifier of the integration connector
      requestBody - options to control the query
      Returns:
      list of matching metadata elements

    • linkAPIEndpoint

      public VoidResponse linkAPIEndpoint(String serverName, String urlMarker, String deployedAPIGUID, String endpointGUID, NewRelationshipRequestBody requestBody)
      Attach a deployed API to the endpoint where it is called.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      endpointGUID - unique identifier of the endpoint
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAPIEndpoint

      public VoidResponse detachAPIEndpoint(String serverName, String urlMarker, String deployedAPIGUID, String endpointGUID, DeleteRelationshipRequestBody requestBody)
      Detach a deployed API from the endpoint where it is called.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      endpointGUID - unique identifier of the endpoint
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkProcessHierarchy

      public VoidResponse linkProcessHierarchy(String serverName, String urlMarker, String parentProcessGUID, String childProcessGUID, NewRelationshipRequestBody requestBody)
      Attach a child process to its parent process.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      parentProcessGUID - unique identifier of the parent process
      childProcessGUID - unique identifier of the child process
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachProcessHierarchy

      public VoidResponse detachProcessHierarchy(String serverName, String urlMarker, String parentProcessGUID, String childProcessGUID, DeleteRelationshipRequestBody requestBody)
      Detach a child process from its parent process.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      parentProcessGUID - unique identifier of the parent process
      childProcessGUID - unique identifier of the child process
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkNestedFiles

      public VoidResponse linkNestedFiles(String serverName, String urlMarker, String folderGUID, String fileGUID, NewRelationshipRequestBody requestBody)
      Attach a data file to the file folder that it is stored in.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      folderGUID - unique identifier of the file folder
      fileGUID - unique identifier of the data file that is stored in the folder
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachNestedFile

      public VoidResponse detachNestedFile(String serverName, String urlMarker, String folderGUID, String fileGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data file from the file folder that it is stored in.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      folderGUID - unique identifier of the file folder
      fileGUID - unique identifier of the data file that is stored in the folder
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkLinkedFiles

      public VoidResponse linkLinkedFiles(String serverName, String urlMarker, String folderGUID, String fileGUID, NewRelationshipRequestBody requestBody)
      Attach a data file to a file folder that links to it without storing it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      folderGUID - unique identifier of the file folder
      fileGUID - unique identifier of the data file that is linked to the folder
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachLinkedFile

      public VoidResponse detachLinkedFile(String serverName, String urlMarker, String folderGUID, String fileGUID, DeleteRelationshipRequestBody requestBody)
      Detach a data file from a file folder that links to it without storing it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      folderGUID - unique identifier of the file folder
      fileGUID - unique identifier of the data file that is linked to the folder
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkFolderHierarchy

      public VoidResponse linkFolderHierarchy(String serverName, String urlMarker, String parentFolderGUID, String childFolderGUID, NewRelationshipRequestBody requestBody)
      Attach a child file folder to its parent file folder.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      parentFolderGUID - unique identifier of the parent file folder
      childFolderGUID - unique identifier of the child file folder
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachFolderHierarchy

      public VoidResponse detachFolderHierarchy(String serverName, String urlMarker, String parentFolderGUID, String childFolderGUID, DeleteRelationshipRequestBody requestBody)
      Detach a child file folder from its parent file folder.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      parentFolderGUID - unique identifier of the parent file folder
      childFolderGUID - unique identifier of the child file folder
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkImpactedResource

      public VoidResponse linkImpactedResource(String serverName, String urlMarker, String resourceGUID, String incidentReportGUID, NewRelationshipRequestBody requestBody)
      Attach a resource that is impacted by an incident report to that incident report.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      resourceGUID - unique identifier of the impacted resource
      incidentReportGUID - unique identifier of the incident report
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachImpactedResource

      public VoidResponse detachImpactedResource(String serverName, String urlMarker, String resourceGUID, String incidentReportGUID, DeleteRelationshipRequestBody requestBody)
      Detach a resource from an incident report that no longer impacts it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      resourceGUID - unique identifier of the impacted resource
      incidentReportGUID - unique identifier of the incident report
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkAssociatedLog

      public VoidResponse linkAssociatedLog(String serverName, String urlMarker, String elementGUID, String logAssetGUID, NewRelationshipRequestBody requestBody)
      Attach an asset that holds a log to the element that the log is about.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the log is about
      logAssetGUID - unique identifier of the asset that holds the log
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAssociatedLog

      public VoidResponse detachAssociatedLog(String serverName, String urlMarker, String elementGUID, String logAssetGUID, DeleteRelationshipRequestBody requestBody)
      Detach an asset that holds a log from the element that the log was about.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the log is about
      logAssetGUID - unique identifier of the asset that holds the log
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkSampleData

      public VoidResponse linkSampleData(String serverName, String urlMarker, String elementGUID, String sampleDataGUID, NewRelationshipRequestBody requestBody)
      Attach an asset holding sample data to the element that the sample was taken from.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the sample was taken from
      sampleDataGUID - unique identifier of the asset holding the sample data
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachSampleData

      public VoidResponse detachSampleData(String serverName, String urlMarker, String elementGUID, String sampleDataGUID, DeleteRelationshipRequestBody requestBody)
      Detach an asset holding sample data from the element that the sample was taken from.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element that the sample was taken from
      sampleDataGUID - unique identifier of the asset holding the sample data
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkProcessPort

      public VoidResponse linkProcessPort(String serverName, String urlMarker, String processGUID, String portGUID, NewRelationshipRequestBody requestBody)
      Attach a port to the process that owns it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      processGUID - unique identifier of the process that owns the port
      portGUID - unique identifier of the port
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachProcessPort

      public VoidResponse detachProcessPort(String serverName, String urlMarker, String processGUID, String portGUID, DeleteRelationshipRequestBody requestBody)
      Detach a port from the process that owned it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      processGUID - unique identifier of the process that owns the port
      portGUID - unique identifier of the port
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkArchiveContents

      public VoidResponse linkArchiveContents(String serverName, String urlMarker, String archiveFileGUID, String collectionGUID, NewRelationshipRequestBody requestBody)
      Attach an archive file to the collection that describes its contents.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      archiveFileGUID - unique identifier of the archive file
      collectionGUID - unique identifier of the collection describing the archive's contents
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachArchiveContents

      public VoidResponse detachArchiveContents(String serverName, String urlMarker, String archiveFileGUID, String collectionGUID, DeleteRelationshipRequestBody requestBody)
      Detach an archive file from the collection that described its contents.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      archiveFileGUID - unique identifier of the archive file
      collectionGUID - unique identifier of the collection describing the archive's contents
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkLinkedMedia

      public VoidResponse linkLinkedMedia(String serverName, String urlMarker, String mediaFileGUID, String linkedMediaFileGUID, NewRelationshipRequestBody requestBody)
      Attach a media file to another media file that is related to it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      mediaFileGUID - unique identifier of the media file
      linkedMediaFileGUID - unique identifier of the related media file
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachLinkedMedia

      public VoidResponse detachLinkedMedia(String serverName, String urlMarker, String mediaFileGUID, String linkedMediaFileGUID, DeleteRelationshipRequestBody requestBody)
      Detach a media file from another media file that was related to it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      mediaFileGUID - unique identifier of the media file
      linkedMediaFileGUID - unique identifier of the related media file
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsAuditLog

      public VoidResponse setAssetAsAuditLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds an audit log.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsAuditLog

      public VoidResponse clearAssetAsAuditLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the audit log designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsLineageLog

      public VoidResponse setAssetAsLineageLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds a lineage log.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsLineageLog

      public VoidResponse clearAssetAsLineageLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the lineage log designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsMeteringLog

      public VoidResponse setAssetAsMeteringLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds a metering log.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsMeteringLog

      public VoidResponse clearAssetAsMeteringLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the metering log designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsSecurityLog

      public VoidResponse setAssetAsSecurityLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds a security log.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsSecurityLog

      public VoidResponse clearAssetAsSecurityLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the security log designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsExceptionBacklog

      public VoidResponse setAssetAsExceptionBacklog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds a backlog of exceptions that need to be resolved.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsExceptionBacklog

      public VoidResponse clearAssetAsExceptionBacklog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the exception backlog designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAssetAsLogAnalysis

      public VoidResponse setAssetAsLogAnalysis(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)
      Classify an asset to say that it holds the results of analysing a log.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAssetAsLogAnalysis

      public VoidResponse clearAssetAsLogAnalysis(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)
      Remove the log analysis designation from an asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      assetGUID - unique identifier of the asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAPIAsListenerInterface

      public VoidResponse setAPIAsListenerInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)
      Classify a deployed API to say that it provides a listener interface.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAPIAsListenerInterface

      public VoidResponse clearAPIAsListenerInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)
      Remove the listener interface designation from a deployed API.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAPIAsPublisherInterface

      public VoidResponse setAPIAsPublisherInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)
      Classify a deployed API to say that it provides a publisher interface.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAPIAsPublisherInterface

      public VoidResponse clearAPIAsPublisherInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)
      Remove the publisher interface designation from a deployed API.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setAPIAsRequestResponseInterface

      public VoidResponse setAPIAsRequestResponseInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)
      Classify a deployed API to say that it provides a request-response interface.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearAPIAsRequestResponseInterface

      public VoidResponse clearAPIAsRequestResponseInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)
      Remove the request-response interface designation from a deployed API.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      deployedAPIGUID - unique identifier of the deployed API
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • setDataAssetEncoding

      public VoidResponse setDataAssetEncoding(String serverName, String urlMarker, String dataAssetGUID, NewClassificationRequestBody requestBody)
      Classify a data asset to describe how its data is encoded.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      dataAssetGUID - unique identifier of the data asset
      requestBody - properties for the classification
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearDataAssetEncoding

      public VoidResponse clearDataAssetEncoding(String serverName, String urlMarker, String dataAssetGUID, DeleteClassificationRequestBody requestBody)
      Remove the encoding description from a data asset.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      dataAssetGUID - unique identifier of the data asset
      requestBody - options for the request
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkPortDelegation

      public VoidResponse linkPortDelegation(String serverName, String urlMarker, String delegatingFromPortGUID, String delegatingToPortGUID, NewRelationshipRequestBody requestBody)
      Attach a port to the port that it delegates to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      delegatingFromPortGUID - unique identifier of the port that delegates
      delegatingToPortGUID - unique identifier of the port that is delegated to
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachPortDelegation

      public VoidResponse detachPortDelegation(String serverName, String urlMarker, String delegatingFromPortGUID, String delegatingToPortGUID, DeleteRelationshipRequestBody requestBody)
      Detach a port from the port that it delegated to.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      delegatingFromPortGUID - unique identifier of the port that delegates
      delegatingToPortGUID - unique identifier of the port that is delegated to
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkRegisteredIntegrationConnector

      public VoidResponse linkRegisteredIntegrationConnector(String serverName, String urlMarker, String integrationGroupGUID, String integrationConnectorGUID, NewRelationshipRequestBody requestBody)
      Register an integration connector with the integration group that runs it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      integrationGroupGUID - unique identifier of the integration group
      integrationConnectorGUID - unique identifier of the integration connector
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachRegisteredIntegrationConnector

      public VoidResponse detachRegisteredIntegrationConnector(String serverName, String urlMarker, String integrationGroupGUID, String integrationConnectorGUID, DeleteRelationshipRequestBody requestBody)
      Remove an integration connector from the integration group that ran it.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      integrationGroupGUID - unique identifier of the integration group
      integrationConnectorGUID - unique identifier of the integration connector
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)