Package org.odpi.openmetadata.viewservices.assetmaker.server.spring

Class AssetMakerResource

java.lang.Object

org.odpi.openmetadata.viewservices.assetmaker.server.spring.AssetMakerResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class AssetMakerResource
extends Object

The AssetMakerResource provides part of the server-side implementation of the Asset Maker OMVS. =

Constructor Summary

Constructors

Constructor	Description
AssetMakerResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
GUIDResponse	addActionTarget(String serverName, String urlMarker, String actionGUID, String metadataElementGUID, NewRelationshipRequestBody requestBody)	Add an element to an action's workload.
VoidResponse	addCapabilityAssetUse(String serverName, String urlMarker, String softwareCapabilityGUID, String assetGUID, NewRelationshipRequestBody requestBody)	Create a relationship that represents the use of an asset by a software capability.
GUIDResponse	addCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String metadataElementGUID, NewRelationshipRequestBody requestBody)	Add a catalog target to an integration connector.
VoidResponse	assignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody)	Assign an action to an actor.
VoidResponse	clearAPIAsListenerInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)	Remove the listener interface designation from a deployed API.
VoidResponse	clearAPIAsPublisherInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)	Remove the publisher interface designation from a deployed API.
VoidResponse	clearAPIAsRequestResponseInterface(String serverName, String urlMarker, String deployedAPIGUID, DeleteClassificationRequestBody requestBody)	Remove the request-response interface designation from a deployed API.
VoidResponse	clearAssetAsAuditLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the audit log designation from an asset.
VoidResponse	clearAssetAsExceptionBacklog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the exception backlog designation from an asset.
VoidResponse	clearAssetAsLineageLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the lineage log designation from an asset.
VoidResponse	clearAssetAsLogAnalysis(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the log analysis designation from an asset.
VoidResponse	clearAssetAsMeteringLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the metering log designation from an asset.
VoidResponse	clearAssetAsSecurityLog(String serverName, String urlMarker, String assetGUID, DeleteClassificationRequestBody requestBody)	Remove the security log designation from an asset.
VoidResponse	clearDataAssetEncoding(String serverName, String urlMarker, String dataAssetGUID, DeleteClassificationRequestBody requestBody)	Remove the encoding description from a data asset.
GUIDResponse	createAction(String serverName, String urlMarker, ActionRequestBody requestBody)	Create a new action and link it to the supplied actor and targets (if applicable).
GUIDResponse	createAsset(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create an asset.
GUIDResponse	createAssetFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)	Create a new metadata element to represent an asset using an existing metadata element as a template.
GUIDResponse	createSoftwareCapability(String serverName, String urlMarker, NewElementRequestBody requestBody)	Create a software capability.
GUIDResponse	createSoftwareCapabilityFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)	Create a new metadata element to represent a software capability using an existing metadata element as a template.
VoidResponse	deleteAsset(String serverName, String urlMarker, String assetGUID, DeleteElementRequestBody requestBody)	Delete an asset.
VoidResponse	deployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, NewRelationshipRequestBody requestBody)	Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).
VoidResponse	detachAPIEndpoint(String serverName, String urlMarker, String deployedAPIGUID, String endpointGUID, DeleteRelationshipRequestBody requestBody)	Detach a deployed API from the endpoint where it is called.
VoidResponse	detachArchiveContents(String serverName, String urlMarker, String archiveFileGUID, String collectionGUID, DeleteRelationshipRequestBody requestBody)	Detach an archive file from the collection that described its contents.
VoidResponse	detachAssociatedLog(String serverName, String urlMarker, String elementGUID, String logAssetGUID, DeleteRelationshipRequestBody requestBody)	Detach an asset that holds a log from the element that the log was about.
VoidResponse	detachDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, DeleteRelationshipRequestBody requestBody)	Detach a data set from another asset that was supplying the data and is no more.
VoidResponse	detachFolderHierarchy(String serverName, String urlMarker, String parentFolderGUID, String childFolderGUID, DeleteRelationshipRequestBody requestBody)	Detach a child file folder from its parent file folder.
VoidResponse	detachImpactedResource(String serverName, String urlMarker, String resourceGUID, String incidentReportGUID, DeleteRelationshipRequestBody requestBody)	Detach a resource from an incident report that no longer impacts it.
VoidResponse	detachLinkedFile(String serverName, String urlMarker, String folderGUID, String fileGUID, DeleteRelationshipRequestBody requestBody)	Detach a data file from a file folder that links to it without storing it.
VoidResponse	detachLinkedMedia(String serverName, String urlMarker, String mediaFileGUID, String linkedMediaFileGUID, DeleteRelationshipRequestBody requestBody)	Detach a media file from another media file that was related to it.
VoidResponse	detachNestedFile(String serverName, String urlMarker, String folderGUID, String fileGUID, DeleteRelationshipRequestBody requestBody)	Detach a data file from the file folder that it is stored in.
VoidResponse	detachPortDelegation(String serverName, String urlMarker, String delegatingFromPortGUID, String delegatingToPortGUID, DeleteRelationshipRequestBody requestBody)	Detach a port from the port that it delegated to.
VoidResponse	detachProcessHierarchy(String serverName, String urlMarker, String parentProcessGUID, String childProcessGUID, DeleteRelationshipRequestBody requestBody)	Detach a child process from its parent process.
VoidResponse	detachProcessPort(String serverName, String urlMarker, String processGUID, String portGUID, DeleteRelationshipRequestBody requestBody)	Detach a port from the process that owned it.
VoidResponse	detachRegisteredIntegrationConnector(String serverName, String urlMarker, String integrationGroupGUID, String integrationConnectorGUID, DeleteRelationshipRequestBody requestBody)	Remove an integration connector from the integration group that ran it.
VoidResponse	detachSampleData(String serverName, String urlMarker, String elementGUID, String sampleDataGUID, DeleteRelationshipRequestBody requestBody)	Detach an asset holding sample data from the element that the sample was taken from.
VoidResponse	detachSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, DeleteRelationshipRequestBody requestBody)	Remove a relationship that links a software capability to an infrastructure asset like a software server.
VoidResponse	detachSupportedGovernanceService(String serverName, String urlMarker, String supportedGovernanceServiceGUID, DeleteRelationshipRequestBody requestBody)	Remove a SupportedGovernanceService relationship.
OpenMetadataRootElementsResponse	findAssets(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Retrieve the list of asset metadata elements that contain the search string.
OpenMetadataRootElementsResponse	findDataAssets(String serverName, String urlMarker, ContentStatusSearchString requestBody)	Returns the list of data assets matching the search string and optional content status.
OpenMetadataRootElementsResponse	findInfrastructure(String serverName, String urlMarker, DeploymentStatusSearchString requestBody)	Returns the list of infrastructure assets matching the search string and optional deployment status.
OpenMetadataRootElementsResponse	findProcesses(String serverName, String urlMarker, ActivityStatusSearchString requestBody)	Retrieve the processes that match the search string and activity status.
OpenMetadataRootElementsResponse	findSoftwareCapabilities(String serverName, String urlMarker, SearchStringRequestBody requestBody)	Retrieve the list of software capability metadata elements that contain the search string.
OpenMetadataRootElementsResponse	getActionsForActionTarget(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)	Retrieve the "Actions" that are chained off of an action target element.
OpenMetadataRootElementsResponse	getActionsForSponsor(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)	Retrieve the "Actions" that are chained of a sponsor's element.
OpenMetadataRootElementsResponse	getActionsFromRequester(String serverName, String urlMarker, String elementGUID, ActivityStatusRequestBody requestBody)	Retrieve the "Actions" that are chained off a requester's element.
OpenMetadataRelationshipResponse	getActionTarget(String serverName, String urlMarker, String actionTargetGUID, GetRequestBody requestBody)	Retrieve a specific action target associated with an action.
OpenMetadataRootElementsResponse	getActionTargets(String serverName, String urlMarker, String actionGUID, ActivityStatusRequestBody requestBody)	Return a list of elements that are target elements for an action.
OpenMetadataRootElementResponse	getAssetByGUID(String serverName, String urlMarker, String assetGUID, GetRequestBody requestBody)	Return the properties of a specific asset.
OpenMetadataRootElementsResponse	getAssetsByName(String serverName, String urlMarker, FilterRequestBody requestBody)	Returns the list of assets with a particular name.
OpenMetadataRootElementsResponse	getAssignedActions(String serverName, String urlMarker, String actorGUID, ActivityStatusRequestBody requestBody)	Retrieve the actions for a particular actor.
OpenMetadataRootElementsResponse	getCapabilityUse(String serverName, String urlMarker, String assetGUID, ResultsRequestBody requestBody)	Retrieve the software capabilities using a particular asset.
OpenMetadataRelationshipResponse	getCatalogTarget(String serverName, String urlMarker, String relationshipGUID, GetRequestBody requestBody)	Retrieve a specific catalog target associated with an integration connector.
OpenMetadataRootElementsResponse	getCatalogTargets(String serverName, String urlMarker, String integrationConnectorGUID, ResultsRequestBody requestBody)	Retrieve the details of the metadata elements identified as catalog targets with an integration connector.
OpenMetadataRootElementsResponse	getDataAssetsByCategory(String serverName, String urlMarker, ContentStatusFilterRequestBody requestBody)	Returns the list of data assets matching the category and optional content status.
OpenMetadataRootElementsResponse	getGovernanceEngines(String serverName, String urlMarker, String governanceServiceGUID, ResultsRequestBody requestBody)	Retrieve the governance engines connected to a particular governance service.
OpenMetadataRootElementsResponse	getInfrastructureByCategory(String serverName, String urlMarker, DeploymentStatusFilterRequestBody requestBody)	Returns the list of infrastructure assets matching the category and optional deployment status.
OpenMetadataRootElementsResponse	getIntegrationGroups(String serverName, String urlMarker, String integrationConnectorGUID, ResultsRequestBody requestBody)	Retrieve the integration groups connected to a particular integration connector.
OpenMetadataRootElementsResponse	getProcessesByCategory(String serverName, String urlMarker, ActivityStatusFilterRequestBody requestBody)	Retrieve the actions that match the category name and status.
OpenMetadataRootElementsResponse	getSoftwareCapabilitiesByDeployedImplementationType(String serverName, String urlMarker, FilterRequestBody requestBody)	Retrieve the list of software capabilities with a particular deployed implementation type.
OpenMetadataRootElementsResponse	getSoftwareCapabilitiesByName(String serverName, String urlMarker, FilterRequestBody requestBody)	Retrieve the list of software capabilities with a particular name.
OpenMetadataRootElementsResponse	getSoftwareCapabilitiesForInfrastructure(String serverName, String urlMarker, String infrastructureGUID, ResultsRequestBody requestBody)	Retrieve the list of software capabilities attached to a specific infrastructure element.
OpenMetadataRootElementResponse	getSoftwareCapabilityByGUID(String serverName, String urlMarker, String softwareCapabilityGUID, GetRequestBody requestBody)	Retrieve a specific software capability.
VoidResponse	linkAPIEndpoint(String serverName, String urlMarker, String deployedAPIGUID, String endpointGUID, NewRelationshipRequestBody requestBody)	Attach a deployed API to the endpoint where it is called.
VoidResponse	linkArchiveContents(String serverName, String urlMarker, String archiveFileGUID, String collectionGUID, NewRelationshipRequestBody requestBody)	Attach an archive file to the collection that describes its contents.
VoidResponse	linkAssociatedLog(String serverName, String urlMarker, String elementGUID, String logAssetGUID, NewRelationshipRequestBody requestBody)	Attach an asset that holds a log to the element that the log is about.
VoidResponse	linkDataSetContent(String serverName, String urlMarker, String dataSetGUID, String dataContentAssetGUID, NewRelationshipRequestBody requestBody)	Attach a data set to another asset (typically a data store) that is supplying the data.
VoidResponse	linkFolderHierarchy(String serverName, String urlMarker, String parentFolderGUID, String childFolderGUID, NewRelationshipRequestBody requestBody)	Attach a child file folder to its parent file folder.
VoidResponse	linkImpactedResource(String serverName, String urlMarker, String resourceGUID, String incidentReportGUID, NewRelationshipRequestBody requestBody)	Attach a resource that is impacted by an incident report to that incident report.
VoidResponse	linkLinkedFiles(String serverName, String urlMarker, String folderGUID, String fileGUID, NewRelationshipRequestBody requestBody)	Attach a data file to a file folder that links to it without storing it.
VoidResponse	linkLinkedMedia(String serverName, String urlMarker, String mediaFileGUID, String linkedMediaFileGUID, NewRelationshipRequestBody requestBody)	Attach a media file to another media file that is related to it.
VoidResponse	linkNestedFiles(String serverName, String urlMarker, String folderGUID, String fileGUID, NewRelationshipRequestBody requestBody)	Attach a data file to the file folder that it is stored in.
VoidResponse	linkPortDelegation(String serverName, String urlMarker, String delegatingFromPortGUID, String delegatingToPortGUID, NewRelationshipRequestBody requestBody)	Attach a port to the port that it delegates to.
VoidResponse	linkProcessHierarchy(String serverName, String urlMarker, String parentProcessGUID, String childProcessGUID, NewRelationshipRequestBody requestBody)	Attach a child process to its parent process.
VoidResponse	linkProcessPort(String serverName, String urlMarker, String processGUID, String portGUID, NewRelationshipRequestBody requestBody)	Attach a port to the process that owns it.
VoidResponse	linkRegisteredIntegrationConnector(String serverName, String urlMarker, String integrationGroupGUID, String integrationConnectorGUID, NewRelationshipRequestBody requestBody)	Register an integration connector with the integration group that runs it.
VoidResponse	linkReportDependency(String serverName, String urlMarker, String priorReportGUID, String reportGUID, NewRelationshipRequestBody requestBody)	Create a relationship that identifies the prior publishing of a report.
VoidResponse	linkReportOriginator(String serverName, String urlMarker, String originatorGUID, String reportGUID, NewRelationshipRequestBody requestBody)	Create a relationship that identifies the originator of a report.
VoidResponse	linkReportSubject(String serverName, String urlMarker, String subjectGUID, String reportGUID, NewRelationshipRequestBody requestBody)	Create a relationship that identifies the subject of a report.
VoidResponse	linkSampleData(String serverName, String urlMarker, String elementGUID, String sampleDataGUID, NewRelationshipRequestBody requestBody)	Attach an asset holding sample data to the element that the sample was taken from.
VoidResponse	linkSoftwareCapability(String serverName, String urlMarker, String assetGUID, String capabilityGUID, NewRelationshipRequestBody requestBody)	Create a relationship that links a software capability to an infrastructure asset like a software server.
GUIDResponse	linkSupportedGovernanceService(String serverName, String urlMarker, String governanceEngineGUID, String governanceServiceGUID, NewRelationshipRequestBody requestBody)	Create a relationship that registers a governance service with a governance engine.
VoidResponse	reassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, NewRelationshipRequestBody requestBody)	Assign an action to a new actor.
VoidResponse	removeCapabilityAssetUse(String serverName, String urlMarker, String softwareCapabilityGUID, String assetGUID, DeleteRelationshipRequestBody requestBody)	Remove the relationship that represents the use of an asset by a software capability.
VoidResponse	removeCatalogTarget(String serverName, String urlMarker, String integrationConnectorGUID, String metadataElementGUID, DeleteRelationshipRequestBody requestBody)	Unregister a catalog target from the integration connector.
VoidResponse	removeCatalogTarget(String serverName, String urlMarker, String relationshipGUID, DeleteRelationshipRequestBody requestBody)	Unregister a catalog target from the integration connector.
VoidResponse	setAPIAsListenerInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)	Classify a deployed API to say that it provides a listener interface.
VoidResponse	setAPIAsPublisherInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)	Classify a deployed API to say that it provides a publisher interface.
VoidResponse	setAPIAsRequestResponseInterface(String serverName, String urlMarker, String deployedAPIGUID, NewClassificationRequestBody requestBody)	Classify a deployed API to say that it provides a request-response interface.
VoidResponse	setAssetAsAuditLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds an audit log.
VoidResponse	setAssetAsExceptionBacklog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds a backlog of exceptions that need to be resolved.
VoidResponse	setAssetAsLineageLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds a lineage log.
VoidResponse	setAssetAsLogAnalysis(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds the results of analysing a log.
VoidResponse	setAssetAsMeteringLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds a metering log.
VoidResponse	setAssetAsSecurityLog(String serverName, String urlMarker, String assetGUID, NewClassificationRequestBody requestBody)	Classify an asset to say that it holds a security log.
VoidResponse	setDataAssetEncoding(String serverName, String urlMarker, String dataAssetGUID, NewClassificationRequestBody requestBody)	Classify a data asset to describe how its data is encoded.
VoidResponse	unassignAction(String serverName, String urlMarker, String actionGUID, String actorGUID, DeleteRelationshipRequestBody requestBody)	Remove an action from an actor.
VoidResponse	unDeployITAsset(String serverName, String urlMarker, String assetGUID, String destinationGUID, DeleteRelationshipRequestBody requestBody)	Remove a DeployedOn relationship.
VoidResponse	unlinkReportDependency(String serverName, String urlMarker, String priorReportGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)	Remove a ReportDependency relationship.
VoidResponse	unlinkReportOriginator(String serverName, String urlMarker, String originatorGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)	Remove a ReportOriginator relationship.
VoidResponse	unlinkReportSubject(String serverName, String urlMarker, String subjectGUID, String reportGUID, DeleteRelationshipRequestBody requestBody)	Remove a ReportSubject relationship.
VoidResponse	updateActionTargetProperties(String serverName, String urlMarker, String actionTargetGUID, UpdateRelationshipRequestBody requestBody)	Update the properties associated with an Action Target for an action.
BooleanResponse	updateAsset(String serverName, String urlMarker, String assetGUID, UpdateElementRequestBody requestBody)	Update the properties of an asset.
VoidResponse	updateCatalogTarget(String serverName, String urlMarker, String relationshipGUID, UpdateRelationshipRequestBody requestBody)	Update a catalog target for an integration connector.
BooleanResponse	updateSoftwareCapability(String serverName, String urlMarker, String softwareCapabilityGUID, UpdateElementRequestBody requestBody)	Update the properties of a software capability.
VoidResponse	updateSupportedGovernanceService(String serverName, String urlMarker, String supportedGovernanceServiceGUID, UpdateRelationshipRequestBody requestBody)	Update the properties of a SupportedGovernanceService relationship.

Methods inherited from class java.lang.Object

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

Constructor Details

AssetMakerResource

public AssetMakerResource()

Default constructor

Method Details

createAsset

@PostMapping(path="/assets")
public GUIDResponse createAsset(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 NewElementRequestBody requestBody)

Create an asset.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

requestBody - properties for the asset.

Returns:

unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

createAssetFromTemplate

@PostMapping(path="/assets/from-template")
public GUIDResponse createAssetFromTemplate(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 TemplateRequestBody requestBody)

Create a new metadata element to represent an asset using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

Parameters:

serverName - calling user

urlMarker - view service URL marker

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

updateAsset

@PostMapping(path="/assets/{assetGUID}/update")
public BooleanResponse updateAsset(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of an asset.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

assetGUID - unique identifier of the asset (returned from create)

requestBody - properties for the new element.

Returns:

void or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

deleteAsset

@PostMapping(path="/assets/{assetGUID}/delete")
public VoidResponse deleteAsset(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteElementRequestBody requestBody)

Delete an asset.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

assetGUID - unique identifier of the element to delete

requestBody - description of the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getAssetsByName

@PostMapping(path="/assets/by-name")
public OpenMetadataRootElementsResponse getAssetsByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Returns the list of assets with a particular name.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

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 a problem reported in the open metadata server(s)

findAssets

@PostMapping(path="/assets/by-search-string")
public OpenMetadataRootElementsResponse findAssets(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Retrieve the list of asset metadata elements that contain the search string.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

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 a problem reported in the open metadata server(s)

getAssetByGUID

@PostMapping(path="/assets/{assetGUID}/retrieve")
public OpenMetadataRootElementResponse getAssetByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Return the properties of a specific asset.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the required element

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findProcesses

@PostMapping(path="/processes/find-by-search-string")
public OpenMetadataRootElementsResponse findProcesses(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ActivityStatusSearchString requestBody)

Retrieve the processes that match the search string and activity status.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

getProcessesByCategory

@PostMapping(path="/processes/by-category")
public OpenMetadataRootElementsResponse getProcessesByCategory(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ActivityStatusFilterRequestBody requestBody)

Retrieve the actions that match the category name and status.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

findInfrastructure

@PostMapping(path="/infrastructure-assets/by-search-string")
public OpenMetadataRootElementsResponse findInfrastructure(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 DeploymentStatusSearchString requestBody)

Returns the list of infrastructure assets matching the search string and optional deployment status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of infrastructure assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getInfrastructureByCategory

@PostMapping(path="/infrastructure-assets/by-category")
public OpenMetadataRootElementsResponse getInfrastructureByCategory(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 DeploymentStatusFilterRequestBody requestBody)

Returns the list of infrastructure assets matching the category and optional deployment status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of infrastructure assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

deployITAsset

@PostMapping("/assets/{assetGUID}/deployed-on/{destinationGUID}/attach")
public VoidResponse deployITAsset(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String destinationGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that represents the deployment of an IT infrastructure asset to a specific deployment destination (another asset).

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

destinationGUID - unique identifier of the destination asset

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

unDeployITAsset

@PostMapping("/assets/{assetGUID}/deployed-on/{destinationGUID}/detach")
public VoidResponse unDeployITAsset(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String destinationGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a DeployedOn relationship.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

destinationGUID - unique identifier of the destination asset

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkSoftwareCapability

@PostMapping("/assets/{assetGUID}/supported-software-capabilities/{capabilityGUID}/attach")
public VoidResponse linkSoftwareCapability(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String capabilityGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that links a software capability to an infrastructure asset like a software server.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the data set

capabilityGUID - unique identifier of the data asset supplying the data

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachSoftwareCapability

@PostMapping("/assets/{assetGUID}/supported-software-capabilities/{capabilityGUID}/detach")
public VoidResponse detachSoftwareCapability(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @PathVariable
 String capabilityGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a relationship that links a software capability to an infrastructure asset like a software server.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the data set

capabilityGUID - unique identifier of the data asset supplying the data

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findDataAssets

@PostMapping(path="/data-assets/by-search-string")
public OpenMetadataRootElementsResponse findDataAssets(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ContentStatusSearchString requestBody)

Returns the list of data assets matching the search string and optional content status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of data assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

getDataAssetsByCategory

@PostMapping(path="/data-assets/by-category")
public OpenMetadataRootElementsResponse getDataAssetsByCategory(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ContentStatusFilterRequestBody requestBody)

Returns the list of data assets matching the category and optional content status.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

a list of data assets InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

linkDataSetContent

@PostMapping("/data-sets/{dataSetGUID}/data-set-content/{dataContentAssetGUID}/attach")
public VoidResponse linkDataSetContent(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String dataSetGUID,
 @PathVariable
 String dataContentAssetGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a data set to another asset (typically a data store) that is supplying the data.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

dataSetGUID - unique identifier of the data set

dataContentAssetGUID - unique identifier of the data asset supplying the data

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachDataSetContent

@PostMapping("/data-sets/{dataSetGUID}/data-set-content/{dataContentAssetGUID}/detach")
public VoidResponse detachDataSetContent(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String dataSetGUID,
 @PathVariable
 String dataContentAssetGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a data set from another asset that was supplying the data and is no more.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

dataSetGUID - unique identifier of the data set

dataContentAssetGUID - unique identifier of the data asset supplying the data

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkReportOriginator

@PostMapping("/elements/{originatorGUID}/originated-reports/{reportGUID}/attach")
public VoidResponse linkReportOriginator(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String originatorGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that identifies the originator of a report.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

originatorGUID - unique identifier of the originator

reportGUID - unique identifier of the report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

unlinkReportOriginator

@PostMapping("/elements/{originatorGUID}/originated-reports/{reportGUID}/detach")
public VoidResponse unlinkReportOriginator(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String originatorGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a ReportOriginator relationship.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

originatorGUID - unique identifier of the originator

reportGUID - unique identifier of the report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkReportDependency

@PostMapping("/reports/{priorReportGUID}/follow-on-reports/{reportGUID}/attach")
public VoidResponse linkReportDependency(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String priorReportGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that identifies the prior publishing of a report.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

priorReportGUID - unique identifier of the earlier report

reportGUID - unique identifier of the new report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

unlinkReportDependency

@PostMapping("/reports/{priorReportGUID}/follow-on-reports/{reportGUID}/detach")
public VoidResponse unlinkReportDependency(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String priorReportGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a ReportDependency relationship.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

priorReportGUID - unique identifier of the prior report

reportGUID - unique identifier of the new report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkReportSubject

@PostMapping("/elements/{subjectGUID}/reports/{reportGUID}/attach")
public VoidResponse linkReportSubject(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String subjectGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that identifies the subject of a report.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

subjectGUID - unique identifier of the subject

reportGUID - unique identifier of the report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

unlinkReportSubject

@PostMapping("/elements/{subjectGUID}/reports/{reportGUID}/detach")
public VoidResponse unlinkReportSubject(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String subjectGUID,
 @PathVariable
 String reportGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a ReportSubject relationship.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

subjectGUID - unique identifier of the subject

reportGUID - unique identifier of the report

requestBody - optional effective time

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

createAction

@PostMapping(path="/actions")
public GUIDResponse createAction(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 ActionRequestBody requestBody)

Create a new action and link it to the supplied actor and targets (if applicable).

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

requestBody - properties of the action

Returns:

unique identifier of the action or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

addActionTarget

@PostMapping(path="/actions/{actionGUID}/action-targets/{metadataElementGUID}/attach")
public GUIDResponse addActionTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionGUID,
 @PathVariable
 String metadataElementGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Add an element to an action's workload.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

actionGUID - unique identifier of the integration service.

metadataElementGUID - unique identifier of the metadata element that is a catalog target.

requestBody - properties for the relationship.

Returns:

guid or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

updateActionTargetProperties

@PostMapping(path="/actions/action-targets/{actionTargetGUID}/update")
public VoidResponse updateActionTargetProperties(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionTargetGUID,
 @RequestBody(required=false)
 UpdateRelationshipRequestBody requestBody)

Update the properties associated with an Action Target for an action.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

actionTargetGUID - unique identifier of the action target relationship

requestBody - properties to change

Returns:

void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

getActionTarget

@PostMapping(path="/actions/action-targets/{actionTargetGUID}/retrieve")
public OpenMetadataRelationshipResponse getActionTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionTargetGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Retrieve a specific action target associated with an action.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

actionTargetGUID - unique identifier of the relationship

requestBody - details of how the retrieve should be processed

Returns:

details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

getActionTargets

@PostMapping(path="/actions/{actionGUID}/action-targets")
public OpenMetadataRootElementsResponse getActionTargets(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionGUID,
 @RequestBody(required=false)
 ActivityStatusRequestBody requestBody)

Return a list of elements that are target elements for an action.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

actionGUID - unique identifier of the integration connector.

requestBody - describe how results are to be returned

Returns:

list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

getActionsForActionTarget

@PostMapping(path="/elements/{elementGUID}/action-targets/actions")
public OpenMetadataRootElementsResponse getActionsForActionTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ActivityStatusRequestBody requestBody)

Retrieve the "Actions" that are chained off of an action target element.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

elementGUID - unique identifier of the element to start with

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

assignAction

@PostMapping(path="/actions/{actionGUID}/assign/{actorGUID}")
public VoidResponse assignAction(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Assign an action to an actor.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

actionGUID - unique identifier of the action

actorGUID - actor to assign the action to

requestBody - request body

Returns:

void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

reassignAction

@PostMapping(path="/actions/{actionGUID}/reassign/{actorGUID}")
public VoidResponse reassignAction(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Assign an action to a new actor. This will unassign all other actors previously assigned to the action.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

actionGUID - unique identifier of the action

actorGUID - actor to assign the action to

requestBody - request body

Returns:

void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

unassignAction

@PostMapping(path="/actions/{actionGUID}/unassign/{actorGUID}")
public VoidResponse unassignAction(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actionGUID,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove an action from an actor.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

actionGUID - unique identifier of the action

actorGUID - actor to assign the action to

requestBody - request body

Returns:

void or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

getActionsForSponsor

@PostMapping(path="/elements/{elementGUID}/sponsored/actions")
public OpenMetadataRootElementsResponse getActionsForSponsor(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ActivityStatusRequestBody requestBody)

Retrieve the "Actions" that are chained of a sponsor's element.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

elementGUID - unique identifier of the element to start with

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

getActionsFromRequester

@PostMapping(path="/elements/{elementGUID}/requested/actions")
public OpenMetadataRootElementsResponse getActionsFromRequester(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @RequestBody(required=false)
 ActivityStatusRequestBody requestBody)

Retrieve the "Actions" that are chained off a requester's element.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

elementGUID - unique identifier of the element to start with

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

getAssignedActions

@PostMapping(path="/actors/{actorGUID}/assigned/actions")
public OpenMetadataRootElementsResponse getAssignedActions(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String actorGUID,
 @RequestBody(required=false)
 ActivityStatusRequestBody requestBody)

Retrieve the actions for a particular actor.

Parameters:

serverName - name of the server instances for this request

urlMarker - view service URL marker

actorGUID - unique identifier of the role

requestBody - status of the action (null means current active)

Returns:

list of action beans or InvalidParameterException a parameter is invalid PropertyServerException the server is not available UserNotAuthorizedException the calling user is not authorized to issue the call

addCatalogTarget

@PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}")
public GUIDResponse addCatalogTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationConnectorGUID,
 @PathVariable
 String metadataElementGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Add a catalog target to an integration connector.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

integrationConnectorGUID - unique identifier of the integration service.

metadataElementGUID - unique identifier of the metadata element that is a catalog target.

requestBody - properties for the relationship.

Returns:

guid or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

updateCatalogTarget

@PostMapping(path="/catalog-targets/{relationshipGUID}/update")
public VoidResponse updateCatalogTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipGUID,
 @RequestBody
 UpdateRelationshipRequestBody requestBody)

Update a catalog target for an integration connector.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

relationshipGUID - unique identifier of the integration service.* @param requestBody properties for the relationship.

Returns:

void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the catalog target definition.

getCatalogTarget

@PostMapping(path="/catalog-targets/{relationshipGUID}")
public OpenMetadataRelationshipResponse getCatalogTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Retrieve a specific catalog target associated with an integration connector.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

relationshipGUID - unique identifier of the relationship

requestBody - details of how the retrieve should be processed

Returns:

details of the governance service and the asset types it is registered for or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

getCatalogTargets

@PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets")
public OpenMetadataRootElementsResponse getCatalogTargets(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationConnectorGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the details of the metadata elements identified as catalog targets with an integration connector.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

integrationConnectorGUID - unique identifier of the integration connector.

requestBody - describe how results are to be returned

Returns:

list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

removeCatalogTarget

@PostMapping(path="/catalog-targets/{relationshipGUID}/remove")
public VoidResponse removeCatalogTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String relationshipGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Unregister a catalog target from the integration connector.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

relationshipGUID - unique identifier of the relationship.

requestBody - null request body.

Returns:

void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

removeCatalogTarget

@PostMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets/{metadataElementGUID}/detach")
public VoidResponse removeCatalogTarget(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationConnectorGUID,
 @PathVariable
 String metadataElementGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Unregister a catalog target from the integration connector.

Parameters:

serverName - name of the service to route the request to.

urlMarker - view service URL marker

integrationConnectorGUID - unique identifier of the integration service.

metadataElementGUID - unique identifier of the metadata element that is a catalog target.

requestBody - request body.

Returns:

void or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

createSoftwareCapability

@PostMapping(path="/software-capabilities")
public GUIDResponse createSoftwareCapability(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 NewElementRequestBody requestBody)

Create a software capability.

Parameters:

serverName - name of called server.

urlMarker - view service URL marker

requestBody - properties for the software capability.

Returns:

unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

createSoftwareCapabilityFromTemplate

@PostMapping(path="/software-capabilities/from-template")
public GUIDResponse createSoftwareCapabilityFromTemplate(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 TemplateRequestBody requestBody)

Create a new metadata element to represent a software capability using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.

Parameters:

serverName - calling user

urlMarker - view service URL marker

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

updateSoftwareCapability

@PostMapping(path="/software-capabilities/{softwareCapabilityGUID}/update")
public BooleanResponse updateSoftwareCapability(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String softwareCapabilityGUID,
 @RequestBody(required=false)
 UpdateElementRequestBody requestBody)

Update the properties of a software capability.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

softwareCapabilityGUID - unique identifier of the software capability

requestBody - properties for the updated element

Returns:

boolean response InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getSoftwareCapabilityByGUID

@PostMapping(path="/software-capabilities/{softwareCapabilityGUID}")
public OpenMetadataRootElementResponse getSoftwareCapabilityByGUID(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String softwareCapabilityGUID,
 @RequestBody(required=false)
 GetRequestBody requestBody)

Retrieve a specific software capability.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

softwareCapabilityGUID - unique identifier of the required element

requestBody - options to control the query

Returns:

retrieved software capability InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

findSoftwareCapabilities

@PostMapping(path="/software-capabilities/search")
public OpenMetadataRootElementsResponse findSoftwareCapabilities(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Retrieve the list of software capability metadata elements that contain the search string.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getSoftwareCapabilitiesByName

@PostMapping(path="/software-capabilities/by-name")
public OpenMetadataRootElementsResponse getSoftwareCapabilitiesByName(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Retrieve the list of software capabilities with a particular name.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getSoftwareCapabilitiesByDeployedImplementationType

@PostMapping(path="/software-capabilities/by-deployed-implementation-type")
public OpenMetadataRootElementsResponse getSoftwareCapabilitiesByDeployedImplementationType(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @RequestBody(required=false)
 FilterRequestBody requestBody)

Retrieve the list of software capabilities with a particular deployed implementation type.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

requestBody - string to find in the properties

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getSoftwareCapabilitiesForInfrastructure

@PostMapping(path="/infrastructure/{infrastructureGUID}/software-capabilities")
public OpenMetadataRootElementsResponse getSoftwareCapabilitiesForInfrastructure(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String infrastructureGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the list of software capabilities attached to a specific infrastructure element.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

infrastructureGUID - unique identifier of the infrastructure element

requestBody - options to control the query

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

addCapabilityAssetUse

@PostMapping(path="/software-capabilities/{softwareCapabilityGUID}/assets/{assetGUID}/attach")
public VoidResponse addCapabilityAssetUse(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String softwareCapabilityGUID,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that represents the use of an asset by a software capability.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

softwareCapabilityGUID - unique identifier of the software capability

assetGUID - unique identifier of the asset

requestBody - optional effective time and relationship properties

Returns:

void response InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

removeCapabilityAssetUse

@PostMapping(path="/software-capabilities/{softwareCapabilityGUID}/assets/{assetGUID}/detach")
public VoidResponse removeCapabilityAssetUse(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String softwareCapabilityGUID,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove the relationship that represents the use of an asset by a software capability.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

softwareCapabilityGUID - unique identifier of the software capability

assetGUID - unique identifier of the asset

requestBody - optional effective time

Returns:

void response InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getCapabilityUse

@PostMapping(path="/assets/{assetGUID}/capability-use")
public OpenMetadataRootElementsResponse getCapabilityUse(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the software capabilities using a particular asset.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - options to control the query

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkSupportedGovernanceService

@PostMapping(path="/governance-engines/{governanceEngineGUID}/supported-governance-services/{governanceServiceGUID}/attach")
public GUIDResponse linkSupportedGovernanceService(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceEngineGUID,
 @PathVariable
 String governanceServiceGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Create a relationship that registers a governance service with a governance engine. This is a multi-link relationship so the unique identifier of the new relationship is returned.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

governanceEngineGUID - unique identifier of the governance engine

governanceServiceGUID - unique identifier of the governance service

requestBody - properties for the relationship

Returns:

unique identifier of the new relationship or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

updateSupportedGovernanceService

@PostMapping(path="/supported-governance-services/{supportedGovernanceServiceGUID}/update")
public VoidResponse updateSupportedGovernanceService(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String supportedGovernanceServiceGUID,
 @RequestBody
 UpdateRelationshipRequestBody requestBody)

Update the properties of a SupportedGovernanceService relationship.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

supportedGovernanceServiceGUID - unique identifier of the relationship

requestBody - new properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachSupportedGovernanceService

@PostMapping(path="/supported-governance-services/{supportedGovernanceServiceGUID}/detach")
public VoidResponse detachSupportedGovernanceService(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String supportedGovernanceServiceGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove a SupportedGovernanceService relationship.

Parameters:

serverName - name of the service to route the request to

urlMarker - view service URL marker

supportedGovernanceServiceGUID - unique identifier of the relationship

requestBody - external source information

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getGovernanceEngines

@PostMapping(path="/governance-services/{governanceServiceGUID}/governance-engines")
public OpenMetadataRootElementsResponse getGovernanceEngines(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String governanceServiceGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the governance engines connected to a particular governance service.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

governanceServiceGUID - unique identifier of the governance service

requestBody - options to control the query

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

getIntegrationGroups

@PostMapping(path="/integration-connectors/{integrationConnectorGUID}/integration-groups")
public OpenMetadataRootElementsResponse getIntegrationGroups(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationConnectorGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

Retrieve the integration groups connected to a particular integration connector.

Parameters:

serverName - name of called server

urlMarker - view service URL marker

integrationConnectorGUID - unique identifier of the integration connector

requestBody - options to control the query

Returns:

list of matching metadata elements InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkAPIEndpoint

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/api-endpoints/{endpointGUID}/attach")
public VoidResponse linkAPIEndpoint(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @PathVariable
 String endpointGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a deployed API to the endpoint where it is called.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

endpointGUID - unique identifier of the endpoint

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachAPIEndpoint

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/api-endpoints/{endpointGUID}/detach")
public VoidResponse detachAPIEndpoint(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @PathVariable
 String endpointGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a deployed API from the endpoint where it is called.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

endpointGUID - unique identifier of the endpoint

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkProcessHierarchy

@PostMapping(path="/processes/{parentProcessGUID}/process-hierarchies/{childProcessGUID}/attach")
public VoidResponse linkProcessHierarchy(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String parentProcessGUID,
 @PathVariable
 String childProcessGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a child process to its parent process.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

parentProcessGUID - unique identifier of the parent process

childProcessGUID - unique identifier of the child process

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachProcessHierarchy

@PostMapping(path="/processes/{parentProcessGUID}/process-hierarchies/{childProcessGUID}/detach")
public VoidResponse detachProcessHierarchy(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String parentProcessGUID,
 @PathVariable
 String childProcessGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a child process from its parent process.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

parentProcessGUID - unique identifier of the parent process

childProcessGUID - unique identifier of the child process

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkNestedFiles

@PostMapping(path="/file-folders/{folderGUID}/nested-files/{fileGUID}/attach")
public VoidResponse linkNestedFiles(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String folderGUID,
 @PathVariable
 String fileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a data file to the file folder that it is stored in.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

folderGUID - unique identifier of the file folder

fileGUID - unique identifier of the data file that is stored in the folder

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachNestedFile

@PostMapping(path="/file-folders/{folderGUID}/nested-files/{fileGUID}/detach")
public VoidResponse detachNestedFile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String folderGUID,
 @PathVariable
 String fileGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a data file from the file folder that it is stored in.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

folderGUID - unique identifier of the file folder

fileGUID - unique identifier of the data file that is stored in the folder

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkLinkedFiles

@PostMapping(path="/file-folders/{folderGUID}/linked-files/{fileGUID}/attach")
public VoidResponse linkLinkedFiles(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String folderGUID,
 @PathVariable
 String fileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a data file to a file folder that links to it without storing it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

folderGUID - unique identifier of the file folder

fileGUID - unique identifier of the data file that is linked to the folder

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachLinkedFile

@PostMapping(path="/file-folders/{folderGUID}/linked-files/{fileGUID}/detach")
public VoidResponse detachLinkedFile(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String folderGUID,
 @PathVariable
 String fileGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a data file from a file folder that links to it without storing it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

folderGUID - unique identifier of the file folder

fileGUID - unique identifier of the data file that is linked to the folder

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkFolderHierarchy

@PostMapping(path="/file-folders/{parentFolderGUID}/folder-hierarchies/{childFolderGUID}/attach")
public VoidResponse linkFolderHierarchy(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String parentFolderGUID,
 @PathVariable
 String childFolderGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a child file folder to its parent file folder.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

parentFolderGUID - unique identifier of the parent file folder

childFolderGUID - unique identifier of the child file folder

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachFolderHierarchy

@PostMapping(path="/file-folders/{parentFolderGUID}/folder-hierarchies/{childFolderGUID}/detach")
public VoidResponse detachFolderHierarchy(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String parentFolderGUID,
 @PathVariable
 String childFolderGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a child file folder from its parent file folder.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

parentFolderGUID - unique identifier of the parent file folder

childFolderGUID - unique identifier of the child file folder

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkImpactedResource

@PostMapping(path="/resources/{resourceGUID}/impacted-resources/{incidentReportGUID}/attach")
public VoidResponse linkImpactedResource(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String resourceGUID,
 @PathVariable
 String incidentReportGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a resource that is impacted by an incident report to that incident report.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

resourceGUID - unique identifier of the impacted resource

incidentReportGUID - unique identifier of the incident report

requestBody - properties for the relationship

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachImpactedResource

@PostMapping(path="/resources/{resourceGUID}/impacted-resources/{incidentReportGUID}/detach")
public VoidResponse detachImpactedResource(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String resourceGUID,
 @PathVariable
 String incidentReportGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a resource from an incident report that no longer impacts it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

resourceGUID - unique identifier of the impacted resource

incidentReportGUID - unique identifier of the incident report

requestBody - delete options

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkAssociatedLog

@PostMapping(path="/elements/{elementGUID}/associated-logs/{logAssetGUID}/attach")
public VoidResponse linkAssociatedLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String logAssetGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an asset that holds a log to the element that the log is about.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the log is about

logAssetGUID - unique identifier of the asset that holds the log

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachAssociatedLog

@PostMapping(path="/elements/{elementGUID}/associated-logs/{logAssetGUID}/detach")
public VoidResponse detachAssociatedLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String logAssetGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach an asset that holds a log from the element that the log was about.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the log is about

logAssetGUID - unique identifier of the asset that holds the log

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkSampleData

@PostMapping(path="/elements/{elementGUID}/sample-data/{sampleDataGUID}/attach")
public VoidResponse linkSampleData(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String sampleDataGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an asset holding sample data to the element that the sample was taken from.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the sample was taken from

sampleDataGUID - unique identifier of the asset holding the sample data

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachSampleData

@PostMapping(path="/elements/{elementGUID}/sample-data/{sampleDataGUID}/detach")
public VoidResponse detachSampleData(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String elementGUID,
 @PathVariable
 String sampleDataGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach an asset holding sample data from the element that the sample was taken from.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

elementGUID - unique identifier of the element that the sample was taken from

sampleDataGUID - unique identifier of the asset holding the sample data

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkProcessPort

@PostMapping(path="/processes/{processGUID}/ports/{portGUID}/attach")
public VoidResponse linkProcessPort(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String processGUID,
 @PathVariable
 String portGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a port to the process that owns it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

processGUID - unique identifier of the process that owns the port

portGUID - unique identifier of the port

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachProcessPort

@PostMapping(path="/processes/{processGUID}/ports/{portGUID}/detach")
public VoidResponse detachProcessPort(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String processGUID,
 @PathVariable
 String portGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a port from the process that owned it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

processGUID - unique identifier of the process that owns the port

portGUID - unique identifier of the port

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkArchiveContents

@PostMapping(path="/archive-files/{archiveFileGUID}/archive-contents/{collectionGUID}/attach")
public VoidResponse linkArchiveContents(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String archiveFileGUID,
 @PathVariable
 String collectionGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach an archive file to the collection that describes its contents.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

archiveFileGUID - unique identifier of the archive file

collectionGUID - unique identifier of the collection describing the archive's contents

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachArchiveContents

@PostMapping(path="/archive-files/{archiveFileGUID}/archive-contents/{collectionGUID}/detach")
public VoidResponse detachArchiveContents(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String archiveFileGUID,
 @PathVariable
 String collectionGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach an archive file from the collection that described its contents.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

archiveFileGUID - unique identifier of the archive file

collectionGUID - unique identifier of the collection describing the archive's contents

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkLinkedMedia

@PostMapping(path="/media-files/{mediaFileGUID}/linked-media/{linkedMediaFileGUID}/attach")
public VoidResponse linkLinkedMedia(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String mediaFileGUID,
 @PathVariable
 String linkedMediaFileGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a media file to another media file that is related to it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

mediaFileGUID - unique identifier of the media file

linkedMediaFileGUID - unique identifier of the related media file

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachLinkedMedia

@PostMapping(path="/media-files/{mediaFileGUID}/linked-media/{linkedMediaFileGUID}/detach")
public VoidResponse detachLinkedMedia(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String mediaFileGUID,
 @PathVariable
 String linkedMediaFileGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a media file from another media file that was related to it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

mediaFileGUID - unique identifier of the media file

linkedMediaFileGUID - unique identifier of the related media file

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsAuditLog

@PostMapping(path="/assets/{assetGUID}/audit-log")
public VoidResponse setAssetAsAuditLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds an audit log.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsAuditLog

@PostMapping(path="/assets/{assetGUID}/audit-log/remove")
public VoidResponse clearAssetAsAuditLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the audit log designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsLineageLog

@PostMapping(path="/assets/{assetGUID}/lineage-log")
public VoidResponse setAssetAsLineageLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds a lineage log.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsLineageLog

@PostMapping(path="/assets/{assetGUID}/lineage-log/remove")
public VoidResponse clearAssetAsLineageLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the lineage log designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsMeteringLog

@PostMapping(path="/assets/{assetGUID}/metering-log")
public VoidResponse setAssetAsMeteringLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds a metering log.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsMeteringLog

@PostMapping(path="/assets/{assetGUID}/metering-log/remove")
public VoidResponse clearAssetAsMeteringLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the metering log designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsSecurityLog

@PostMapping(path="/assets/{assetGUID}/security-log")
public VoidResponse setAssetAsSecurityLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds a security log.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsSecurityLog

@PostMapping(path="/assets/{assetGUID}/security-log/remove")
public VoidResponse clearAssetAsSecurityLog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the security log designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsExceptionBacklog

@PostMapping(path="/assets/{assetGUID}/exception-backlog")
public VoidResponse setAssetAsExceptionBacklog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds a backlog of exceptions that need to be resolved.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsExceptionBacklog

@PostMapping(path="/assets/{assetGUID}/exception-backlog/remove")
public VoidResponse clearAssetAsExceptionBacklog(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the exception backlog designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAssetAsLogAnalysis

@PostMapping(path="/assets/{assetGUID}/log-analysis")
public VoidResponse setAssetAsLogAnalysis(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify an asset to say that it holds the results of analysing a log.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAssetAsLogAnalysis

@PostMapping(path="/assets/{assetGUID}/log-analysis/remove")
public VoidResponse clearAssetAsLogAnalysis(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the log analysis designation from an asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

assetGUID - unique identifier of the asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAPIAsListenerInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/listener-interface")
public VoidResponse setAPIAsListenerInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify a deployed API to say that it provides a listener interface.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAPIAsListenerInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/listener-interface/remove")
public VoidResponse clearAPIAsListenerInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the listener interface designation from a deployed API.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAPIAsPublisherInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/publisher-interface")
public VoidResponse setAPIAsPublisherInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify a deployed API to say that it provides a publisher interface.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAPIAsPublisherInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/publisher-interface/remove")
public VoidResponse clearAPIAsPublisherInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the publisher interface designation from a deployed API.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setAPIAsRequestResponseInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/request-response-interface")
public VoidResponse setAPIAsRequestResponseInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify a deployed API to say that it provides a request-response interface.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearAPIAsRequestResponseInterface

@PostMapping(path="/deployed-apis/{deployedAPIGUID}/request-response-interface/remove")
public VoidResponse clearAPIAsRequestResponseInterface(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String deployedAPIGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the request-response interface designation from a deployed API.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

deployedAPIGUID - unique identifier of the deployed API

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

setDataAssetEncoding

@PostMapping(path="/data-assets/{dataAssetGUID}/encoding")
public VoidResponse setDataAssetEncoding(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String dataAssetGUID,
 @RequestBody(required=false)
 NewClassificationRequestBody requestBody)

Classify a data asset to describe how its data is encoded.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

dataAssetGUID - unique identifier of the data asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

clearDataAssetEncoding

@PostMapping(path="/data-assets/{dataAssetGUID}/encoding/remove")
public VoidResponse clearDataAssetEncoding(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String dataAssetGUID,
 @RequestBody(required=false)
 DeleteClassificationRequestBody requestBody)

Remove the encoding description from a data asset.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

dataAssetGUID - unique identifier of the data asset

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkPortDelegation

@PostMapping(path="/ports/{delegatingFromPortGUID}/port-delegations/{delegatingToPortGUID}/attach")
public VoidResponse linkPortDelegation(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String delegatingFromPortGUID,
 @PathVariable
 String delegatingToPortGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Attach a port to the port that it delegates to.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

delegatingFromPortGUID - unique identifier of the port that delegates

delegatingToPortGUID - unique identifier of the port that is delegated to

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachPortDelegation

@PostMapping(path="/ports/{delegatingFromPortGUID}/port-delegations/{delegatingToPortGUID}/detach")
public VoidResponse detachPortDelegation(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String delegatingFromPortGUID,
 @PathVariable
 String delegatingToPortGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Detach a port from the port that it delegated to.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

delegatingFromPortGUID - unique identifier of the port that delegates

delegatingToPortGUID - unique identifier of the port that is delegated to

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

linkRegisteredIntegrationConnector

@PostMapping(path="/integration-groups/{integrationGroupGUID}/registered-integration-connectors/{integrationConnectorGUID}/attach")
public VoidResponse linkRegisteredIntegrationConnector(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationGroupGUID,
 @PathVariable
 String integrationConnectorGUID,
 @RequestBody(required=false)
 NewRelationshipRequestBody requestBody)

Register an integration connector with the integration group that runs it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

integrationGroupGUID - unique identifier of the integration group

integrationConnectorGUID - unique identifier of the integration connector

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

detachRegisteredIntegrationConnector

@PostMapping(path="/integration-groups/{integrationGroupGUID}/registered-integration-connectors/{integrationConnectorGUID}/detach")
public VoidResponse detachRegisteredIntegrationConnector(@PathVariable
 String serverName,
 @PathVariable
 String urlMarker,
 @PathVariable
 String integrationGroupGUID,
 @PathVariable
 String integrationConnectorGUID,
 @RequestBody(required=false)
 DeleteRelationshipRequestBody requestBody)

Remove an integration connector from the integration group that ran it.

Parameters:

serverName - name of the server to route the request to

urlMarker - view service URL marker

integrationGroupGUID - unique identifier of the integration group

integrationConnectorGUID - unique identifier of the integration connector

requestBody - properties for the request

Returns:

response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)