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

Class ITInfrastructureResource

java.lang.Object
org.odpi.openmetadata.accessservices.itinfrastructure.server.spring.ITInfrastructureResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/it-infrastructure/users/{userId}") public class ITInfrastructureResource extends Object
The ITInfrastructureResource provides the server-side implementation of the IT Infrastructure Open Metadata Assess Service (OMAS).

  • Constructor Summary

    Constructors
    Constructor
    Description
    ITInfrastructureResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnection(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
    Create a new metadata element to represent a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectionFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a connection using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorType(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeRequestBody requestBody)
    Create a new metadata element to represent a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpoint(String serverName, String userId, String infrastructureGUID, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
    Create a new metadata element to represent a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpoint(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
    Create a new metadata element to represent a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpointFromTemplate(String serverName, String userId, String infrastructureGUID, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, org.odpi.openmetadata.accessservices.itinfrastructure.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a endpoint using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createServerAssetUse(String serverName, String userId, String capabilityGUID, String assetGUID, boolean infrastructureManagerIsHome, org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUseRequestBody requestBody)
    Create a new metadata relationship to represent the use of an asset by a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createSoftwareCapability(String serverName, String userId, boolean infrastructureManagerIsHome, org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilityRequestBody requestBody)
    Create a new metadata element to represent a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createSoftwareCapabilityFromTemplate(String serverName, String userId, String templateGUID, boolean infrastructureManagerIsHome, org.odpi.openmetadata.accessservices.itinfrastructure.rest.TemplateRequestBody requestBody)
    Create a new metadata element to represent a software capability using an existing metadata element as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse
    findConnections(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse
    findConnectorTypes(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connector type metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse
    findEndpoints(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilitiesResponse
    findSoftwareCapabilities(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Retrieve the list of software capability metadata elements that contain the search string.
    org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse
    getCapabilityUsesForAsset(String serverName, String userId, String assetGUID, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.UseTypeRequestBody requestBody)
    Return the list of software capabilities that make use of a specific asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse
    getConnectionByGUID(String serverName, String userId, String guid)
    Retrieve the connection metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse
    getConnectionsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connection metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse
    getConnectorTypeByGUID(String serverName, String userId, String guid)
    Retrieve the connector type metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse
    getConnectorTypesByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of connector type metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse
    getEndpointByGUID(String serverName, String userId, String guid)
    Retrieve the endpoint metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse
    getEndpointsByName(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse
    getEndpointsByNetworkAddress(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
    Retrieve the list of endpoint metadata elements with a matching network address.
    org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse
    getOutTopicConnection(String serverName, String userId, String callerId)
    Return the connection object for the IT Infrastructure OMAS's out topic.
    org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUseResponse
    getServerAssetUseByGUID(String serverName, String userId, String guid)
    Retrieve the server asset use type relationship with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse
    getServerAssetUsesForCapability(String serverName, String userId, String capabilityGUID, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.UseTypeRequestBody requestBody)
    Return the list of server asset use relationships associated with a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse
    getServerAssetUsesForElements(String serverName, String userId, String capabilityGUID, String assetGUID, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody requestBody)
    Retrieve the list of relationships between a specific software capability and a specific asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilitiesResponse
    getSoftwareCapabilitiesByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Retrieve the list of software capability metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilityResponse
    getSoftwareCapabilityByGUID(String serverName, String userId, String guid)
    Retrieve the software capability metadata element with the supplied unique identifier.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnection(String serverName, String userId, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeConnectorType(String serverName, String userId, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeEndpoint(String serverName, String userId, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeServerAssetUse(String serverName, String userId, String serverAssetUseGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata relationship to represent the use of an asset by a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSoftwareCapability(String serverName, String userId, String capabilityGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Remove the metadata element representing a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.AssetConnectionRequestBody requestBody)
    Create a relationship between an asset and its connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Create a relationship between a connection and a connector type.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, org.odpi.openmetadata.commonservices.ffdc.rest.EmbeddedConnectionRequestBody requestBody)
    Create a relationship between a virtual connection and an embedded connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
    Create a relationship between a connection and an endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
    Update the metadata element representing a connection.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeRequestBody requestBody)
    Update the metadata element representing a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
    Update the metadata element representing a endpoint.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateServerAssetUse(String serverName, String userId, String serverAssetUseGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUseRequestBody requestBody)
    Update the metadata relationship to represent the use of an asset by a software capability.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateSoftwareCapability(String serverName, String userId, String capabilityGUID, boolean isMergeUpdate, org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilityRequestBody requestBody)
    Update the metadata element representing a software capability.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ITInfrastructureResource

      public ITInfrastructureResource()
      Default constructor

  • Method Details

    • getOutTopicConnection

      @GetMapping(path="/topics/out-topic-connection/{callerId}") public org.odpi.openmetadata.commonservices.ffdc.rest.OCFConnectionResponse getOutTopicConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String callerId)
      Return the connection object for the IT Infrastructure OMAS's out topic.
      Parameters:
      serverName - name of the server to route the request to
      userId - identifier of calling user
      callerId - unique identifier for 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

      @PostMapping(path="/connections") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnection(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
      Create a new metadata element to represent a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      requestBody - 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

      @PostMapping(path="/connections/from-template/{templateGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectionFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody org.odpi.openmetadata.accessservices.itinfrastructure.rest.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 user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid 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

      @PostMapping(path="/connections/{connectionGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionRequestBody requestBody)
      Update the metadata element representing a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the metadata element to update
      isMergeUpdate - 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

      @PostMapping(path="/connections/{connectionGUID}/connector-types/{connectorTypeGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupConnectorType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String connectorTypeGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      connectionGUID - unique identifier of the connection in the external data manager
      connectorTypeGUID - unique identifier of the connector type in the external data manager
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/connector-types/{connectorTypeGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearConnectorType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String connectorTypeGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      connectionGUID - unique identifier of the connection in the external data manager
      connectorTypeGUID - unique identifier of the connector type in the external data manager
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/endpoints/{endpointGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEndpoint(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String endpointGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Create a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      endpointGUID - unique identifier of the endpoint in the external data manager
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/endpoints/{endpointGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEndpoint(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String endpointGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between a connection and an endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the connection in the external data manager
      endpointGUID - unique identifier of the endpoint in the external data manager
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/embedded-connections/{embeddedConnectionGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupEmbeddedConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String embeddedConnectionGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      connectionGUID - unique identifier of the virtual connection in the external data manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/embedded-connections/{embeddedConnectionGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearEmbeddedConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @PathVariable String embeddedConnectionGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      connectionGUID - unique identifier of the virtual connection in the external data manager
      embeddedConnectionGUID - unique identifier of the embedded connection in the external data manager
      requestBody - 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

      @PostMapping(path="assets/{assetGUID}/connections/{connectionGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAssetConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.AssetConnectionRequestBody requestBody)
      Create a relationship between an asset and its connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      requestBody - 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

      @PostMapping(path="assets/{assetGUID}/connections/{connectionGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAssetConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String connectionGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove a relationship between an asset and its connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      assetGUID - unique identifier of the asset
      connectionGUID - unique identifier of the connection
      requestBody - 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

      @PostMapping(path="/connections/{connectionGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnection(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectionGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a connection.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectionGUID - unique identifier of the metadata element to remove
      requestBody - 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

      @PostMapping(path="/connections/by-search-string") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse findConnections(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - 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

      @PostMapping(path="/connections/by-name") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionsResponse getConnectionsByName(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - 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

      @GetMapping(path="/connections/{guid}") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectionResponse getConnectionByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Retrieve the connection metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - 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

      @PostMapping(path="/connector-types") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorType(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeRequestBody requestBody)
      Create a new metadata element to represent a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      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)

    • createConnectorTypeFromTemplate

      @PostMapping(path="/connector-types/from-template/{templateGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createConnectorTypeFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody org.odpi.openmetadata.accessservices.itinfrastructure.rest.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 user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - 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

      @PostMapping(path="/connector-types/{connectorTypeGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateConnectorType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectorTypeGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeRequestBody requestBody)
      Update the metadata element representing a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectorTypeGUID - unique identifier of the metadata element to update
      isMergeUpdate - 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

      @PostMapping(path="/connector-types/{connectorTypeGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeConnectorType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String connectorTypeGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a connector type.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      connectorTypeGUID - unique identifier of the metadata element to remove
      requestBody - 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

      @PostMapping(path="/connector-types/by-search-string") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse findConnectorTypes(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - 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

      @PostMapping(path="/connector-types/by-name") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypesResponse getConnectorTypesByName(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - 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

      @GetMapping(path="/connector-types/{guid}") public org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse getConnectorTypeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Retrieve the connector type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - 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

      @PostMapping(path="/endpoints") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpoint(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
      Create a new metadata element to represent a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      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)

    • createEndpoint

      @PostMapping(path="/endpoints/for-infrastructure/{infrastructureGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpoint(@PathVariable String serverName, @PathVariable String userId, @PathVariable String infrastructureGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
      Create a new metadata element to represent a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      infrastructureGUID - unique identifier of the infrastructure element that has this endpoint
      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

      @PostMapping(path="/endpoints/network-address/{networkAddress}/from-template/{templateGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpointFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String networkAddress, @PathVariable String templateGUID, @RequestBody org.odpi.openmetadata.accessservices.itinfrastructure.rest.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 user
      networkAddress - location of the endpoint
      templateGUID - unique identifier of the metadata element to copy
      requestBody - 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)

    • createEndpointFromTemplate

      @PostMapping(path="/endpoints/for-infrastructure/{infrastructureGUID}/network-address/{networkAddress}/from-template/{templateGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createEndpointFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String infrastructureGUID, @PathVariable String networkAddress, @PathVariable String templateGUID, @RequestBody org.odpi.openmetadata.accessservices.itinfrastructure.rest.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 user
      infrastructureGUID - unique identifier of the infrastructure element that has this endpoint
      networkAddress - location of the endpoint
      templateGUID - unique identifier of the metadata element to copy
      requestBody - 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

      @PostMapping(path="/endpoints/{endpointGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateEndpoint(@PathVariable String serverName, @PathVariable String userId, @PathVariable String endpointGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.EndpointRequestBody requestBody)
      Update the metadata element representing a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      endpointGUID - unique identifier of the metadata element to update
      isMergeUpdate - 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

      @PostMapping(path="/endpoints/{endpointGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeEndpoint(@PathVariable String serverName, @PathVariable String userId, @PathVariable String endpointGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a endpoint.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      endpointGUID - unique identifier of the metadata element to remove
      requestBody - 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

      @PostMapping(path="/endpoints/by-search-string") public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse findEndpoints(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 the service to route the request to.
      userId - calling user
      requestBody - string to find in the properties
      startFrom - paging start point
      pageSize - 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)

    • getEndpointsByName

      @PostMapping(path="/endpoints/by-name") public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse getEndpointsByName(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, @RequestParam int startFrom, @RequestParam 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 the service to route the request to.
      userId - calling user
      requestBody - name to search for
      startFrom - paging start point
      pageSize - 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)

    • getEndpointsByNetworkAddress

      @PostMapping(path="/endpoints/by-network-address") public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse getEndpointsByNetworkAddress(String serverName, String userId, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody, int startFrom, int pageSize)
      Retrieve the list of endpoint metadata elements with a matching network address.
      Parameters:
      serverName - name of calling server
      userId - calling user
      requestBody - url to search for
      startFrom - paging start point
      pageSize - 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

      @GetMapping(path="/endpoints/for-infrastructure/{infrastructureGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointsResponse getEndpointsForInfrastructure(@PathVariable String serverName, @PathVariable String userId, @PathVariable String infrastructureGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve the list of endpoint metadata elements that are attached to a specific infrastructure element.
      Parameters:
      serverName - name of calling server
      userId - calling user
      infrastructureGUID - element to search for
      startFrom - paging start point
      pageSize - 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

      @GetMapping(path="/endpoints/{guid}") public org.odpi.openmetadata.commonservices.ffdc.rest.EndpointResponse getEndpointByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid)
      Retrieve the endpoint metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      guid - 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

      @PostMapping(path="/software-capabilities") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createSoftwareCapability(@PathVariable String serverName, @PathVariable String userId, @RequestParam boolean infrastructureManagerIsHome, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      infrastructureManagerIsHome - 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

      @PostMapping(path="/software-capabilities/from-template/{templateGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createSoftwareCapabilityFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestParam boolean infrastructureManagerIsHome, @RequestBody org.odpi.openmetadata.accessservices.itinfrastructure.rest.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 user
      infrastructureManagerIsHome - 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 copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateSoftwareCapability

      @PostMapping(path="/software-capabilities/{capabilityGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateSoftwareCapability(@PathVariable String serverName, @PathVariable String userId, @PathVariable String capabilityGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilityRequestBody requestBody)
      Update the metadata element representing a software capability.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      capabilityGUID - unique identifier of the metadata element to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeSoftwareCapability

      @PostMapping(path="/software-capabilities/{capabilityGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSoftwareCapability(@PathVariable String serverName, @PathVariable String userId, @PathVariable String capabilityGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.ExternalSourceRequestBody requestBody)
      Remove the metadata element representing a software capability.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      capabilityGUID - unique identifier of the metadata element to remove
      requestBody - 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

      @PostMapping(path="/software-capabilities/by-search-string") public org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilitiesResponse findSoftwareCapabilities(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      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)

    • getSoftwareCapabilitiesByName

      @PostMapping(path="/software-capabilities/by-name") public org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilitiesResponse getSoftwareCapabilitiesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - 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

      @GetMapping(path="/software-capabilities/{guid}") public org.odpi.openmetadata.commonservices.ffdc.rest.SoftwareCapabilityResponse getSoftwareCapabilityByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable 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 user
      guid - 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

      @PostMapping(path="/server-asset-uses/software-capabilities/{capabilityGUID}/assets/{assetGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createServerAssetUse(@PathVariable String serverName, @PathVariable String userId, @PathVariable String capabilityGUID, @PathVariable String assetGUID, @RequestParam boolean infrastructureManagerIsHome, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      infrastructureManagerIsHome - should the software capability be marked as owned by the infrastructure manager so others can not update?
      capabilityGUID - unique identifier of a software capability
      assetGUID - unique identifier of an asset
      requestBody - 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

      @PostMapping(path="/server-asset-uses/{serverAssetUseGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateServerAssetUse(@PathVariable String serverName, @PathVariable String userId, @PathVariable String serverAssetUseGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      serverAssetUseGUID - unique identifier of the relationship between a software capability and an asset
      isMergeUpdate - 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

      @PostMapping(path="/server-asset-uses/{serverAssetUseGUID}/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeServerAssetUse(@PathVariable String serverName, @PathVariable String userId, @PathVariable String serverAssetUseGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      serverAssetUseGUID - unique identifier of the relationship between a software capability and an asset
      requestBody - 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

      @PostMapping(path="/server-asset-uses/software-capabilities/{capabilityGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse getServerAssetUsesForCapability(@PathVariable String serverName, @PathVariable String userId, @PathVariable String capabilityGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      capabilityGUID - unique identifier of the software capability to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - 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

      @PostMapping(path="/server-asset-uses/assets/{assetGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse getCapabilityUsesForAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 user
      assetGUID - unique identifier of the asset to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - 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

      @PostMapping(path="/server-asset-uses/software-capabilities/{capabilityGUID}/assets/{assetGUID}/by-elements") public org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUsesResponse getServerAssetUsesForElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String capabilityGUID, @PathVariable String assetGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.EffectiveTimeRequestBody 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 user
      capabilityGUID - unique identifier of a software capability
      assetGUID - unique identifier of an asset
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - 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

      @GetMapping(path="/server-asset-uses/{guid}") public org.odpi.openmetadata.commonservices.ffdc.rest.ServerAssetUseResponse getServerAssetUseByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable 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 user
      guid - 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)