Package org.odpi.openmetadata.viewservices.connectionmaker.server

Class ConnectionMakerRESTServices

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

  • Constructor Details

    • ConnectionMakerRESTServices

      public ConnectionMakerRESTServices()
      Default constructor

  • Method Details

    • createConnection

      public GUIDResponse createConnection(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create a connection.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the connection.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createConnectionFromTemplate

      public GUIDResponse createConnectionFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a connection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateConnection

      public VoidResponse updateConnection(String serverName, String viewServiceURLMarker, String connectionGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of a connection.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      connectionGUID - unique identifier of the connection (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkConnectionToAsset

      public VoidResponse linkConnectionToAsset(String serverName, String viewServiceURLMarker, String connectionGUID, String locationGUID, RelationshipRequestBody requestBody)
      Attach a profile to a location.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachLocationFromProfile

      public VoidResponse detachLocationFromProfile(String serverName, String viewServiceURLMarker, String connectionGUID, String locationGUID, MetadataSourceRequestBody requestBody)
      Detach a connection from a location.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      connectionGUID - unique identifier of the connection
      locationGUID - unique identifier of the location
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPeerPerson

      public VoidResponse linkPeerPerson(String serverName, String viewServiceURLMarker, String personOneGUID, String personTwoGUID, RelationshipRequestBody requestBody)
      Attach a person profile to one of its peers.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personOneGUID - unique identifier of the first connection
      personTwoGUID - unique identifier of the second connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPeerPerson

      public VoidResponse detachPeerPerson(String serverName, String viewServiceURLMarker, String personOneGUID, String personTwoGUID, MetadataSourceRequestBody requestBody)
      Detach a person profile from one of its peers.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personOneGUID - unique identifier of the first person profile
      personTwoGUID - unique identifier of the second person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamStructure

      public VoidResponse linkTeamStructure(String serverName, String viewServiceURLMarker, String superTeamGUID, String subteamGUID, RelationshipRequestBody requestBody)
      Attach a super team to a subteam.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamStructure

      public VoidResponse detachTeamStructure(String serverName, String viewServiceURLMarker, String superTeamGUID, String subteamGUID, MetadataSourceRequestBody requestBody)
      Detach a super team from a subteam.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      superTeamGUID - unique identifier of the super team
      subteamGUID - unique identifier of the subteam
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkAssetToConnection

      public VoidResponse linkAssetToConnection(String serverName, String viewServiceURLMarker, String assetGUID, String itProfileGUID, RelationshipRequestBody requestBody)
      Attach an asset to an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssetFromConnection

      public VoidResponse detachAssetFromConnection(String serverName, String viewServiceURLMarker, String assetGUID, String itProfileGUID, MetadataSourceRequestBody requestBody)
      Detach an asset from an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      assetGUID - unique identifier of the asset
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamToMembershipRole

      public VoidResponse linkTeamToMembershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, RelationshipRequestBody requestBody)
      Attach a team to its membership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamFromMembershipRole

      public VoidResponse detachTeamFromMembershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, MetadataSourceRequestBody requestBody)
      Detach a team profile from its membership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamToLeadershipRole

      public VoidResponse linkTeamToLeadershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, RelationshipRequestBody requestBody)
      Attach a team to its leadership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamFromLeadershipRole

      public VoidResponse detachTeamFromLeadershipRole(String serverName, String viewServiceURLMarker, String teamGUID, String personRoleGUID, MetadataSourceRequestBody requestBody)
      Detach a team profile from its leadership role.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamGUID - unique identifier of the team
      personRoleGUID - unique identifier of the associated person role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteConnection

      public VoidResponse deleteConnection(String serverName, String viewServiceURLMarker, String connectionGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a connection.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      connectionGUID - unique identifier of the element to delete
      cascadedDelete - ca connections be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getConnectionsByName

      public ConnectionsResponse getConnectionsByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getConnectionByGUID

      public ConnectionResponse getConnectionByGUID(String serverName, String viewServiceURLMarker, String connectionGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      connectionGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnections

      public ConnectionsResponse findConnections(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of connection metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)

    • createConnectorType

      public GUIDResponse createConnectorType(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create a connectorType.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the connectorType.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createConnectorTypeFromTemplate

      public GUIDResponse createConnectorTypeFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a connectorType using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateConnectorType

      public VoidResponse updateConnectorType(String serverName, String viewServiceURLMarker, String connectorTypeGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of a connectorType.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      connectorTypeGUID - unique identifier of the connectorType (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkPersonRoleToProfile

      public VoidResponse linkPersonRoleToProfile(String serverName, String viewServiceURLMarker, String personRoleGUID, String personProfileGUID, RelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachPersonRoleFromProfile

      public VoidResponse detachPersonRoleFromProfile(String serverName, String viewServiceURLMarker, String personRoleGUID, String personProfileGUID, MetadataSourceRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      personRoleGUID - unique identifier of the person role
      personProfileGUID - unique identifier of the person profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkTeamRoleToProfile

      public VoidResponse linkTeamRoleToProfile(String serverName, String viewServiceURLMarker, String teamRoleGUID, String teamProfileGUID, RelationshipRequestBody requestBody)
      Attach a team role to a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachTeamRoleFromProfile

      public VoidResponse detachTeamRoleFromProfile(String serverName, String viewServiceURLMarker, String teamRoleGUID, String teamProfileGUID, MetadataSourceRequestBody requestBody)
      Detach a team role from a team profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      teamRoleGUID - unique identifier of the team role
      teamProfileGUID - unique identifier of the team profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkITProfileRoleToProfile

      public VoidResponse linkITProfileRoleToProfile(String serverName, String viewServiceURLMarker, String itProfileRoleGUID, String itProfileGUID, RelationshipRequestBody requestBody)
      Attach an IT profile role to an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachITProfileRoleFromProfile

      public VoidResponse detachITProfileRoleFromProfile(String serverName, String viewServiceURLMarker, String itProfileRoleGUID, String itProfileGUID, MetadataSourceRequestBody requestBody)
      Detach an IT profile role from an IT profile.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      itProfileRoleGUID - unique identifier of the IT profile role
      itProfileGUID - unique identifier of the IT profile
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteConnectorType

      public VoidResponse deleteConnectorType(String serverName, String viewServiceURLMarker, String connectorTypeGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a connectorType.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      connectorTypeGUID - unique identifier of the element to delete
      cascadedDelete - ca connectorTypes be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getConnectorTypesByName

      public ConnectorTypesResponse getConnectorTypesByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getConnectorTypeByGUID

      public ConnectorTypeResponse getConnectorTypeByGUID(String serverName, String viewServiceURLMarker, String connectorTypeGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      connectorTypeGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findConnectorTypes

      public ConnectorTypesResponse findConnectorTypes(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of connectorType metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)

    • createEndpoint

      public GUIDResponse createEndpoint(String serverName, String viewServiceURLMarker, NewElementRequestBody requestBody)
      Create a endpoint.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      requestBody - properties for the endpoint.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createEndpointFromTemplate

      public GUIDResponse createEndpointFromTemplate(String serverName, String viewServiceURLMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a endpoint using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      viewServiceURLMarker - view service URL marker
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateEndpoint

      public VoidResponse updateEndpoint(String serverName, String viewServiceURLMarker, String endpointGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody)
      Update the properties of a endpoint.
      Parameters:
      serverName - name of called server.
      viewServiceURLMarker - view service URL marker
      endpointGUID - unique identifier of the endpoint (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkIdentityToProfile

      public VoidResponse linkIdentityToProfile(String serverName, String viewServiceURLMarker, String endpointGUID, String profileGUID, RelationshipRequestBody requestBody)
      Attach a profile to a endpoint.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      endpointGUID - unique identifier of the parent
      profileGUID - unique identifier of the connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachProfileIdentity

      public VoidResponse detachProfileIdentity(String serverName, String viewServiceURLMarker, String endpointGUID, String profileGUID, MetadataSourceRequestBody requestBody)
      Detach a connection from a endpoint.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      endpointGUID - unique identifier of the parent connection
      profileGUID - unique identifier of the nested connection
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteEndpoint

      public VoidResponse deleteEndpoint(String serverName, String viewServiceURLMarker, String endpointGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody)
      Delete a endpoint.
      Parameters:
      serverName - name of called server
      viewServiceURLMarker - view service URL marker
      endpointGUID - unique identifier of the element to delete
      cascadedDelete - can endpoints be deleted if data fields are attached?
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getEndpointsByName

      public EndpointsResponse getEndpointsByName(String serverName, String viewServiceURLMarker, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      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)

    • getEndpointByGUID

      public EndpointResponse getEndpointByGUID(String serverName, String viewServiceURLMarker, String endpointGUID, AnyTimeRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      endpointGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findEndpoints

      public EndpointsResponse findEndpoints(String serverName, String viewServiceURLMarker, boolean startsWith, boolean endsWith, boolean ignoreCase, int startFrom, int pageSize, FilterRequestBody requestBody)
      Retrieve the list of endpoint metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      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)