Package org.odpi.openmetadata.frameworkservices.oif.server.spring

Class OpenIntegrationResource

java.lang.Object
org.odpi.openmetadata.frameworkservices.oif.server.spring.OpenIntegrationResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/framework-services/{serviceURLMarker}/open-integration/users/{userId}") public class OpenIntegrationResource extends Object
OpenIntegrationResource supports the REST APIs for running the Open Integration Service.

  • Constructor Details

    • OpenIntegrationResource

      public OpenIntegrationResource()

  • Method Details

    • getMetadataSourceGUID

      @PostMapping(path="metadata-sources/by-name") public GUIDResponse getMetadataSourceGUID(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody NameRequestBody requestBody)
      Retrieve the unique identifier of the software server capability representing a metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - unique name of the integration daemon
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • createMetadataSource

      @PostMapping(path="/metadata-sources/new") public GUIDResponse createMetadataSource(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestBody MetadataSourceRequestBody requestBody)
      Create a new metadata element to represent a software capability. This describes the metadata source.
      Parameters:
      serverName - name of the server to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      requestBody - properties of the software capability
      Returns:
      unique identifier of the integration daemon's software server capability or InvalidParameterException the bean properties are invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem accessing the property server

    • getCatalogTargets

      @GetMapping(path="/integration-connectors/{integrationConnectorGUID}/catalog-targets") public CatalogTargetsResponse getCatalogTargets(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String integrationConnectorGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the identifiers of the metadata elements identified as catalog targets with an integration connector.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - identifier of calling user.
      integrationConnectorGUID - unique identifier of the integration connector.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of unique identifiers or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem storing the integration connector definition.

    • publishIntegrationReport

      @PostMapping(path="/integration-reports/{anchorGUID}/{anchorTypeName}/new") public VoidResponse publishIntegrationReport(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String anchorGUID, @PathVariable String anchorTypeName, @RequestBody IntegrationReportProperties properties)
      Create a new integration report for an element (identified by anchorGUID).
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      anchorGUID - element to attach the integration report to
      anchorTypeName - typeName of the anchor for the integration report
      properties - properties of the report
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request, PropertyServerException problem with the metadata server.

    • getIntegrationReport

      @GetMapping(path="/integration-reports/{reportGUID}") public IntegrationReportResponse getIntegrationReport(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String reportGUID)
      Retrieve a specific integration report by unique identifier.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      reportGUID - unique identifier of the integration report
      Returns:
      report or null or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request, PropertyServerException problem with the metadata server.

    • getIntegrationReportsForElement

      @GetMapping(path="/integration-reports/for-element/{elementGUID}") public IntegrationReportsResponse getIntegrationReportsForElement(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false) Date afterCompletionDate, @RequestParam(required=false) Date beforeStartDate, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the integration reports attached to an element. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      elementGUID - calling user
      afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).
      beforeStartDate - restrict reports to those that started before the requested time (null for any start time).
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of qualifying reports or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request. PropertyServerException problem with the metadata server.

    • getIntegrationReports

      @GetMapping(path="/integration-reports") public IntegrationReportsResponse getIntegrationReports(@PathVariable String serverName, @PathVariable String serviceURLMarker, @PathVariable String userId, @RequestParam(required=false) Date afterCompletionDate, @RequestParam(required=false) Date beforeStartDate, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Retrieve the published integration reports. The list can be filtered by start and completion date of the report along with the paging options if there are many integration reports.
      Parameters:
      serverName - name of the service to route the request to.
      serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)
      userId - calling user
      afterCompletionDate - restrict reports to those that completed after the requested time (null for any completion time).
      beforeStartDate - restrict reports to those that started before the requested time (null for any start time).
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      Returns:
      list of qualifying reports or InvalidParameterException one of the parameters is null or invalid, UserNotAuthorizedException user not authorized to issue this request. PropertyServerException problem with the metadata server.