Package org.odpi.openmetadata.accessservices.itinfrastructure.server

Class ITAssetRESTService

  • public class ITAssetRESTService
extends Object
    ITAssetRESTService is the server-side of ExternalSourceClientBase. It is called from the specific clients that manage the specializations of IT Infrastructure assets.

    • Constructor Detail

      • ITAssetRESTService

        public ITAssetRESTService()
        Default constructor

    • Method Detail

      • createAsset

        public GUIDResponse createAsset​(String serverName,
                                String userId,
                                boolean infrastructureManagerIsHome,
                                AssetRequestBody requestBody)
        Create a new metadata element to represent a asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        infrastructureManagerIsHome - should the asset be marked as owned by the infrastructure manager so others can not update?
        requestBody - properties to store
        Returns:
        unique identifier of the new metadata element 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)

      • createAssetFromTemplate

        public GUIDResponse createAssetFromTemplate​(String serverName,
                                            String userId,
                                            String templateGUID,
                                            boolean infrastructureManagerIsHome,
                                            TemplateRequestBody requestBody)
        Create a new metadata element to represent a asset using an existing metadata element as a template.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        infrastructureManagerIsHome - should the asset be marked as owned by the infrastructure manager so others can not update?
        templateGUID - unique identifier of the metadata element to copy
        requestBody - properties that override the template
        Returns:
        unique identifier of the new metadata element 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)

      • updateAsset

        public VoidResponse updateAsset​(String serverName,
                                String userId,
                                String assetGUID,
                                boolean isMergeUpdate,
                                AssetRequestBody requestBody)
        Update the metadata element representing a asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetGUID - unique identifier of the metadata element to update
        isMergeUpdate - are unspecified properties unchanged (true) or removed?
        requestBody - new properties for this element
        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)

      • updateAssetStatus

        public VoidResponse updateAssetStatus​(String serverName,
                                      String userId,
                                      String assetTypeName,
                                      String assetGUID,
                                      ElementStatusRequestBody requestBody)
        Update the status of the metadata element representing an asset.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset to update
        requestBody - new status for the process
        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)

      • setupRelatedAsset

        public VoidResponse setupRelatedAsset​(String serverName,
                                      String userId,
                                      String assetTypeName,
                                      String assetGUID,
                                      String relationshipTypeName,
                                      String relatedAssetTypeName,
                                      String relatedAssetGUID,
                                      boolean infrastructureManagerIsHome,
                                      AssetExtensionsRequestBody requestBody)
        Create a relationship between a asset and a related asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        relationshipTypeName - name of the relationship type
        relatedAssetTypeName - name of type for the asset
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        relatedAssetGUID - unique identifier of the related asset
        requestBody - request body
        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)

      • updateAssetRelationship

        public VoidResponse updateAssetRelationship​(String serverName,
                                            String userId,
                                            String relationshipTypeName,
                                            String relationshipGUID,
                                            boolean isMergeUpdate,
                                            AssetExtensionsRequestBody requestBody)
        Update a relationship between an asset and a related asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        relationshipTypeName - name of the relationship type
        relationshipGUID - unique identifier of the asset
        isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing the just the properties with matching names, or should the entire properties of the instance be replaced?
        requestBody - new properties
        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)

      • clearRelatedAsset

        public VoidResponse clearRelatedAsset​(String serverName,
                                      String userId,
                                      String assetTypeName,
                                      String assetGUID,
                                      String relationshipTypeName,
                                      String relatedAssetTypeName,
                                      String relatedAssetGUID,
                                      EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove a relationship between a asset and a related asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        relationshipTypeName - name of the relationship type
        relatedAssetTypeName - name of type for the asset
        relatedAssetGUID - unique identifier of the related asset
        requestBody - unique identifier/name of software server capability representing the infrastructure manager
        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)

      • addClassification

        public VoidResponse addClassification​(String serverName,
                                      String userId,
                                      String assetTypeName,
                                      String assetGUID,
                                      String classificationName,
                                      boolean infrastructureManagerIsHome,
                                      AssetExtensionsRequestBody requestBody)
        Update the properties of a classification for a asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        classificationName - name of the classification type
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        requestBody - properties
        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)

      • updateClassification

        public VoidResponse updateClassification​(String serverName,
                                         String userId,
                                         String assetTypeName,
                                         String assetGUID,
                                         String classificationName,
                                         boolean isMergeUpdate,
                                         AssetExtensionsRequestBody requestBody)
        Update the properties of a classification for a asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        classificationName - name of the classification type
        isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing the just the properties with matching names, or should the entire properties of the instance be replaced?
        requestBody - properties
        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)

      • clearClassification

        public VoidResponse clearClassification​(String serverName,
                                        String userId,
                                        String assetTypeName,
                                        String assetGUID,
                                        String classificationName,
                                        EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove a classification from an asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        classificationName - name of the classification type
        requestBody - properties
        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)

      • publishAsset

        public VoidResponse publishAsset​(String serverName,
                                 String userId,
                                 String assetGUID,
                                 NullRequestBody requestBody)
        Update the zones for the asset asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetGUID - unique identifier of the metadata element to publish
        requestBody - null request body
        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)

      • withdrawAsset

        public VoidResponse withdrawAsset​(String serverName,
                                  String userId,
                                  String assetGUID,
                                  NullRequestBody requestBody)
        Update the zones for the asset asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the asset is first created).
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetGUID - unique identifier of the metadata element to withdraw
        requestBody - null request body
        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)

      • removeAsset

        public VoidResponse removeAsset​(String serverName,
                                String userId,
                                String assetGUID,
                                MetadataSourceRequestBody requestBody)
        Remove the metadata element representing a asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetGUID - unique identifier of the metadata element to remove
        requestBody - unique identifier/name of software server capability representing the infrastructure manager
        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)

      • findAssets

        public AssetListResponse findAssets​(String serverName,
                                    String userId,
                                    String assetTypeName,
                                    int startFrom,
                                    int pageSize,
                                    SearchStringRequestBody requestBody)
        Retrieve the list of asset metadata elements that contain the search string. The search string is treated as a regular expression.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        startFrom - paging start point
        pageSize - maximum results that can be returned
        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)

      • getAssetsByName

        public AssetListResponse getAssetsByName​(String serverName,
                                         String userId,
                                         String assetTypeName,
                                         int startFrom,
                                         int pageSize,
                                         NameRequestBody requestBody)
        Retrieve the list of asset metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - name to search for
        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)

      • getAssetsForInfrastructureManager

        public AssetListResponse getAssetsForInfrastructureManager​(String serverName,
                                                           String userId,
                                                           String infrastructureManagerGUID,
                                                           String infrastructureManagerName,
                                                           String assetTypeName,
                                                           int startFrom,
                                                           int pageSize,
                                                           EffectiveTimeRequestBody requestBody)
        Retrieve the list of assets created by this caller.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        assetTypeName - name of type for the asset
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - effective time for the query
        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

        public AssetResponse getAssetByGUID​(String serverName,
                                    String userId,
                                    String assetTypeName,
                                    String guid,
                                    EffectiveTimeRequestBody requestBody)
        Retrieve the asset metadata element with the supplied unique identifier.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        guid - unique identifier of the requested metadata element
        requestBody - effectiveTime
        Returns:
        matching metadata element 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)

      • getAssetRelationships

        public AssetRelationshipListResponse getAssetRelationships​(String serverName,
                                                           String userId,
                                                           String assetTypeName,
                                                           String assetGUID,
                                                           String relationshipTypeName,
                                                           String relatedAssetTypeName,
                                                           int startingEnd,
                                                           int startFrom,
                                                           int pageSize,
                                                           EffectiveTimeRequestBody requestBody)
        Return the list of relationships between assets.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset to start with
        startingEnd - which end of the relationship to start at 0=either end; 1=end1 and 2=end 2
        relationshipTypeName - name of type for the relationship
        relatedAssetTypeName - name of type of retrieved assets
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - effective time for the query
        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)

      • getRelatedAssets

        public RelatedAssetListResponse getRelatedAssets​(String serverName,
                                                 String userId,
                                                 String assetTypeName,
                                                 String assetGUID,
                                                 String relationshipTypeName,
                                                 String relatedAssetTypeName,
                                                 int startingEnd,
                                                 int startFrom,
                                                 int pageSize,
                                                 EffectiveTimeRequestBody requestBody)
        Return the list of assets linked by another asset.
        Parameters:
        serverName - name of the server to route the request to.
        userId - calling user
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset to start with
        startingEnd - which end of the relationship to start at 0=either end; 1=end1 and 2=end 2
        relationshipTypeName - name of type for the relationship
        relatedAssetTypeName - name of type for the related asset
        startFrom - paging start point
        pageSize - maximum results that can be returned
        requestBody - effective time for the query
        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)

      • setupDataFlow

        public GUIDResponse setupDataFlow​(String serverName,
                                  String userId,
                                  String dataSupplierGUID,
                                  String dataConsumerGUID,
                                  boolean infrastructureManagerIsHome,
                                  DataFlowRequestBody requestBody)
        Link two elements together to show that data flows from one to the other.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        infrastructureManagerIsHome - ensure that only the process manager can update this process
        requestBody - properties of the relationship
        Returns:
        unique identifier of the relationship 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)

      • getDataFlow

        public DataFlowElementResponse getDataFlow​(String serverName,
                                           String userId,
                                           String dataSupplierGUID,
                                           String dataConsumerGUID,
                                           NameRequestBody requestBody)
        Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        requestBody - optional name to search for
        Returns:
        unique identifier and properties of the relationship 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)

      • updateDataFlow

        public VoidResponse updateDataFlow​(String serverName,
                                   String userId,
                                   String dataFlowGUID,
                                   DataFlowRequestBody requestBody)
        Update relationship between two elements that shows that data flows from one to the other.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataFlowGUID - unique identifier of the data flow relationship
        requestBody - properties of the relationship
        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)

      • clearDataFlow

        public VoidResponse clearDataFlow​(String serverName,
                                  String userId,
                                  String dataFlowGUID,
                                  EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove the data flow relationship between two elements.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataFlowGUID - unique identifier of the data flow relationship
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)

      • getDataFlowConsumers

        public DataFlowElementsResponse getDataFlowConsumers​(String serverName,
                                                     String userId,
                                                     String dataSupplierGUID,
                                                     EffectiveTimeRequestBody requestBody)
        Retrieve the data flow relationships linked from an specific element to the downstream consumers.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataSupplierGUID - unique identifier of the data supplier
        requestBody - unique identifiers of software server capability representing the caller (optional)
        Returns:
        unique identifier and properties of the relationship 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)

      • getDataFlowSuppliers

        public DataFlowElementsResponse getDataFlowSuppliers​(String serverName,
                                                     String userId,
                                                     String dataConsumerGUID,
                                                     EffectiveTimeRequestBody requestBody)
        Retrieve the data flow relationships linked from an specific element to the upstream suppliers.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        dataConsumerGUID - unique identifier of the data consumer
        requestBody - unique identifiers of software server capability representing the caller (optional)
        Returns:
        unique identifier and properties of the relationship 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)

      • setupControlFlow

        public GUIDResponse setupControlFlow​(String serverName,
                                     String userId,
                                     String currentStepGUID,
                                     String nextStepGUID,
                                     boolean infrastructureManagerIsHome,
                                     ControlFlowRequestBody requestBody)
        Link two elements to show that when one completes the next is started.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        infrastructureManagerIsHome - ensure that only the process manager can update this process
        requestBody - properties of the relationship
        Returns:
        unique identifier for the control flow relationship 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)

      • getControlFlow

        public ControlFlowElementResponse getControlFlow​(String serverName,
                                                 String userId,
                                                 String currentStepGUID,
                                                 String nextStepGUID,
                                                 NameRequestBody requestBody)
        Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        requestBody - unique identifier for this relationship
        Returns:
        unique identifier and properties of the relationship 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)

      • updateControlFlow

        public VoidResponse updateControlFlow​(String serverName,
                                      String userId,
                                      String controlFlowGUID,
                                      ControlFlowRequestBody requestBody)
        Update the relationship between two elements that shows that when one completes the next is started.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        controlFlowGUID - unique identifier of the control flow relationship
        requestBody - properties of the relationship
        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)

      • clearControlFlow

        public VoidResponse clearControlFlow​(String serverName,
                                     String userId,
                                     String controlFlowGUID,
                                     EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove the control flow relationship between two elements.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        controlFlowGUID - unique identifier of the control flow relationship
        requestBody - effective time and external identifiers
        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)

      • getControlFlowNextSteps

        public ControlFlowElementsResponse getControlFlowNextSteps​(String serverName,
                                                           String userId,
                                                           String currentStepGUID,
                                                           EffectiveTimeRequestBody requestBody)
        Retrieve the control relationships linked from an specific element to the possible next elements in the process.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        currentStepGUID - unique identifier of the current step
        requestBody - null request body
        Returns:
        unique identifier and properties of the relationship 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)

      • getControlFlowPreviousSteps

        public ControlFlowElementsResponse getControlFlowPreviousSteps​(String serverName,
                                                               String userId,
                                                               String currentStepGUID,
                                                               EffectiveTimeRequestBody requestBody)
        Retrieve the control relationships linked from an specific element to the possible previous elements in the process.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        currentStepGUID - unique identifier of the previous step
        requestBody - unique identifiers of software server capability representing the caller (optional)
        Returns:
        unique identifier and properties of the relationship 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)

      • setupProcessCall

        public GUIDResponse setupProcessCall​(String serverName,
                                     String userId,
                                     String callerGUID,
                                     String calledGUID,
                                     boolean infrastructureManagerIsHome,
                                     ProcessCallRequestBody requestBody)
        Link two elements together to show a request-response call between them.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        callerGUID - unique identifier of the element that is making the call
        calledGUID - unique identifier of the element that is processing the call
        infrastructureManagerIsHome - ensure that only the process manager can update this process
        requestBody - properties of the relationship
        Returns:
        unique identifier of the new relationship 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)

      • getProcessCall

        public ProcessCallElementResponse getProcessCall​(String serverName,
                                                 String userId,
                                                 String callerGUID,
                                                 String calledGUID,
                                                 NameRequestBody requestBody)
        Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        callerGUID - unique identifier of the element that is making the call
        calledGUID - unique identifier of the element that is processing the call
        requestBody - qualified name to disambiguate request
        Returns:
        unique identifier and properties of the relationship 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)

      • updateProcessCall

        public VoidResponse updateProcessCall​(String serverName,
                                      String userId,
                                      String processCallGUID,
                                      ProcessCallRequestBody requestBody)
        Update the relationship between two elements that shows a request-response call between them.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        processCallGUID - unique identifier of the process call relationship
        requestBody - properties of the relationship
        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)

      • clearProcessCall

        public VoidResponse clearProcessCall​(String serverName,
                                     String userId,
                                     String processCallGUID,
                                     EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove the process call relationship.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        processCallGUID - unique identifier of the process call relationship
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)

      • getProcessCalled

        public ProcessCallElementsResponse getProcessCalled​(String serverName,
                                                    String userId,
                                                    String callerGUID,
                                                    EffectiveTimeRequestBody requestBody)
        Retrieve the process call relationships linked from an specific element to the elements it calls.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        callerGUID - unique identifier of the element that is making the call
        requestBody - unique identifiers of software server capability representing the caller (optional)
        Returns:
        unique identifier and properties of the relationship 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)

      • getProcessCallers

        public ProcessCallElementsResponse getProcessCallers​(String serverName,
                                                     String userId,
                                                     String calledGUID,
                                                     EffectiveTimeRequestBody requestBody)
        Retrieve the process call relationships linked from an specific element to its callers.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        calledGUID - unique identifier of the element that is processing the call
        requestBody - unique identifiers of software server capability representing the caller (optional)
        Returns:
        unique identifier and properties of the relationship 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)

      • setupLineageMapping

        public VoidResponse setupLineageMapping​(String serverName,
                                        String userId,
                                        String sourceElementGUID,
                                        String destinationElementGUID,
                                        EffectiveDatesRequestBody requestBody)
        Link to elements together to show that they are part of the lineage of the data that is moving between the processes. Typically the lineage relationships stitch together processes and data assets supported by different technologies.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        sourceElementGUID - unique identifier of the source
        destinationElementGUID - unique identifier of the destination
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)

      • clearLineageMapping

        public VoidResponse clearLineageMapping​(String serverName,
                                        String userId,
                                        String sourceElementGUID,
                                        String destinationElementGUID,
                                        EffectiveTimeMetadataSourceRequestBody requestBody)
        Remove the lineage mapping between two elements.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        sourceElementGUID - unique identifier of the source
        destinationElementGUID - unique identifier of the destination
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)

      • getDestinationLineageMappings

        public LineageMappingElementsResponse getDestinationLineageMappings​(String serverName,
                                                                    String userId,
                                                                    String sourceElementGUID,
                                                                    EffectiveTimeRequestBody requestBody)
        Retrieve the lineage mapping relationships linked from an specific source element to its destinations.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        sourceElementGUID - unique identifier of the source
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)

      • getSourceLineageMappings

        public LineageMappingElementsResponse getSourceLineageMappings​(String serverName,
                                                               String userId,
                                                               String destinationElementGUID,
                                                               EffectiveTimeRequestBody requestBody)
        Retrieve the lineage mapping relationships linked from an specific destination element to its sources.
        Parameters:
        serverName - name of the server to route the request to
        userId - calling user
        destinationElementGUID - unique identifier of the destination
        requestBody - unique identifiers of software server capability representing the caller (optional)
        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)