Class ITInfrastructureRESTServices
java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.server.ITInfrastructureRESTServices
The ITInfrastructureRESTServices provides the server-side implementation of the IT Infrastructure Open Metadata
Assess Service (OMAS). This interface provides support for defining infrastructure assets and their supporting
elements.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclearAssetConnection
(String serverName, String userId, String assetGUID, String connectionGUID, ExternalSourceRequestBody requestBody) Remove a relationship between an asset and its connection.clearConnectorType
(String serverName, String userId, String connectionGUID, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a connection and a connector type.clearEmbeddedConnection
(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a virtual connection and an embedded connection.clearEndpoint
(String serverName, String userId, String connectionGUID, String endpointGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a connection and an endpoint.createConnection
(String serverName, String userId, ConnectionRequestBody requestBody) Create a new metadata element to represent a connection.createConnectionFromTemplate
(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a connection using an existing metadata element as a template.createConnectorType
(String serverName, String userId, ConnectorTypeRequestBody requestBody) Create a new metadata element to represent a connector type.createConnectorTypeFromTemplate
(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a connector type using an existing metadata element as a template.createEndpoint
(String serverName, String userId, String infrastructureGUID, EndpointRequestBody requestBody) Create a new metadata element to represent a endpoint.createEndpointFromTemplate
(String serverName, String userId, String infrastructureGUID, String networkAddress, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a endpoint using an existing metadata element as a template.createServerAssetUse
(String serverName, String userId, String capabilityGUID, String assetGUID, boolean infrastructureManagerIsHome, ServerAssetUseRequestBody requestBody) Create a new metadata relationship to represent the use of an asset by a software capability.createSoftwareCapability
(String serverName, String userId, boolean infrastructureManagerIsHome, SoftwareCapabilityRequestBody requestBody) Create a new metadata element to represent a software capability.createSoftwareCapabilityFromTemplate
(String serverName, String userId, String templateGUID, boolean infrastructureManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a software capability using an existing metadata element as a template.findConnections
(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connection metadata elements that contain the search string.findConnectorTypes
(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connector type metadata elements that contain the search string.findEndpoints
(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements that contain the search string.findSoftwareCapabilities
(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of software capability metadata elements that contain the search string.getCapabilityUsesForAsset
(String serverName, String userId, String assetGUID, int startFrom, int pageSize, UseTypeRequestBody requestBody) Return the list of software capabilities that make use of a specific asset.getConnectionByGUID
(String serverName, String userId, String guid) Retrieve the connection metadata element with the supplied unique identifier.getConnectionsByName
(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connection metadata elements with a matching qualified or display name.getConnectorTypeByGUID
(String serverName, String userId, String guid) Retrieve the connector type metadata element with the supplied unique identifier.getConnectorTypesByName
(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connector type metadata elements with a matching qualified or display name.getEndpointByGUID
(String serverName, String userId, String guid) Retrieve the endpoint metadata element with the supplied unique identifier.getEndpointsByName
(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements with a matching qualified or display name.getEndpointsByNetworkAddress
(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements with a matching network address.getEndpointsForInfrastructure
(String serverName, String userId, String infrastructureGUID, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.getOutTopicConnection
(String serverName, String userId, String callerId) Return the client side connection object for the IT Infrastructure OMAS's out topic.getServerAssetUseByGUID
(String serverName, String userId, String guid) Retrieve the server asset use type relationship with the supplied unique identifier.getServerAssetUsesForCapability
(String serverName, String userId, String capabilityGUID, int startFrom, int pageSize, UseTypeRequestBody requestBody) Return the list of server asset use relationships associated with a software capability.getServerAssetUsesForElements
(String serverName, String userId, String capabilityGUID, String assetGUID, int startFrom, int pageSize, ResultsRequestBody requestBody) Retrieve the list of relationships between a specific software capability and a specific asset.getSoftwareCapabilitiesByName
(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of software capability metadata elements with a matching qualified or display name.getSoftwareCapabilityByGUID
(String serverName, String userId, String guid) Retrieve the software capability metadata element with the supplied unique identifier.removeConnection
(String serverName, String userId, String connectionGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a connection.removeConnectorType
(String serverName, String userId, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a connector type.removeEndpoint
(String serverName, String userId, String endpointGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a endpoint.removeServerAssetUse
(String serverName, String userId, String serverAssetUseGUID, ExternalSourceRequestBody requestBody) Remove the metadata relationship to represent the use of an asset by a software capability.removeSoftwareCapability
(String serverName, String userId, String capabilityGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a software capability.setupAssetConnection
(String serverName, String userId, String assetGUID, String connectionGUID, AssetConnectionRequestBody requestBody) Create a relationship between an asset and its connection.setupConnectorType
(String serverName, String userId, String connectionGUID, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Create a relationship between a connection and a connector type.setupEmbeddedConnection
(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, EmbeddedConnectionRequestBody requestBody) Create a relationship between a virtual connection and an embedded connection.setupEndpoint
(String serverName, String userId, String connectionGUID, String endpointGUID, ExternalSourceRequestBody requestBody) Create a relationship between a connection and an endpoint.updateConnection
(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, ConnectionRequestBody requestBody) Update the metadata element representing a connection.updateConnectorType
(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, ConnectorTypeRequestBody requestBody) Update the metadata element representing a connector type.updateEndpoint
(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, EndpointRequestBody requestBody) Update the metadata element representing a endpoint.updateServerAssetUse
(String serverName, String userId, String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseRequestBody requestBody) Update the metadata relationship to represent the use of an asset by a software capability.updateSoftwareCapability
(String serverName, String userId, String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityRequestBody requestBody) Update the metadata element representing a software capability.
-
Constructor Details
-
ITInfrastructureRESTServices
public ITInfrastructureRESTServices()Default constructor
-
-
Method Details
-
getOutTopicConnection
public OCFConnectionResponse getOutTopicConnection(String serverName, String userId, String callerId) Return the client side connection object for the IT Infrastructure OMAS's out topic.- Parameters:
serverName
- name of the service to route the request to.userId
- identifier of calling user.callerId
- unique identifier of the caller- Returns:
- connection object for the out topic or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.
-
createConnection
public GUIDResponse createConnection(String serverName, String userId, ConnectionRequestBody requestBody) Create a new metadata element to represent a connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element 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)
-
createConnectionFromTemplate
public GUIDResponse createConnectionFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a connection using an existing metadata element as a template.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usertemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element 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)
-
updateConnection
public VoidResponse updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, ConnectionRequestBody requestBody) Update the metadata element representing a connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with the existing properties of overlay them?requestBody
- new properties for this element- Returns:
- void 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)
-
setupConnectorType
public VoidResponse setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Create a relationship between a connection and a connector type.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the connection in the external data managerconnectorTypeGUID
- unique identifier of the connector type in the external data managerrequestBody
- data manager identifiers- Returns:
- void 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)
-
clearConnectorType
public VoidResponse clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a connection and a connector type.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the connection in the external data managerconnectorTypeGUID
- unique identifier of the connector type in the external data managerrequestBody
- data manager identifiers- Returns:
- void 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)
-
setupEndpoint
public VoidResponse setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, ExternalSourceRequestBody requestBody) Create a relationship between a connection and an endpoint.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the connection in the external data managerendpointGUID
- unique identifier of the endpoint in the external data managerrequestBody
- data manager identifiers- Returns:
- void 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)
-
clearEndpoint
public VoidResponse clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a connection and an endpoint.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the connection in the external data managerendpointGUID
- unique identifier of the endpoint in the external data managerrequestBody
- data manager identifiers- Returns:
- void 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)
-
setupEmbeddedConnection
public VoidResponse setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, EmbeddedConnectionRequestBody requestBody) Create a relationship between a virtual connection and an embedded connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the virtual connection in the external data managerembeddedConnectionGUID
- unique identifier of the embedded connection in the external data managerrequestBody
- data manager identifiers and properties for the embedded connection- Returns:
- void 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)
-
clearEmbeddedConnection
public VoidResponse clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, ExternalSourceRequestBody requestBody) Remove a relationship between a virtual connection and an embedded connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the virtual connection in the external data managerembeddedConnectionGUID
- unique identifier of the embedded connection in the external data managerrequestBody
- data manager identifiers- Returns:
- void 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)
-
setupAssetConnection
public VoidResponse setupAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, AssetConnectionRequestBody requestBody) Create a relationship between an asset and its connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the connectionrequestBody
- data manager identifiers and asset summary- Returns:
- void 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)
-
clearAssetConnection
public VoidResponse clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, ExternalSourceRequestBody requestBody) Remove a relationship between an asset and its connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userassetGUID
- unique identifier of the assetconnectionGUID
- unique identifier of the connectionrequestBody
- data manager identifiers- Returns:
- void 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)
-
removeConnection
public VoidResponse removeConnection(String serverName, String userId, String connectionGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a connection.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectionGUID
- unique identifier of the metadata element to removerequestBody
- external source identifiers- Returns:
- void 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)
-
findConnections
public ConnectionsResponse findConnections(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connection metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- 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)
-
getConnectionsByName
public ConnectionsResponse getConnectionsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- 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)
-
getConnectionByGUID
Retrieve the connection metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userguid
- unique identifier of the requested metadata element- Returns:
- matching metadata element 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)
-
createConnectorType
public GUIDResponse createConnectorType(String serverName, String userId, ConnectorTypeRequestBody requestBody) Create a new metadata element to represent a connector type.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- properties about the endpoint- Returns:
- unique identifier of the new endpoint 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)
-
createConnectorTypeFromTemplate
public GUIDResponse createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a connector type using an existing metadata element as a template.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usertemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new endpoint 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)
-
updateConnectorType
public VoidResponse updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, ConnectorTypeRequestBody requestBody) Update the metadata element representing a connector type.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectorTypeGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?requestBody
- new properties for the metadata element- Returns:
- void 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)
-
removeConnectorType
public VoidResponse removeConnectorType(String serverName, String userId, String connectorTypeGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a connector type.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userconnectorTypeGUID
- unique identifier of the element to removerequestBody
- external source identifiers- Returns:
- void 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)
-
findConnectorTypes
public ConnectorTypesResponse findConnectorTypes(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connector type metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- 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)
-
getConnectorTypesByName
public ConnectorTypesResponse getConnectorTypesByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of connector type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userrequestBody
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- 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)
-
getConnectorTypeByGUID
Retrieve the connector type metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userguid
- unique identifier of the requested metadata element- Returns:
- requested metadata element 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)
-
createEndpoint
public GUIDResponse createEndpoint(String serverName, String userId, String infrastructureGUID, EndpointRequestBody requestBody) Create a new metadata element to represent a endpoint.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userinfrastructureGUID
- unique identifier of the infrastructure to connect it to (optional)requestBody
- properties about the endpoint- Returns:
- unique identifier of the new endpoint 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)
-
createEndpointFromTemplate
public GUIDResponse createEndpointFromTemplate(String serverName, String userId, String infrastructureGUID, String networkAddress, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a endpoint using an existing metadata element as a template.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userinfrastructureGUID
- unique identifier of the infrastructure to connect it to (optional)networkAddress
- location of the endpointtemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new endpoint 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)
-
updateEndpoint
public VoidResponse updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, EndpointRequestBody requestBody) Update the metadata element representing a endpoint.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userendpointGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?requestBody
- new properties for the metadata element- Returns:
- void 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)
-
removeEndpoint
public VoidResponse removeEndpoint(String serverName, String userId, String endpointGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a endpoint.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userendpointGUID
- unique identifier of the metadata element to removerequestBody
- external source identifiers- Returns:
- void 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)
-
findEndpoints
public EndpointsResponse findEndpoints(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of calling serveruserId
- calling userrequestBody
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.
-
getEndpointsByName
public EndpointsResponse getEndpointsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of calling serveruserId
- calling userrequestBody
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.
-
getEndpointsByNetworkAddress
public EndpointsResponse getEndpointsByNetworkAddress(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements with a matching network address.- Parameters:
serverName
- name of calling serveruserId
- calling userrequestBody
- url to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to make this request or PropertyServerException the repository is not available or not working properly.
-
getEndpointsForInfrastructure
public EndpointsResponse getEndpointsForInfrastructure(String serverName, String userId, String infrastructureGUID, int startFrom, int pageSize) Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.- Parameters:
serverName
- name of calling serveruserId
- calling userinfrastructureGUID
- element to search forstartFrom
- paging start pointpageSize
- maximum results that can be returned- 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
Retrieve the endpoint metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userguid
- unique identifier of the requested metadata element- Returns:
- requested metadata element 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)
-
createSoftwareCapability
public GUIDResponse createSoftwareCapability(String serverName, String userId, boolean infrastructureManagerIsHome, SoftwareCapabilityRequestBody requestBody) Create a new metadata element to represent a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userinfrastructureManagerIsHome
- should the software capability be marked as owned by the infrastructure manager so others can not update?requestBody
- properties to store- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createSoftwareCapabilityFromTemplate
public GUIDResponse createSoftwareCapabilityFromTemplate(String serverName, String userId, String templateGUID, boolean infrastructureManagerIsHome, TemplateRequestBody requestBody) Create a new metadata element to represent a software capability using an existing metadata element as a template.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userinfrastructureManagerIsHome
- should the software capability be marked as owned by the infrastructure manager so others can not update?templateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateSoftwareCapability
public VoidResponse updateSoftwareCapability(String serverName, String userId, String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityRequestBody requestBody) Update the metadata element representing a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usercapabilityGUID
- unique identifier of the metadata element to updateisMergeUpdate
- are unspecified properties unchanged (true) or removed?requestBody
- new properties for this element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeSoftwareCapability
public VoidResponse removeSoftwareCapability(String serverName, String userId, String capabilityGUID, ExternalSourceRequestBody requestBody) Remove the metadata element representing a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usercapabilityGUID
- unique identifier of the metadata element to removerequestBody
- unique identifier of software capability representing the caller- 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)
-
findSoftwareCapabilities
public SoftwareCapabilitiesResponse findSoftwareCapabilities(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of software capability metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userstartFrom
- 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)
-
getSoftwareCapabilitiesByName
public SoftwareCapabilitiesResponse getSoftwareCapabilitiesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of software capability metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- values 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)
-
getSoftwareCapabilityByGUID
public SoftwareCapabilityResponse getSoftwareCapabilityByGUID(String serverName, String userId, String guid) Retrieve the software capability metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userguid
- unique identifier of the requested metadata element- 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)
-
createServerAssetUse
public GUIDResponse createServerAssetUse(String serverName, String userId, String capabilityGUID, String assetGUID, boolean infrastructureManagerIsHome, ServerAssetUseRequestBody requestBody) Create a new metadata relationship to represent the use of an asset by a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userinfrastructureManagerIsHome
- should the software capability be marked as owned by the infrastructure manager so others can not update?capabilityGUID
- unique identifier of a software capabilityassetGUID
- unique identifier of an assetrequestBody
- properties about the ServerAssetUse relationship- Returns:
- unique identifier of the new ServerAssetUse 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)
-
updateServerAssetUse
public VoidResponse updateServerAssetUse(String serverName, String userId, String serverAssetUseGUID, boolean isMergeUpdate, ServerAssetUseRequestBody requestBody) Update the metadata relationship to represent the use of an asset by a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userserverAssetUseGUID
- unique identifier of the relationship between a software capability and an assetisMergeUpdate
- are unspecified properties unchanged (true) or removed?requestBody
- new properties for the ServerAssetUse 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)
-
removeServerAssetUse
public VoidResponse removeServerAssetUse(String serverName, String userId, String serverAssetUseGUID, ExternalSourceRequestBody requestBody) Remove the metadata relationship to represent the use of an asset by a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userserverAssetUseGUID
- unique identifier of the relationship between a software capability and an assetrequestBody
- unique identifier of software capability representing the caller- 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)
-
getServerAssetUsesForCapability
public ServerAssetUsesResponse getServerAssetUsesForCapability(String serverName, String userId, String capabilityGUID, int startFrom, int pageSize, UseTypeRequestBody requestBody) Return the list of server asset use relationships associated with a software capability.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usercapabilityGUID
- unique identifier of the software capability to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- values to search for.- Returns:
- list of matching relationships 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)
-
getCapabilityUsesForAsset
public ServerAssetUsesResponse getCapabilityUsesForAsset(String serverName, String userId, String assetGUID, int startFrom, int pageSize, UseTypeRequestBody requestBody) Return the list of software capabilities that make use of a specific asset.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userassetGUID
- unique identifier of the asset to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- values to search for- Returns:
- list of matching relationships 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)
-
getServerAssetUsesForElements
public ServerAssetUsesResponse getServerAssetUsesForElements(String serverName, String userId, String capabilityGUID, String assetGUID, int startFrom, int pageSize, ResultsRequestBody requestBody) Retrieve the list of relationships between a specific software capability and a specific asset.- Parameters:
serverName
- name of the service to route the request to.userId
- calling usercapabilityGUID
- unique identifier of a software capabilityassetGUID
- unique identifier of an assetstartFrom
- paging start pointpageSize
- maximum results that can be returnedrequestBody
- effective time for the query- Returns:
- list of matching relationships 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)
-
getServerAssetUseByGUID
public ServerAssetUseResponse getServerAssetUseByGUID(String serverName, String userId, String guid) Retrieve the server asset use type relationship with the supplied unique identifier.- Parameters:
serverName
- name of the service to route the request to.userId
- calling userguid
- unique identifier of the requested metadata element- Returns:
- requested 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)
-