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

Class DevopsPipelineResource

java.lang.Object
org.odpi.openmetadata.viewservices.devopspipeline.server.spring.DevopsPipelineResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/devops-pipeline") public class DevopsPipelineResource extends Object
The DevopsPipelineResource provides part of the server-side implementation of the Devops Pipeline OMVS. =

  • Constructor Details

    • DevopsPipelineResource

      public DevopsPipelineResource()
      Default constructor

  • Method Details

    • createStorageVolume

      @PostMapping(path="/storage-volumes") public GUIDResponse createStorageVolume(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a storage volume.
      Parameters:
      serverName - name of the server to route the request 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)

    • createStorageVolumeFromTemplate

      @PostMapping(path="/storage-volumes/from-template") public GUIDResponse createStorageVolumeFromTemplate(@PathVariable String serverName, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a storage volume 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 - name of the server to route the request 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)

    • updateStorageVolume

      @PostMapping(path="/storage-volumes/{storageVolumeGUID}/update") public BooleanResponse updateStorageVolume(@PathVariable String serverName, @PathVariable String storageVolumeGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • deleteStorageVolume

      @PostMapping(path="/storage-volumes/{storageVolumeGUID}/delete") public VoidResponse deleteStorageVolume(@PathVariable String serverName, @PathVariable String storageVolumeGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • getStorageVolumesByName

      @PostMapping(path="/storage-volumes/by-name") public OpenMetadataRootElementsResponse getStorageVolumesByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of storage volumes with a particular name.
      Parameters:
      serverName - name of the server to route the request 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)

    • findStorageVolumes

      @PostMapping(path="/storage-volumes/by-search-string") public OpenMetadataRootElementsResponse findStorageVolumes(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of storage volume metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request 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)

    • getStorageVolumeByGUID

      @PostMapping(path="/storage-volumes/{storageVolumeGUID}/retrieve") public OpenMetadataRootElementResponse getStorageVolumeByGUID(@PathVariable String serverName, @PathVariable String storageVolumeGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific storage volume.
      Parameters:
      serverName - name of the server to route the request to
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • linkAttachedStorage

      @PostMapping(path="/it-infrastructure/{itInfrastructureGUID}/attached-storage/{storageVolumeGUID}/attach") public VoidResponse linkAttachedStorage(@PathVariable String serverName, @PathVariable String itInfrastructureGUID, @PathVariable String storageVolumeGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a storage volume to the IT infrastructure that it provides storage for.
      Parameters:
      serverName - name of the server to route the request to
      itInfrastructureGUID - unique identifier of the element that the storage volume is attached to
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • detachAttachedStorage

      @PostMapping(path="/it-infrastructure/{itInfrastructureGUID}/attached-storage/{storageVolumeGUID}/detach") public VoidResponse detachAttachedStorage(@PathVariable String serverName, @PathVariable String itInfrastructureGUID, @PathVariable String storageVolumeGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a storage volume from the IT infrastructure that it provided storage for.
      Parameters:
      serverName - name of the server to route the request to
      itInfrastructureGUID - unique identifier of the element that the storage volume is attached to
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • linkStoredOn

      @PostMapping(path="/data-stores/{dataStoreGUID}/stored-on/{storageVolumeGUID}/attach") public VoidResponse linkStoredOn(@PathVariable String serverName, @PathVariable String dataStoreGUID, @PathVariable String storageVolumeGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a data store to the storage volume that its data is stored on.
      Parameters:
      serverName - name of the server to route the request to
      dataStoreGUID - unique identifier of the data store
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • detachStoredOn

      @PostMapping(path="/data-stores/{dataStoreGUID}/stored-on/{storageVolumeGUID}/detach") public VoidResponse detachStoredOn(@PathVariable String serverName, @PathVariable String dataStoreGUID, @PathVariable String storageVolumeGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a data store from the storage volume that its data was stored on.
      Parameters:
      serverName - name of the server to route the request to
      dataStoreGUID - unique identifier of the data store
      storageVolumeGUID - unique identifier of the storage volume
      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)

    • createNetwork

      @PostMapping(path="/networks") public GUIDResponse createNetwork(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a network.
      Parameters:
      serverName - name of the server to route the request 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)

    • createNetworkFromTemplate

      @PostMapping(path="/networks/from-template") public GUIDResponse createNetworkFromTemplate(@PathVariable String serverName, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a network using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request 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)

    • updateNetwork

      @PostMapping(path="/networks/{networkGUID}/update") public BooleanResponse updateNetwork(@PathVariable String serverName, @PathVariable String networkGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier
      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)

    • deleteNetwork

      @PostMapping(path="/networks/{networkGUID}/delete") public VoidResponse deleteNetwork(@PathVariable String serverName, @PathVariable String networkGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier
      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)

    • getNetworksByName

      @PostMapping(path="/networks/by-name") public OpenMetadataRootElementsResponse getNetworksByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of networks with a particular name.
      Parameters:
      serverName - name of the server to route the request 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)

    • findNetworks

      @PostMapping(path="/networks/by-search-string") public OpenMetadataRootElementsResponse findNetworks(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of network metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request 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)

    • getNetworkByGUID

      @PostMapping(path="/networks/{networkGUID}/retrieve") public OpenMetadataRootElementResponse getNetworkByGUID(@PathVariable String serverName, @PathVariable String networkGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific network.
      Parameters:
      serverName - name of the server to route the request to
      networkGUID - unique identifier
      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)

    • createNetworkGateway

      @PostMapping(path="/network-gateways") public GUIDResponse createNetworkGateway(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create a network gateway.
      Parameters:
      serverName - name of the server to route the request 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)

    • createNetworkGatewayFromTemplate

      @PostMapping(path="/network-gateways/from-template") public GUIDResponse createNetworkGatewayFromTemplate(@PathVariable String serverName, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent a network gateway using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request 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)

    • updateNetworkGateway

      @PostMapping(path="/network-gateways/{networkGatewayGUID}/update") public BooleanResponse updateNetworkGateway(@PathVariable String serverName, @PathVariable String networkGatewayGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of a network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier
      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)

    • deleteNetworkGateway

      @PostMapping(path="/network-gateways/{networkGatewayGUID}/delete") public VoidResponse deleteNetworkGateway(@PathVariable String serverName, @PathVariable String networkGatewayGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete a network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier
      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)

    • getNetworkGatewaysByName

      @PostMapping(path="/network-gateways/by-name") public OpenMetadataRootElementsResponse getNetworkGatewaysByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of network gateways with a particular name.
      Parameters:
      serverName - name of the server to route the request 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)

    • findNetworkGateways

      @PostMapping(path="/network-gateways/by-search-string") public OpenMetadataRootElementsResponse findNetworkGateways(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of network gateway metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request 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)

    • getNetworkGatewayByGUID

      @PostMapping(path="/network-gateways/{networkGatewayGUID}/retrieve") public OpenMetadataRootElementResponse getNetworkGatewayByGUID(@PathVariable String serverName, @PathVariable String networkGatewayGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific network gateway.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier
      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)

    • linkVisibleEndpoint

      @PostMapping(path="/endpoints/{endpointGUID}/visible-endpoints/{networkGUID}/attach") public VoidResponse linkVisibleEndpoint(@PathVariable String serverName, @PathVariable String endpointGUID, @PathVariable String networkGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an endpoint to the network that it is visible in.
      Parameters:
      serverName - name of the server to route the request to
      endpointGUID - unique identifier
      networkGUID - unique identifier
      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)

    • detachVisibleEndpoint

      @PostMapping(path="/endpoints/{endpointGUID}/visible-endpoints/{networkGUID}/detach") public VoidResponse detachVisibleEndpoint(@PathVariable String serverName, @PathVariable String endpointGUID, @PathVariable String networkGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an endpoint from the network that it was visible in.
      Parameters:
      serverName - name of the server to route the request to
      endpointGUID - unique identifier
      networkGUID - unique identifier
      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)

    • linkNetworkGateway

      @PostMapping(path="/network-gateways/{networkGatewayGUID}/network-gateway-links/{networkGUID}/attach") public GUIDResponse linkNetworkGateway(@PathVariable String serverName, @PathVariable String networkGatewayGUID, @PathVariable String networkGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a network gateway to a network that it connects to. This multi-link relationship always creates a new relationship and returns its unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayGUID - unique identifier
      networkGUID - unique identifier
      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)

    • updateNetworkGatewayLink

      @PostMapping(path="/network-gateway-links/{networkGatewayLinkGUID}/update") public VoidResponse updateNetworkGatewayLink(@PathVariable String serverName, @PathVariable String networkGatewayLinkGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody)
      Update the properties of a network gateway link.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayLinkGUID - unique identifier
      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)

    • detachNetworkGateway

      @PostMapping(path="/network-gateway-links/{networkGatewayLinkGUID}/detach") public VoidResponse detachNetworkGateway(@PathVariable String serverName, @PathVariable String networkGatewayLinkGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a network gateway from a network that it connected to.
      Parameters:
      serverName - name of the server to route the request to
      networkGatewayLinkGUID - unique identifier
      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)

    • linkHostClusterMember

      @PostMapping(path="/host-clusters/{hostClusterGUID}/host-cluster-members/{hostGUID}/attach") public VoidResponse linkHostClusterMember(@PathVariable String serverName, @PathVariable String hostClusterGUID, @PathVariable String hostGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a host to the host cluster that manages it.
      Parameters:
      serverName - name of the server to route the request to
      hostClusterGUID - unique identifier of the host cluster
      hostGUID - unique identifier of the host that is managed by the cluster
      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)

    • detachHostClusterMember

      @PostMapping(path="/host-clusters/{hostClusterGUID}/host-cluster-members/{hostGUID}/detach") public VoidResponse detachHostClusterMember(@PathVariable String serverName, @PathVariable String hostClusterGUID, @PathVariable String hostGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a host from the host cluster that managed it.
      Parameters:
      serverName - name of the server to route the request to
      hostClusterGUID - unique identifier of the host cluster
      hostGUID - unique identifier of the host that was managed by the cluster
      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)

    • createOperatingPlatform

      @PostMapping(path="/operating-platforms") public GUIDResponse createOperatingPlatform(@PathVariable String serverName, @RequestBody(required=false) NewElementRequestBody requestBody)
      Create an operating platform.
      Parameters:
      serverName - name of the server to route the request 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)

    • createOperatingPlatformFromTemplate

      @PostMapping(path="/operating-platforms/from-template") public GUIDResponse createOperatingPlatformFromTemplate(@PathVariable String serverName, @RequestBody(required=false) TemplateRequestBody requestBody)
      Create a new metadata element to represent an operating platform using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request 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)

    • updateOperatingPlatform

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/update") public BooleanResponse updateOperatingPlatform(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody)
      Update the properties of an operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      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)

    • deleteOperatingPlatform

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/delete") public VoidResponse deleteOperatingPlatform(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @RequestBody(required=false) DeleteElementRequestBody requestBody)
      Delete an operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      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)

    • getOperatingPlatformsByName

      @PostMapping(path="/operating-platforms/by-name") public OpenMetadataRootElementsResponse getOperatingPlatformsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Returns the list of operating platforms with a particular name.
      Parameters:
      serverName - name of the server to route the request 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)

    • findOperatingPlatforms

      @PostMapping(path="/operating-platforms/by-search-string") public OpenMetadataRootElementsResponse findOperatingPlatforms(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of operating platform metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request 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)

    • getOperatingPlatformByGUID

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/retrieve") public OpenMetadataRootElementResponse getOperatingPlatformByGUID(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Return the properties of a specific operating platform.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      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)

    • linkOperatingPlatformUse

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/operating-platform-use/{itInfrastructureGUID}/attach") public VoidResponse linkOperatingPlatformUse(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @PathVariable String itInfrastructureGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an operating platform to the IT infrastructure that it is installed on.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      itInfrastructureGUID - unique identifier
      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)

    • detachOperatingPlatformUse

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/operating-platform-use/{itInfrastructureGUID}/detach") public VoidResponse detachOperatingPlatformUse(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @PathVariable String itInfrastructureGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an operating platform from the IT infrastructure that it was installed on.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      itInfrastructureGUID - unique identifier
      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)

    • linkOperatingPlatformManifest

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/operating-platform-manifests/{collectionGUID}/attach") public VoidResponse linkOperatingPlatformManifest(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @PathVariable String collectionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an operating platform to the collection of software packages that it is packaged with.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      collectionGUID - unique identifier
      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)

    • detachOperatingPlatformManifest

      @PostMapping(path="/operating-platforms/{operatingPlatformGUID}/operating-platform-manifests/{collectionGUID}/detach") public VoidResponse detachOperatingPlatformManifest(@PathVariable String serverName, @PathVariable String operatingPlatformGUID, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an operating platform from a collection of software packages that it was packaged with.
      Parameters:
      serverName - name of the server to route the request to
      operatingPlatformGUID - unique identifier
      collectionGUID - unique identifier
      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)

    • linkSoftwarePackageDependency

      @PostMapping(path="/assets/{assetGUID}/software-package-dependencies/{collectionGUID}/attach") public VoidResponse linkSoftwarePackageDependency(@PathVariable String serverName, @PathVariable String assetGUID, @PathVariable String collectionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an asset to the collection of software packages that it depends on when it is running.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier
      collectionGUID - unique identifier
      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)

    • detachSoftwarePackageDependency

      @PostMapping(path="/assets/{assetGUID}/software-package-dependencies/{collectionGUID}/detach") public VoidResponse detachSoftwarePackageDependency(@PathVariable String serverName, @PathVariable String assetGUID, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an asset from a collection of software packages that it no longer depends on.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier
      collectionGUID - unique identifier
      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)

    • setSoftwarePackageManifest

      @PostMapping(path="/elements/{elementGUID}/software-package-manifest") public VoidResponse setSoftwarePackageManifest(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element to indicate that it describes a list of software packages.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier
      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)

    • clearSoftwarePackageManifest

      @PostMapping(path="/elements/{elementGUID}/software-package-manifest/remove") public VoidResponse clearSoftwarePackageManifest(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the software package manifest designation from the element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier
      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)

    • setAsCloudPlatform

      @PostMapping(path="/software-server-platforms/{softwareServerPlatformGUID}/cloud-platform") public VoidResponse setAsCloudPlatform(@PathVariable String serverName, @PathVariable String softwareServerPlatformGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify a software server platform to say that it is a cloud platform.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerPlatformGUID - unique identifier of the software server platform
      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)

    • clearAsCloudPlatform

      @PostMapping(path="/software-server-platforms/{softwareServerPlatformGUID}/cloud-platform/remove") public VoidResponse clearAsCloudPlatform(@PathVariable String serverName, @PathVariable String softwareServerPlatformGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the cloud platform designation from a software server platform.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerPlatformGUID - unique identifier of the software server platform
      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)

    • setHostAsCloudProvider

      @PostMapping(path="/hosts/{hostGUID}/cloud-provider") public VoidResponse setHostAsCloudProvider(@PathVariable String serverName, @PathVariable String hostGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify a host to say that it is a cloud provider.
      Parameters:
      serverName - name of the server to route the request to
      hostGUID - unique identifier of the host
      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)

    • clearHostAsCloudProvider

      @PostMapping(path="/hosts/{hostGUID}/cloud-provider/remove") public VoidResponse clearHostAsCloudProvider(@PathVariable String serverName, @PathVariable String hostGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the cloud provider designation from a host.
      Parameters:
      serverName - name of the server to route the request to
      hostGUID - unique identifier of the host
      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)

    • setServerAsCloudTenant

      @PostMapping(path="/software-servers/{softwareServerGUID}/cloud-tenant") public VoidResponse setServerAsCloudTenant(@PathVariable String serverName, @PathVariable String softwareServerGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify a software server to say that it is hosting a cloud tenant.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerGUID - unique identifier of the software server
      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)

    • clearServerAsCloudTenant

      @PostMapping(path="/software-servers/{softwareServerGUID}/cloud-tenant/remove") public VoidResponse clearServerAsCloudTenant(@PathVariable String serverName, @PathVariable String softwareServerGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the cloud tenant designation from a software server.
      Parameters:
      serverName - name of the server to route the request to
      softwareServerGUID - unique identifier of the software server
      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)

    • setCapabilityAsCloudService

      @PostMapping(path="/software-capabilities/{softwareCapabilityGUID}/cloud-service") public VoidResponse setCapabilityAsCloudService(@PathVariable String serverName, @PathVariable String softwareCapabilityGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify a software capability to say that it is a cloud service.
      Parameters:
      serverName - name of the server to route the request to
      softwareCapabilityGUID - unique identifier of the software capability
      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)

    • clearCapabilityAsCloudService

      @PostMapping(path="/software-capabilities/{softwareCapabilityGUID}/cloud-service/remove") public VoidResponse clearCapabilityAsCloudService(@PathVariable String serverName, @PathVariable String softwareCapabilityGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the cloud service designation from a software capability.
      Parameters:
      serverName - name of the server to route the request to
      softwareCapabilityGUID - unique identifier of the software capability
      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)

    • linkReusableTechniqueUse

      @PostMapping(path="/elements/{techniqueUserGUID}/reusable-technique-use/{reusableTechniqueGUID}/attach") public VoidResponse linkReusableTechniqueUse(@PathVariable String serverName, @PathVariable String techniqueUserGUID, @PathVariable String reusableTechniqueGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach an element to the reusable technique that it makes use of.
      Parameters:
      serverName - name of the server to route the request to
      techniqueUserGUID - unique identifier of the element at end 1
      reusableTechniqueGUID - unique identifier of the element at end 2
      requestBody - properties for the relationship
      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)

    • detachReusableTechniqueUse

      @PostMapping(path="/elements/{techniqueUserGUID}/reusable-technique-use/{reusableTechniqueGUID}/detach") public VoidResponse detachReusableTechniqueUse(@PathVariable String serverName, @PathVariable String techniqueUserGUID, @PathVariable String reusableTechniqueGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an element from a reusable technique that it no longer makes use of.
      Parameters:
      serverName - name of the server to route the request to
      techniqueUserGUID - unique identifier of the element at end 1
      reusableTechniqueGUID - unique identifier of the element at end 2
      requestBody - delete options
      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)

    • linkDependentSoftwareComponent

      @PostMapping(path="/runnable-software-components/{dependentComponentGUID}/dependent-software-component/{dependedOnComponentGUID}/attach") public VoidResponse linkDependentSoftwareComponent(@PathVariable String serverName, @PathVariable String dependentComponentGUID, @PathVariable String dependedOnComponentGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a runnable software component to a component that it needs in order to execute.
      Parameters:
      serverName - name of the server to route the request to
      dependentComponentGUID - unique identifier of the element at end 1
      dependedOnComponentGUID - unique identifier of the element at end 2
      requestBody - properties for the relationship
      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)

    • detachDependentSoftwareComponent

      @PostMapping(path="/runnable-software-components/{dependentComponentGUID}/dependent-software-component/{dependedOnComponentGUID}/detach") public VoidResponse detachDependentSoftwareComponent(@PathVariable String serverName, @PathVariable String dependentComponentGUID, @PathVariable String dependedOnComponentGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a runnable software component from a component that it no longer needs in order to execute.
      Parameters:
      serverName - name of the server to route the request to
      dependentComponentGUID - unique identifier of the element at end 1
      dependedOnComponentGUID - unique identifier of the element at end 2
      requestBody - delete options
      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)

    • linkSoftwareSource

      @PostMapping(path="/assets/{assetGUID}/software-source/{softwareComponentGUID}/attach") public VoidResponse linkSoftwareSource(@PathVariable String serverName, @PathVariable String assetGUID, @PathVariable String softwareComponentGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Attach a software asset to the software component that it is built from.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the element at end 1
      softwareComponentGUID - unique identifier of the element at end 2
      requestBody - properties for the relationship
      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)

    • detachSoftwareSource

      @PostMapping(path="/assets/{assetGUID}/software-source/{softwareComponentGUID}/detach") public VoidResponse detachSoftwareSource(@PathVariable String serverName, @PathVariable String assetGUID, @PathVariable String softwareComponentGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a software asset from the software component that it was built from.
      Parameters:
      serverName - name of the server to route the request to
      assetGUID - unique identifier of the element at end 1
      softwareComponentGUID - unique identifier of the element at end 2
      requestBody - delete options
      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)

    • setElementAsGeneratedTarget

      @PostMapping(path="/elements/{elementGUID}/generated-target") public VoidResponse setElementAsGeneratedTarget(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element to say that it is the generated output of a build program or script.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to classify
      requestBody - properties for the classification
      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)

    • clearElementAsGeneratedTarget

      @PostMapping(path="/elements/{elementGUID}/generated-target/remove") public VoidResponse clearElementAsGeneratedTarget(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the generated target designation from an element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to declassify
      requestBody - metadata source options
      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)

    • setElementAsReusableTechnique

      @PostMapping(path="/elements/{elementGUID}/reusable-technique") public VoidResponse setElementAsReusableTechnique(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify an element to say that it is a technique that can be reused in multiple contexts.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to classify
      requestBody - properties for the classification
      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)

    • clearElementAsReusableTechnique

      @PostMapping(path="/elements/{elementGUID}/reusable-technique/remove") public VoidResponse clearElementAsReusableTechnique(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Remove the reusable technique designation from an element.
      Parameters:
      serverName - name of the server to route the request to
      elementGUID - unique identifier of the element to declassify
      requestBody - metadata source options
      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)