Build and Configure Continuous Integration Projects

Configure pipeline components

Creates configuration for various components within a specific pipeline in a project.

Process Overview:

  1. Resource Validation - Validates project and pipeline existence
  2. Parallel Component Processing - Processes each component configuration independently
  3. Component Types Supported:
    • Metabase: Replication Metadata configuration
    • LogReader: Log processing and journal management
    • UserDatabase: User data store configuration
    • Staging: Data staging and batch processing configuration
  4. Isolation & Fault Tolerance - Component failures don't affect others
  5. Component Existence & Skipping: - If a component is already configured and up-to-date, its configuration step is skipped.
  6. Consolidated Response - Returns unified status after all processing

Key Features:

  • All component configurations are optional
  • Parallel processing for optimal performance
  • Independent component execution (failure isolation)
  • Metrics per component for better observability
  • Component specific thread pool resource allocation
  • Comprehensive error reporting per component

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}/configuration

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}/configuration
  • 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

Example request

{
  "metabase": {
    "source": {
      "name": "analytics-metabase",
      "vaultConnectionId": "vault-conn-123",
      "adminUser": "metabase_admin",
      "adminPassword": "********",
      "replicationUser": "replicator_user",
      "replicationPassword": "********",
      "parameters": {
        "database_type": "postgresql"
      }
    },
    "target": {
      "name": "analytics-metabase",
      "vaultConnectionId": "vault-conn-123",
      "adminUser": "metabase_admin",
      "adminPassword": "********",
      "replicationUser": "replicator_user",
      "replicationPassword": "********",
      "parameters": {
        "database_type": "postgresql"
      }
    }
  },
  "logReader": {
    "name": "transaction-logReader",
    "journalName": "transaction-journal",
    "parameters": {
      "log_level": "INFO",
      "batch_size": "1000"
    }
  },
  "userDatabase": {
    "source": {
      "databases": [
        "user-db-primary",
        "user-db-replica"
      ],
      "vaultConnectionId": "vault-conn-123",
      "username": "db_admin",
      "password": "********",
      "replicationUser": "replicator_user"
    },
    "target": {
      "databases": [
        "user-db-primary",
        "user-db-replica"
      ],
      "vaultConnectionId": "vault-conn-123",
      "username": "db_admin",
      "password": "********",
      "replicationUser": "replicator_user"
    }
  },
  "staging": {
    "type": "CDWH_STAGING_TYPE_S3",
    "directory": "/data/staging",
    "schema": "staging_schema",
    "vaultConnectionId": "vault-conn-123",
    "storageIntegration": "my_storage_integration",
    "batchWindow": {
      "data": {
        "limit": 100,
        "units": "THOUSAND"
      },
      "duration": {
        "frequency": 60,
        "units": "SECONDS"
      }
    }
  }
}

Response

Configuration successfully applied to pipeline components

requestIdstring

Unique identifier for this configuration request

overallStatus'SUCCESS' | 'PARTIAL' | 'FAILED'

Overall status of the configuration operation

executionTimeInMsinteger

Total execution time for all component configurations in milliseconds

Example response

{
  "requestId": "config-req-12345-abcde",
  "overallStatus": "SUCCESS",
  "executionTimeInMs": 45123
}

Changes

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