Class ConnectionMakerResource
java.lang.Object
org.odpi.openmetadata.viewservices.connectionmaker.server.spring.ConnectionMakerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class ConnectionMakerResource
extends Object
The ConnectionMakerResource provides part of the server-side implementation of the Connection Maker OMVS.
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateConnection
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a connection.createConnectionFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a connection using an existing metadata element as a template.createConnectorType
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a connectorType.createConnectorTypeFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a connectorType using an existing metadata element as a template.createEndpoint
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a endpoint.createEndpointFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a endpoint using an existing metadata element as a template.deleteConnection
(String serverName, String urlMarker, String connectionGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a connection.deleteConnectorType
(String serverName, String urlMarker, String connectorTypeGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a connectorType.deleteEndpoint
(String serverName, String urlMarker, String endpointGUID, boolean cascadedDelete, MetadataSourceRequestBody requestBody) Delete a endpoint.detachAssetFromConnection
(String serverName, String urlMarker, String assetGUID, String connectionGUID, MetadataSourceRequestBody requestBody) Detach an asset from a connection.detachITProfileRoleFromProfile
(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, MetadataSourceRequestBody requestBody) Detach an IT profile role from an IT profile.detachPersonRoleFromProfile
(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, MetadataSourceRequestBody requestBody) Detach a person role from a profile.detachProfileIdentity
(String serverName, String urlMarker, String endpointGUID, String profileGUID, MetadataSourceRequestBody requestBody) Detach a connection from a endpoint.detachTeamRoleFromProfile
(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, MetadataSourceRequestBody requestBody) Detach a team role from a team profile.findConnections
(String serverName, String urlMarker, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of connection metadata elements that contain the search string.findConnectorTypes
(String serverName, String urlMarker, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of connectorType metadata elements that contain the search string.findEndpoints
(String serverName, String urlMarker, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, FilterRequestBody requestBody) Retrieve the list of endpoint metadata elements that contain the search string.getConnectionByGUID
(String serverName, String urlMarker, String connectionGUID, AnyTimeRequestBody requestBody) Return the properties of a specific connection.getConnectionsByName
(String serverName, String urlMarker, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of connections with a particular name.getConnectorTypeByGUID
(String serverName, String urlMarker, String connectorTypeGUID, AnyTimeRequestBody requestBody) Return the properties of a specific connectorType.getConnectorTypesByName
(String serverName, String urlMarker, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of connectorTypes with a particular name.getEndpointByGUID
(String serverName, String urlMarker, String endpointGUID, AnyTimeRequestBody requestBody) Return the properties of a specific endpoint.getEndpointsByName
(String serverName, String urlMarker, int startFrom, int pageSize, FilterRequestBody requestBody) Returns the list of endpoints with a particular name.linkAssetToConnection
(String serverName, String urlMarker, String assetGUID, String connectionGUID, RelationshipRequestBody requestBody) Attach an asset to a connection.linkIdentityToProfile
(String serverName, String urlMarker, String endpointGUID, String profileGUID, RelationshipRequestBody requestBody) Attach a profile to a endpoint.linkITProfileRoleToProfile
(String serverName, String urlMarker, String itProfileRoleGUID, String itProfileGUID, RelationshipRequestBody requestBody) Attach an IT profile role to an IT profile.linkPersonRoleToProfile
(String serverName, String urlMarker, String personRoleGUID, String personProfileGUID, RelationshipRequestBody requestBody) Attach a person role to a person profile.linkTeamRoleToProfile
(String serverName, String urlMarker, String teamRoleGUID, String teamProfileGUID, RelationshipRequestBody requestBody) Attach a team role to a team profile.updateConnection
(String serverName, String urlMarker, String connectionGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody) Update the properties of a connection.updateConnectorType
(String serverName, String urlMarker, String connectorTypeGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody) Update the properties of a connectorType.updateEndpoint
(String serverName, String urlMarker, String endpointGUID, boolean replaceAllProperties, UpdateElementRequestBody requestBody) Update the properties of a endpoint.
-
Constructor Details
-
ConnectionMakerResource
public ConnectionMakerResource()Default constructor
-
-
Method Details
-
createConnection
@PostMapping(path="/connections") public GUIDResponse createConnection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a connection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/connections/from-template") public GUIDResponse createConnectionFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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 userurlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/connections/{connectionGUID}/update") public VoidResponse updateConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a connection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerconnectionGUID
- 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.
-
linkAssetToConnection
@PostMapping(path="/assets/{assetGUID}/connections/{connectionGUID}/attach") public VoidResponse linkAssetToConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody(required=false) RelationshipRequestBody requestBody) Attach an asset to a connection.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the connectionrequestBody
- 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
@PostMapping(path="/assets/{assetGUID}/connections/{connectionGUID}/detach") public VoidResponse detachAssetFromConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Detach an asset from a connection.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the IT profilerequestBody
- 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
@PostMapping(path="/connections/{connectionGUID}/delete") public VoidResponse deleteConnection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a connection.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerconnectionGUID
- unique identifier of the element to deletecascadedDelete
- 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
@PostMapping(path="/connections/by-name") public ConnectionsResponse getConnectionsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of connections with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/connections/by-search-string") public ConnectionsResponse findConnections(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) FilterRequestBody requestBody) Retrieve the list of connection metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/connections/{connectionGUID}/retrieve") public ConnectionResponse getConnectionByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectionGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific connection.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerconnectionGUID
- unique identifier of the required elementrequestBody
- 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
@PostMapping(path="/connector-types") public GUIDResponse createConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a connectorType.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/connector-types/from-template") public GUIDResponse createConnectorTypeFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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 userurlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/connector-types/{connectorTypeGUID}/update") public VoidResponse updateConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a connectorType.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerconnectorTypeGUID
- 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
@PostMapping(path="/connector-types/{personRoleGUID}/person-role-appointments/{personProfileGUID}/attach") public VoidResponse linkPersonRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personRoleGUID, @PathVariable String personProfileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody) Attach a person role to a person profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerpersonRoleGUID
- unique identifier of the person rolepersonProfileGUID
- unique identifier of the person profilerequestBody
- 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
@PostMapping(path="/connector-types/{personRoleGUID}/person-role-appointments/{personProfileGUID}/detach") public VoidResponse detachPersonRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String personRoleGUID, @PathVariable String personProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Detach a person role from a profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerpersonRoleGUID
- unique identifier of the person rolepersonProfileGUID
- unique identifier of the person profilerequestBody
- 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
@PostMapping(path="/connector-types/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/attach") public VoidResponse linkTeamRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamRoleGUID, @PathVariable String teamProfileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody) Attach a team role to a team profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerteamRoleGUID
- unique identifier of the team roleteamProfileGUID
- unique identifier of the team profilerequestBody
- 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
@PostMapping(path="/connector-types/{teamRoleGUID}/team-role-appointments/{teamProfileGUID}/detach") public VoidResponse detachTeamRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String teamRoleGUID, @PathVariable String teamProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Detach a team role from a team profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerteamRoleGUID
- unique identifier of the team roleteamProfileGUID
- unique identifier of the team profilerequestBody
- 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
@PostMapping(path="/connector-types/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/attach") public VoidResponse linkITProfileRoleToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String itProfileRoleGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody) Attach an IT profile role to an IT profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeritProfileRoleGUID
- unique identifier of the IT profile roleitProfileGUID
- unique identifier of the IT profilerequestBody
- 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
@PostMapping(path="/connector-types/{itProfileRoleGUID}/it-profile-role-appointments/{itProfileGUID}/detach") public VoidResponse detachITProfileRoleFromProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String itProfileRoleGUID, @PathVariable String itProfileGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Detach an IT profile role from an IT profile.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeritProfileRoleGUID
- unique identifier of the IT profile roleitProfileGUID
- unique identifier of the IT profilerequestBody
- 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
@PostMapping(path="/connector-types/{connectorTypeGUID}/delete") public VoidResponse deleteConnectorType(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a connectorType.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerconnectorTypeGUID
- unique identifier of the element to deletecascadedDelete
- 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
@PostMapping(path="/connector-types/by-name") public ConnectorTypesResponse getConnectorTypesByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of connectorTypes with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/connector-types/by-search-string") public ConnectorTypesResponse findConnectorTypes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) FilterRequestBody requestBody) Retrieve the list of connectorType metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/connector-types/{connectorTypeGUID}/retrieve") public ConnectorTypeResponse getConnectorTypeByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String connectorTypeGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific connectorType.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerconnectorTypeGUID
- unique identifier of the required elementrequestBody
- 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
@PostMapping(path="/endpoints") public GUIDResponse createEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a endpoint.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/endpoints/from-template") public GUIDResponse createEndpointFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) 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 userurlMarker
- view service URL markerrequestBody
- 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
@PostMapping(path="/endpoints/{endpointGUID}/update") public VoidResponse updateEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestParam(required=false,defaultValue="false") boolean replaceAllProperties, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a endpoint.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerendpointGUID
- 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
@PostMapping(path="/endpoints/{endpointGUID}/profile-identity/{profileGUID}/attach") public VoidResponse linkIdentityToProfile(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @PathVariable String profileGUID, @RequestBody(required=false) RelationshipRequestBody requestBody) Attach a profile to a endpoint.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerendpointGUID
- unique identifier of the endpointprofileGUID
- unique identifier of the connectionrequestBody
- 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
@PostMapping(path="/endpoints/{endpointGUID}/profile-identity/{profileGUID}/detach") public VoidResponse detachProfileIdentity(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @PathVariable String profileGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Detach a connection from a endpoint.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerendpointGUID
- unique identifier of the endpointprofileGUID
- unique identifier of the connectionrequestBody
- 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
@PostMapping(path="/endpoints/{endpointGUID}/delete") public VoidResponse deleteEndpoint(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Delete a endpoint.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerendpointGUID
- unique identifier of the element to deletecascadedDelete
- 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
@PostMapping(path="/endpoints/by-name") public EndpointsResponse getEndpointsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of endpoints with a particular name.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/endpoints/by-search-string") public EndpointsResponse findEndpoints(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody(required=false) FilterRequestBody requestBody) Retrieve the list of endpoint metadata elements that contain the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerstartsWith
- 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 pointpageSize
- maximum results that can be returnedrequestBody
- 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
@PostMapping(path="/endpoints/{endpointGUID}/retrieve") public EndpointResponse getEndpointByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String endpointGUID, @RequestBody(required=false) AnyTimeRequestBody requestBody) Return the properties of a specific endpoint.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerendpointGUID
- unique identifier of the required elementrequestBody
- 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)
-