Pipelines API

Pipelines exposes a REST service with API methods to perform actions such as retrieving a list of stream pipelines or stopping an initial load for a specified stream pipeline.

With these API methods, you can perform these actions:

  • General API:
    • Verify whether the Pipelines service is available and functional.
    • Retrieve the current build number for the Pipelines service.
  • Stream pipeline operational control API:
    • Retrieve a list of stream pipelines.
    • Retrieve the current status of a stream pipeline.
    • Start a stream pipeline (asynchronous operation).
    • Stop a stream pipeline (asynchronous operation).
    • Retrieve the current initial load status of a stream pipeline.
    • Start an initial load for a stream pipeline (asynchronous operation).
    • Stop an initial load for a stream pipeline (asynchronous operation).
  • Replay Queue management APIs:
    • Retrieve a list of stream pipelines that have errors in the Replay Queue.
    • Retrieve events from the Replay Queue for a specified stream pipeline.
    • Replay failed events from the Replay Queue for a specified stream pipeline, source, and error type.
    • Discard failed events from the Replay Queue for a specified stream pipeline, source, and error type.
    • Stop the replay process for a specified stream pipeline, source, and error type.
    • Replay failed events from the Replay Queue for all error types for a specified stream pipeline and source.
    • Discard failed events from the Replay Queue for all error types for a specified stream pipeline and source.
    • Stop the replay process for a specified stream pipeline and source.
    • Replay all failed events from the Replay Queue for a specified stream pipeline.
    • Discard all failed events from the Replay Queue for a specified stream pipeline.
    • Stop the entire replay process for a specified stream pipeline.
  • Pipeline monitoring and metrics APIs:
    • Retrieve aggregate counting metrics for a specified stream pipeline over a given time range.
    • Retrieve data points of time-series metrics for a specified metric type (read, write, error, replayed, discarded, excluded) over a given time range.
  • Stream pipeline modeling and configuration APIs:
    • Retrieve the details of a specified stream pipeline.
    • Create a stream pipeline.
    • Replace a stream pipeline (full update).
    • Delete a specified stream pipeline.
  • Destination modeling and configuration APIs:
    • Retrieve the list of destinations.
    • Retrieve the details of a specified destination.
    • Create a destination.
    • Replace a destination (full update).
    • Delete a specified destination.
    • Retrieve the usage details of a specified destination.
    • Test the connection to a destination.

Interface and consumption methods are exposed through the Pipelines API service that is registered within the Infor Data Fabric suite in API Gateway.

Details for each method are available in the Swagger documentation within these endpoints:

  • /pipelines/operations: Supports up to 20 requests per minute per tenant.
  • /pipelines/models: Supports up to 10 requests per minute per tenant.

For information on API Gateway usage and Swagger documentation, see the Infor API Gateway Administration Guide.