Build and Configure Continuous Integration Projects

Associate source and target connections with an existing continuous pipeline

Associates source and target connections with an existing continuous pipeline.

Process Overview:

  1. Pipeline Verification - Validates pipeline exists and belongs to the specified project
  2. Connection Validation - Validates source and target connections
  3. Parameter Processing - Applies default parameters based on connection type and merges with user-provided parameters
  4. Connection Association - Links the connections and applies final parameters to the pipeline

Parameter Handling:

  • Default Parameters: Applied based on target connection type (e.g., KAFKA connections get 15 default Kafka parameters)
  • User Parameters: Optional sourceParameters and targetParameters can be provided to override defaults
  • Parameter Validation: Only valid parameters for the connection type are accepted
  • Unknown Parameters: Invalid parameters are logged with warnings and ignored

Example for KAFKA Target:

  • Default parameters include: ACKNOWLEDGMENT, MESSAGE_FORMAT, PARTITION_MESSAGES_BY, LOB_MAX_SIZE, etc.
  • User can override any default parameter by providing it in targetParameters
  • Only parameters valid for KAFKA connection type are accepted

Required Permissions: Either replication-pipeline::create or replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.

post/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/connections

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/connections
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The unique identifier of the project containing the pipeline

pipelineIdstring required

The unique identifier of the pipeline to configure

Request body

sourceConnectionIdstring required

The ID of the source data connection to use for the pipeline. A data connection contains information on how to access the database or data source along with the required credentials.

targetConnectionIdstring required

The ID of the target data connection to use for the pipeline. A data connection contains information on how to access the database or data along with the required credentials.

sourceParametersobject

Optional custom source connection parameters to override defaults. Parameters should match known parameter names; unknown parameters will be ignored with a warning.

targetParametersobject

Optional custom target connection parameters to override defaults. When target connection type is KAFKA, these parameters will override the default Kafka parameters. Parameters should match known parameter names; unknown parameters will be ignored with a warning. Common Kafka parameters include: ACKNOWLEDGMENT, ENABLE_TRANSACTION_BUNDLING, INCLUDE_IMAGE_OPTION, LOB_MAX_SIZE, MESSAGE_FORMAT, PARTITION_MESSAGES_BY, etc.

Example request

{
  "sourceConnectionId": "conn-src-uuid",
  "targetConnectionId": "conn-tgt-uuid",
  "targetParameters": {
    "MESSAGE_FORMAT": "CSV",
    "ACKNOWLEDGMENT": "WAIT_SINGLE_BROKER"
  }
}

Response

Connections successfully associated with the pipeline

Changes

No recorded changes to this operation across all 1 revision of this API.