Creates configuration for various components within a specific pipeline in a project.
HTML
POST https://hostname/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configurationProcess overview
- Resource Validation—Validates project and pipeline existence.
- Parallel Component Processing—Processes each component configuration independently.
- 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
- Isolation & Fault Tolerance—Component failures do not affect other components.
- Component Existence & Skipping:—If a component is already configured and up-to-date, its configuration step is skipped.
- 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
replication-pipeline::manage
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Specifies the unique identifier of the project containing the pipeline. |
| pipelineId | Yes | string |
Specifies the unique identifier of the pipeline to configure. |
Request body properties
Each component supports independent configuration and will be processed in parallel for optimal performance. Component failures are isolated and do not affect other components.
| Ancestor | Property | Required | Type | Description |
|---|---|---|---|---|
| metabase | No | object | Configuration for Metabase Replication Metadata component. | |
| metabase | source | No | object | Source Metabase configuration. |
| metabase | target | No | object | Target Metabase configuration. |
| logReader | Yes | object | Configuration for LogReader log processing and journal management component. | |
| logReader | name | Yes | string | The name identifier for the LogReader instance. |
| logReader | journalName | Yes | string | The journal name for log processing and change data capture. |
| logReader | parameters | No | object[string] | Additional configuration parameters for LogReader customization. |
| userDatabase | No | object | Configuration for User Database components. | |
| userDatabase | source | No | object | Source User Database configuration. |
| userDatabase | target | No | object | Target User Database configuration. |
| staging | Yes | object | Configuration for Staging data processing and batch management component | |
| staging | type | Yes | string | Configuration for Staging data processing and batch management component. |
| staging | directory | Yes | string | Type of staging configuration specifying the cloud storage platform |
| staging | schema | Yes | string | Directory path for staging data storage. |
| staging | vaultConnection | No | string | Vault connection ID for secure credential storage. |
| batchWindow | Yes | object | Batch processing window configuration for staging operations. | |
| batchWindow | data | Yes | object | Data limit configuration for batch processing. |
| batchWindow/data | limit | Yes | integer | Numeric limit value for batch processing. |
| batchWindow/data | units | Yes | string | Units for the data limit. |
| batchWindow | duration | Yes | object | Duration configuration for batch processing |
| batchWindow/duration | frequency | Yes | integer | Frequency value for batch processing. |
| batchWindow/duration | units | Yes | string | Time units for the frequency. |
Request body example
{
"metabase": {
"source": {
"name": "analytics-source-metabase",
"vaultConnectionId": "vault-identifier",
"adminUser": "metabase_admin",
"adminPassword": "secure_password123",
"replicationUser": "replicator_user",
"replicationPassword": "path_to_secure_password",
"parameters": {
"database_type": "postgresql"
}
},
"target": {
"name": "analytics-target-metabase",
"adminUser": "metabase_admin",
"adminPassword": "secure_password123",
"replicationUser": "replicator_user",
"replicationPassword": "secure_password123",
"parameters": {
"database_type": "postgresql"
}
}
},
"logReader": {
"name": "transaction-logReader",
"journalName": "transaction-journal",
"parameters": {
"log_level": "INFO",
"batch_size": "1000"
}
},
"userDatabase": {
"source": {
"databases": [
"source-user-db-primary",
"source-user-db-replica"
],
"vaultConnectionId": "vault-identifier",
"username": "db_admin",
"password": "path_to_database_password"
},
"target": {
"databases": [
"target-user-db-primary",
"target-user-db-replica"
],
"username": "db_admin",
"password": "database_password123"
}
},
"staging": {
"type": "CDWH_STAGING_TYPE_S3",
"directory": "/data/staging",
"schema": "staging_schema",
"batchWindow": {
"data": {
"limit": 100,
"units": "THOUSAND"
},
"duration": {
"frequency": 60,
"units": "SECONDS"
}
}
}
}Response
Response body properties
| Ancestor | Property | Required | Type | Description |
|---|---|---|---|---|
| requestId | Required | string | Unique identifier for this configuration request. | |
| overallStatus | Required | string | Overall status of the configuration operation. | |
| executionTimeInMs | integer |
Total execution time for all component configurations in milliseconds |
||
| metabase | object |
Results for Metabase configuration. |
||
| metabase | logReader | object |
Results for LogReader configuration. |
|
| metabase | userDatabase | object |
Results for User Database configurations. |
|
| metabase | staging | object |
Results for Staging configuration |
Response examples
{
"requestId": "config-req-12345-abcde",
"overallStatus": "SUCCESS",
"executionTimeInMs": 45123,
"metabase": {
"source": {
"name": "analytics-source-metabase",
"version": "40i",
"response": "metabase created successfully",
"status": "SUCCESS"
},
"target": {
"name": "analytics-target-metabase",
"version": "40j",
"response": "metabase created successfully",
"status": "SUCCESS"
}
},
"logReader": {
"name": "transaction-logReader",
"journalName": "transaction-journal",
"response": "logreader configured successfully",
"status": "SUCCESS"
},
"userDatabase": {
"source": {
"success": [
{
"name": "source-user-db-primary",
"response": "user database configured successfully",
"status": "SUCCESS"
}
],
"failure": [
{
"name": "source-user-db-replica",
"response": "failed configuring user database",
"status": "FAILURE"
}
]
},
"target": {
"success": [
{
"name": "target-user-db-primary",
"response": "user database configured successfully",
"status": "SUCCESS"
}
],
"failure": [
{
"name": "target-user-db-replica",
"response": "failed configuring user database",
"status": "FAILURE"
}
]
}
},
"staging": {
"status": "SUCCESS",
"response": "staging details configured successfully"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation error occurred",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0000"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": 401,
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0001"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": 401,
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0001"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21",
"title": "Unprocessable Entity",
"status": 422,
"detail": "Unprocessable Entity - Request is syntactically correct but semantically invalid",
"instance": "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0001"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred",
"instance": "/v1/integration/mainframe/pipelines",
"properties": {
"errorCode": "DI-ADAPTER-DFL-0010"
}
}