Package org.odpi.openmetadata.accessservices.assetmanager.server

Class LineageExchangeRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.LineageExchangeRESTServices
public class LineageExchangeRESTServices extends Object
LineageExchangeRESTServices is the server-side implementation of the Asset Manager OMAS's support for processes, ports and lineage mapping. It matches the LineageExchangeClient.

  • Constructor Details

    • LineageExchangeRESTServices

      public LineageExchangeRESTServices()
      Default constructor

  • Method Details

    • createProcess

      public GUIDResponse createProcess(String serverName, String userId, boolean assetManagerIsHome, ProcessRequestBody requestBody)
      Create a new metadata element to represent a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this process
      requestBody - properties about the process to store
      Returns:
      unique identifier of the new process or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • createProcessFromTemplate

      public GUIDResponse createProcessFromTemplate(String serverName, String userId, boolean assetManagerIsHome, String templateGUID, TemplateRequestBody requestBody)
      Create a new metadata element to represent a process using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      assetManagerIsHome - ensure that only the process manager can update this process
      requestBody - properties that override the template
      Returns:
      unique identifier of the new process or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • updateProcess

      public VoidResponse updateProcess(String serverName, String userId, String processGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ProcessRequestBody requestBody)
      Update the metadata element representing a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for the metadata 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)

    • updateProcessStatus

      public VoidResponse updateProcessStatus(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, ProcessStatusRequestBody requestBody)
      Update the status of the metadata element representing a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the process to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • setupProcessParent

      public VoidResponse setupProcessParent(String serverName, String userId, String parentProcessGUID, String childProcessGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Create a parent-child relationship between two processes.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this process
      parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process
      childProcessGUID - unique identifier of the process in the external process manager that is to be the nested sub-process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • clearProcessParent

      public VoidResponse clearProcessParent(String serverName, String userId, String parentProcessGUID, String childProcessGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove a parent-child relationship between two processes.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process
      childProcessGUID - unique identifier of the process in the external process manager that is to be the nested sub-process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • publishProcess

      public VoidResponse publishProcess(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Update the zones for the process 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 Asset Manager OMAS).
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the metadata element to publish
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • withdrawProcess

      public VoidResponse withdrawProcess(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Update the zones for the process 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 Asset Manager OMAS. This is the setting when the process is first created).
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the metadata element to withdraw
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager 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)

    • removeProcess

      public VoidResponse removeProcess(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody)
      Remove the metadata element representing a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findProcesses

      public ProcessElementsResponse findProcesses(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody)
      Retrieve the list of process 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

    • getProcessesForAssetManager

      public ProcessElementsResponse getProcessesForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Return the list of processes associated with the process manager.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      list of metadata elements describing the processes associated with the requested asset manager 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)

    • getProcessesByName

      public ProcessElementsResponse getProcessesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody)
      Retrieve the list of process 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • getProcessByGUID

      public ProcessElementResponse getProcessByGUID(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the process metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      requested 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)

    • getProcessParent

      public ProcessElementResponse getProcessParent(String serverName, String userId, String processGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the process metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      parent process 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)

    • getSubProcesses

      public ProcessElementsResponse getSubProcesses(String serverName, String userId, String processGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the process metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the requested metadata element
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      list of process 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)

    • createPort

      public GUIDResponse createPort(String serverName, String userId, boolean assetManagerIsHome, String processGUID, boolean forLineage, boolean forDuplicateProcessing, PortRequestBody requestBody)
      Create a new metadata element to represent a port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this port
      processGUID - unique identifier of the process where the port is located
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the port
      Returns:
      unique identifier of the new metadata element for the port 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)

    • updatePort

      public VoidResponse updatePort(String serverName, String userId, String portGUID, boolean forLineage, boolean forDuplicateProcessing, PortRequestBody requestBody)
      Update the properties of the metadata element representing a port. This call replaces all existing properties with the supplied properties.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the port to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for the port
      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)

    • setupProcessPort

      public VoidResponse setupProcessPort(String serverName, String userId, boolean assetManagerIsHome, String processGUID, String portGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link a port to a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this process
      processGUID - unique identifier of the process
      portGUID - unique identifier of the port
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • clearProcessPort

      public VoidResponse clearProcessPort(String serverName, String userId, String processGUID, String portGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Unlink a port from a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the process
      portGUID - unique identifier of the port
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • setupPortDelegation

      public VoidResponse setupPortDelegation(String serverName, String userId, boolean assetManagerIsHome, String portOneGUID, String portTwoGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link two ports together to show that portTwo is an implementation of portOne. (That is, portOne delegates to portTwo.)
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this process
      portOneGUID - unique identifier of the port at end 1
      portTwoGUID - unique identifier of the port at end 2
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • clearPortDelegation

      public VoidResponse clearPortDelegation(String serverName, String userId, String portOneGUID, String portTwoGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove the port delegation relationship between two ports.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portOneGUID - unique identifier of the port at end 1
      portTwoGUID - unique identifier of the port at end 2
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • setupPortSchemaType

      public VoidResponse setupPortSchemaType(String serverName, String userId, boolean assetManagerIsHome, String portGUID, String schemaTypeGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link a schema type to a port to show the structure of data it accepts.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      assetManagerIsHome - ensure that only the process manager can update this process
      portGUID - unique identifier of the port
      schemaTypeGUID - unique identifier of the schemaType
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • clearPortSchemaType

      public VoidResponse clearPortSchemaType(String serverName, String userId, String portGUID, String schemaTypeGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove the schema type from a port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the port
      schemaTypeGUID - unique identifier of the schemaType
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • removePort

      public VoidResponse removePort(String serverName, String userId, String portGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody)
      Remove the metadata element representing a port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findPorts

      public PortElementsResponse findPorts(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody)
      Retrieve the list of port 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • getPortsForProcess

      public PortElementsResponse getPortsForProcess(String serverName, String userId, String processGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of ports associated with a process.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      processGUID - unique identifier of the process of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      list of associated 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)

    • getPortUse

      public PortElementsResponse getPortUse(String serverName, String userId, String portGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of ports that delegate to this port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the starting port
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      Returns:
      list of associated 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)

    • getPortDelegation

      public PortElementResponse getPortDelegation(String serverName, String userId, String portGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the port that this port delegates to.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the starting port alias
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      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)

    • getPortsByName

      public PortElementsResponse getPortsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody)
      Retrieve the list of port 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • getPortByGUID

      public PortElementResponse getPortByGUID(String serverName, String userId, String portGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the port metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      portGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software capability representing the caller (optional)
      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)

    • setBusinessSignificant

      public VoidResponse setBusinessSignificant(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody)
      Classify a port, process or process as "BusinessSignificant" (this may affect the way that lineage is displayed).
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      elementGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearBusinessSignificant

      public VoidResponse clearBusinessSignificant(String serverName, String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody)
      Remove the "BusinessSignificant" designation from the element.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      elementGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupDataFlow

      public GUIDResponse setupDataFlow(String serverName, String userId, String dataSupplierGUID, String dataConsumerGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      assetManagerIsHome - ensure that only the process manager can update this process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the data flow relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the data flow relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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 assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      assetManagerIsHome - ensure that only the process manager can update this process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • getControlFlowNextSteps

      public ControlFlowElementsResponse getControlFlowNextSteps(String serverName, String userId, String currentStepGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the control relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • getControlFlowPreviousSteps

      public ControlFlowElementsResponse getControlFlowPreviousSteps(String serverName, String userId, String currentStepGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the control relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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 assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      assetManagerIsHome - ensure that only the process manager can update this process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • updateProcessCall

      public VoidResponse updateProcessCall(String serverName, String userId, String processCallGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the process call relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the process call relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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 GUIDResponse setupLineageMapping(String serverName, String userId, String sourceElementGUID, String destinationElementGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody 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
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)

    • getLineageMapping

      public LineageMappingElementResponse getLineageMapping(String serverName, String userId, String sourceElementGUID, String destinationElementGUID, boolean forLineage, boolean forDuplicateProcessing, 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
      sourceElementGUID - unique identifier of the source
      destinationElementGUID - unique identifier of the destination
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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)

    • updateLineageMapping

      public VoidResponse updateLineageMapping(String serverName, String userId, String lineageMappingGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Update the lineage mapping between two elements.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      lineageMappingGUID - unique identifier of the relationship
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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 lineageMappingGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove the lineage mapping between two elements.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      lineageMappingGUID - unique identifier of the relationship
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the lineage mapping relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the lineage mapping relationships linked from a 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
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - unique identifiers of software 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)