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
VoidResponse	clearAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, MetadataSourceRequestBody requestBody)	Remove a relationship between an asset and its connection.
VoidResponse	clearConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, MetadataSourceRequestBody requestBody)	Remove a relationship between a connection and a connector type.
VoidResponse	clearEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, MetadataSourceRequestBody requestBody)	Remove a relationship between a virtual connection and an embedded connection.
VoidResponse	clearEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, MetadataSourceRequestBody requestBody)	Remove a relationship between a connection and an endpoint.
GUIDResponse	createConnection(String serverName, String userId, ConnectionRequestBody requestBody)	Create a new metadata element to represent a connection.
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.
GUIDResponse	createConnectorType(String serverName, String userId, ConnectorTypeRequestBody requestBody)	Create a new metadata element to represent a endpoint.
GUIDResponse	createConnectorTypeFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
GUIDResponse	createEndpoint(String serverName, String userId, String infrastructureGUID, EndpointRequestBody requestBody)	Create a new metadata element to represent a endpoint.
GUIDResponse	createEndpoint(String serverName, String userId, EndpointRequestBody requestBody)	Create a new metadata element to represent a endpoint.
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.
GUIDResponse	createEndpointFromTemplate(String serverName, String userId, String networkAddress, String templateGUID, TemplateRequestBody requestBody)	Create a new metadata element to represent a endpoint using an existing metadata element as a template.
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.
GUIDResponse	createSoftwareCapability(String serverName, String userId, boolean infrastructureManagerIsHome, SoftwareCapabilityRequestBody requestBody)	Create a new metadata element to represent a software capability.
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.
ConnectionsResponse	findConnections(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)	Retrieve the list of connection metadata elements that contain the search string.
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.
EndpointsResponse	findEndpoints(String serverName, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements that contain the search string.
SoftwareCapabilityListResponse	findSoftwareCapabilities(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)	Retrieve the list of software capability metadata elements that contain the search string.
ServerAssetUseListResponse	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.
ConnectionResponse	getConnectionByGUID(String serverName, String userId, String guid)	Retrieve the connection metadata element with the supplied unique identifier.
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.
ConnectorTypeResponse	getConnectorTypeByGUID(String serverName, String userId, String guid)	Retrieve the connector type metadata element with the supplied unique identifier.
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.
EndpointResponse	getEndpointByGUID(String serverName, String userId, String guid)	Retrieve the endpoint metadata element with the supplied unique identifier.
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.
EndpointsResponse	getEndpointsByNetworkAddress(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)	Retrieve the list of endpoint metadata elements with a matching network address.
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.
ConnectionResponse	getOutTopicConnection(String serverName, String userId, String callerId)	Return the connection object for the IT Infrastructure OMAS's out topic.
ServerAssetUseResponse	getServerAssetUseByGUID(String serverName, String userId, String guid)	Retrieve the server asset use type relationship with the supplied unique identifier.
ServerAssetUseListResponse	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.
ServerAssetUseListResponse	getServerAssetUsesForElements(String serverName, String userId, String capabilityGUID, String assetGUID, int startFrom, int pageSize, EffectiveTimeRequestBody requestBody)	Retrieve the list of relationships between a specific software capability and a specific asset.
SoftwareCapabilityListResponse	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.
SoftwareCapabilityResponse	getSoftwareCapabilityByGUID(String serverName, String userId, String guid)	Retrieve the software capability metadata element with the supplied unique identifier.
VoidResponse	removeConnection(String serverName, String userId, String connectionGUID, MetadataSourceRequestBody requestBody)	Remove the metadata element representing a connection.
VoidResponse	removeConnectorType(String serverName, String userId, String connectorTypeGUID, MetadataSourceRequestBody requestBody)	Remove the metadata element representing a connector type.
VoidResponse	removeEndpoint(String serverName, String userId, String endpointGUID, MetadataSourceRequestBody requestBody)	Remove the metadata element representing a endpoint.
VoidResponse	removeServerAssetUse(String serverName, String userId, String serverAssetUseGUID, MetadataSourceRequestBody requestBody)	Remove the metadata relationship to represent the use of an asset by a software capability.
VoidResponse	removeSoftwareCapability(String serverName, String userId, String capabilityGUID, MetadataSourceRequestBody requestBody)	Remove the metadata element representing a software capability.
VoidResponse	setupAssetConnection(String serverName, String userId, String assetGUID, String connectionGUID, AssetConnectionRequestBody requestBody)	Create a relationship between an asset and its connection.
VoidResponse	setupConnectorType(String serverName, String userId, String connectionGUID, String connectorTypeGUID, MetadataSourceRequestBody requestBody)	Create a relationship between a connection and a connector type.
VoidResponse	setupEmbeddedConnection(String serverName, String userId, String connectionGUID, String embeddedConnectionGUID, EmbeddedConnectionRequestBody requestBody)	Create a relationship between a virtual connection and an embedded connection.
VoidResponse	setupEndpoint(String serverName, String userId, String connectionGUID, String endpointGUID, MetadataSourceRequestBody requestBody)	Create a relationship between a connection and an endpoint.
VoidResponse	updateConnection(String serverName, String userId, String connectionGUID, boolean isMergeUpdate, ConnectionRequestBody requestBody)	Update the metadata element representing a connection.
VoidResponse	updateConnectorType(String serverName, String userId, String connectorTypeGUID, boolean isMergeUpdate, ConnectorTypeRequestBody requestBody)	Update the metadata element representing a endpoint.
VoidResponse	updateEndpoint(String serverName, String userId, String endpointGUID, boolean isMergeUpdate, EndpointRequestBody requestBody)	Update the metadata element representing a endpoint.
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.
VoidResponse	updateSoftwareCapability(String serverName, String userId, String capabilityGUID, boolean isMergeUpdate, SoftwareCapabilityRequestBody requestBody)	Update the metadata element representing a software capability.

Methods inherited from class java.lang.Object

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

Constructor Detail

ITInfrastructureResource

public ITInfrastructureResource()

Default constructor

Method Detail

getOutTopicConnection

@GetMapping(path="/topics/out-topic-connection/{callerId}")
public ConnectionResponse 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 GUIDResponse createConnection(@PathVariable
                                     String serverName,
                                     @PathVariable
                                     String userId,
                                     @RequestBody
                                     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 GUIDResponse createConnectionFromTemplate(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String templateGUID,
                                                 @RequestBody
                                                 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 VoidResponse updateConnection(@PathVariable
                                     String serverName,
                                     @PathVariable
                                     String userId,
                                     @PathVariable
                                     String connectionGUID,
                                     @RequestParam
                                     boolean isMergeUpdate,
                                     @RequestBody
                                     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 VoidResponse setupConnectorType(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String connectionGUID,
                                       @PathVariable
                                       String connectorTypeGUID,
                                       @RequestBody
                                       MetadataSourceRequestBody 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 VoidResponse clearConnectorType(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String connectionGUID,
                                       @PathVariable
                                       String connectorTypeGUID,
                                       @RequestBody
                                       MetadataSourceRequestBody 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 VoidResponse setupEndpoint(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String connectionGUID,
                                  @PathVariable
                                  String endpointGUID,
                                  @RequestBody
                                  MetadataSourceRequestBody 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 VoidResponse clearEndpoint(@PathVariable
                                  String serverName,
                                  @PathVariable
                                  String userId,
                                  @PathVariable
                                  String connectionGUID,
                                  @PathVariable
                                  String endpointGUID,
                                  @RequestBody
                                  MetadataSourceRequestBody 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 VoidResponse setupEmbeddedConnection(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String connectionGUID,
                                            @PathVariable
                                            String embeddedConnectionGUID,
                                            @RequestBody
                                            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 VoidResponse clearEmbeddedConnection(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String connectionGUID,
                                            @PathVariable
                                            String embeddedConnectionGUID,
                                            @RequestBody
                                            MetadataSourceRequestBody 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 VoidResponse setupAssetConnection(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String assetGUID,
                                         @PathVariable
                                         String connectionGUID,
                                         @RequestBody
                                         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 VoidResponse clearAssetConnection(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String assetGUID,
                                         @PathVariable
                                         String connectionGUID,
                                         @RequestBody
                                         MetadataSourceRequestBody 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 VoidResponse removeConnection(@PathVariable
                                     String serverName,
                                     @PathVariable
                                     String userId,
                                     @PathVariable
                                     String connectionGUID,
                                     @RequestBody
                                     MetadataSourceRequestBody 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 ConnectionsResponse findConnections(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @RequestBody
                                           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 ConnectionsResponse getConnectionsByName(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @RequestBody
                                                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 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 GUIDResponse createConnectorType(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @RequestBody
                                        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 GUIDResponse createConnectorTypeFromTemplate(@PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String userId,
                                                    @PathVariable
                                                    String templateGUID,
                                                    @RequestBody
                                                    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 VoidResponse updateConnectorType(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String connectorTypeGUID,
                                        @RequestParam
                                        boolean isMergeUpdate,
                                        @RequestBody
                                        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 VoidResponse removeConnectorType(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String connectorTypeGUID,
                                        @RequestBody
                                        MetadataSourceRequestBody 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 ConnectorTypesResponse findConnectorTypes(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @RequestBody
                                                 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 ConnectorTypesResponse getConnectorTypesByName(@PathVariable
                                                      String serverName,
                                                      @PathVariable
                                                      String userId,
                                                      @RequestBody
                                                      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 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 GUIDResponse createEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   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 GUIDResponse createEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String infrastructureGUID,
                                   @RequestBody
                                   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)

createEndpointFromTemplate

@PostMapping(path="/endpoints/network-address/{networkAddress}/from-template/{templateGUID}")
public GUIDResponse createEndpointFromTemplate(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String networkAddress,
                                               @PathVariable
                                               String templateGUID,
                                               @RequestBody
                                               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 GUIDResponse createEndpointFromTemplate(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String infrastructureGUID,
                                               @PathVariable
                                               String networkAddress,
                                               @PathVariable
                                               String templateGUID,
                                               @RequestBody
                                               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)

updateEndpoint

@PostMapping(path="/endpoints/{endpointGUID}")
public VoidResponse updateEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String endpointGUID,
                                   @RequestParam
                                   boolean isMergeUpdate,
                                   @RequestBody
                                   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 VoidResponse removeEndpoint(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String endpointGUID,
                                   @RequestBody
                                   MetadataSourceRequestBody 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 EndpointsResponse findEndpoints(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @RequestBody
                                       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 EndpointsResponse getEndpointsByName(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @RequestBody
                                            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 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 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 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 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 GUIDResponse createSoftwareCapability(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @RequestParam
                                             boolean infrastructureManagerIsHome,
                                             @RequestBody
                                             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 GUIDResponse createSoftwareCapabilityFromTemplate(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String templateGUID,
                                                         @RequestParam
                                                         boolean infrastructureManagerIsHome,
                                                         @RequestBody
                                                         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 VoidResponse updateSoftwareCapability(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String capabilityGUID,
                                             @RequestParam
                                             boolean isMergeUpdate,
                                             @RequestBody
                                             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 VoidResponse removeSoftwareCapability(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String capabilityGUID,
                                             @RequestBody
                                             MetadataSourceRequestBody 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 SoftwareCapabilityListResponse findSoftwareCapabilities(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestParam
                                                               int startFrom,
                                                               @RequestParam
                                                               int pageSize,
                                                               @RequestBody
                                                               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 SoftwareCapabilityListResponse getSoftwareCapabilitiesByName(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @RequestParam
                                                                    int startFrom,
                                                                    @RequestParam
                                                                    int pageSize,
                                                                    @RequestBody
                                                                    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 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 GUIDResponse createServerAssetUse(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String capabilityGUID,
                                         @PathVariable
                                         String assetGUID,
                                         @RequestParam
                                         boolean infrastructureManagerIsHome,
                                         @RequestBody
                                         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 VoidResponse updateServerAssetUse(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String serverAssetUseGUID,
                                         @RequestParam
                                         boolean isMergeUpdate,
                                         @RequestBody
                                         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 VoidResponse removeServerAssetUse(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String serverAssetUseGUID,
                                         @RequestBody
                                         MetadataSourceRequestBody 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 ServerAssetUseListResponse getServerAssetUsesForCapability(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String capabilityGUID,
                                                                  @RequestParam
                                                                  int startFrom,
                                                                  @RequestParam
                                                                  int pageSize,
                                                                  @RequestBody
                                                                  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 ServerAssetUseListResponse getCapabilityUsesForAsset(@PathVariable
                                                            String serverName,
                                                            @PathVariable
                                                            String userId,
                                                            @PathVariable
                                                            String assetGUID,
                                                            @RequestParam
                                                            int startFrom,
                                                            @RequestParam
                                                            int pageSize,
                                                            @RequestBody
                                                            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 ServerAssetUseListResponse getServerAssetUsesForElements(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String capabilityGUID,
                                                                @PathVariable
                                                                String assetGUID,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestBody
                                                                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 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)