Retrieves a specific mainframe data integration pipeline by its unique identifier.
Features
- Complete pipeline information including metadata and configuration
- Optional section-based data loading for granular details
- Pipeline existence validation
- Access control enforcement
Response content
- Pipeline metadata (name, description, type, timestamps)
- User information (creator, last modifier, deployer)
- Project association details
- Optional section details if requested
Use cases
- View detailed pipeline information
- Check pipeline configuration and status
- Access pipeline-specific section details
Required permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project. |
| pipelineId | Yes | string |
Unique identifier of the pipeline. |
Query parameters
| Key | Required | Type | Description |
|---|---|---|---|
| sections | No | array |
Set of pipeline sections to include in the response. Allowed values:
For optional data loading, specify pipeline sections to include in the response, for example,
|
Response
Response body properties
| Ancestors | Property | Required | Type | Description |
|---|---|---|---|---|
| id | No | string |
Unique identifier of the mainframe pipeline. Example:
mainframe-pipeline-001 |
|
| name | No | string |
Name of the mainframe pipeline. Example:
CustomerMainframePipeline |
|
| internalName | No | string |
Internal system name used for the pipeline. Example:
customer_mainframe_pipeline_internal |
|
| agents | No | array[object] |
Agents associated with this pipeline. |
|
| agents | type | No | string |
Type of the mainframe agent. Example:
APPLY_ENGINE |
| agents | name | No | string |
Name of the agent. Example:
agent-1 |
| description | No | string |
Description of the pipeline purpose and functionality. Example:
Synchronizes customer data from mainframe to cloud. |
|
| pipelineType | No | string |
Type of mainframe pipeline, defining its purpose and behavior. |
|
| replicationType | No | string |
Type of mainframe replication. Example:
MAINFRAME_REPLICATION_TYPE_ENGINE |
|
| runtimeEngineId | No | string |
Identifier of the runtime engine associated with this pipeline. Example:
runtime-engine-123 |
|
| entryFileId | No | string |
Identifier of the entry file for this pipeline. Example:
entry-file-abc |
|
| configJsonFileId | No | string |
Identifier of the configuration JSON file for this pipeline. Example:
config-json-xyz |
|
| projectId | No | boolean |
Identifier of the project to which this pipeline belongs. Example:
project-789 |
|
| autoStart | No | boolean |
Flag indicating whether the pipeline should automatically start when deployed. Example:
true |
|
| stagePipelineConfiguration | No | boolean |
Flag indicating whether to stage the pipeline configuration Example:
true |
|
| activatePipelineConfiguration | No | boolean |
Flag indicating whether to activate the pipeline configuration. Example:
true |
|
| pipelineState | No | string |
Current state of the pipeline. Example:
PIPELINE_STATE_DEPLOYED_WITH_SUCCESS |
|
| sourceDataConnectionId | No | string |
Identifier of the data connection used as the source for this pipeline. Example:
source-conn-001 |
|
| targetDataConnectionId | No | string |
Identifier of the data connection used as the target for this pipeline. Example:
target-conn-002 |
|
| selectedResources | No | object |
Source and target resources selected for this pipeline. |
|
| selectedResources | source | No | object |
Source assets selected for the pipeline. |
| selectedResources | target | No | object |
Target assets selected for the pipeline. |
| cdcFieldMappings | No | object |
Field mapping configuration for Change Data Capture operations |
|
| cdcFieldMappings | sourceMessageProducerFormat | No | string |
Source message producer format. |
| cdcFieldMappings | fieldMappings | No | string |
Field mappings for CDC. |
| cdcFieldMappings/fieldMappings | sourceField | No | string |
Source field name. Example:
sv_sending_table |
| cdcFieldMappings/fieldMappings | targetField | No | string |
Target field name. Example:
Dataset name |
| cdcFieldMappings/fieldMappings | valueMappings | No | object[string] |
Value mappings for the field. |
| createdBy | No | string |
User who created the pipeline. Example:
john.doe@example.com |
|
| modifiedBy | No | string |
User who last modified the pipeline. Example:
jane.smith@example.com |
|
| deployedBy | No | string |
User who deployed the pipeline. Example:
carol.white@example.com |
|
| committedAt | No | string |
Date and time when the pipeline was last committed. Example:
2025-11-06T09:17:47Z |
|
| deployedAt | No | string |
Date and time when the pipeline was last deployed. Example:
2025-11-06T10:00:00Z |
|
| validatedAt | No | string |
Date and time when the pipeline was last validated. Example:
2025-11-06T10:30:00Z |
|
| tableMappings | No | array[object] |
List of table mappings configured for this pipeline. |
|
| tableMappings | sourceDatabase | No | string |
Name of the source database Example:
source-database |
| tableMappings | sourceSchema | No | string |
Name of the source schema Example:
source-schema |
| tableMappings | sourceTable | No | string |
Name of the source table Example:
source-table |
| tableMappings | targetDatabase | No | string |
Name of the target database/ Example:
target-database |
| tableMappings | targetSchema | No | string |
Name of the target schema. Example:
target-schema |
| tableMappings | targetTable | No | string |
Name of the target table. Example:
target-table |
| tableMappings | targetTopic | No | string |
Name of the target topic. Example:
target-topic |
| tableMappings | targetSubject | No | string |
Name of the target subject for schema registry. Example:
target-subject |
| tableMappings | sourceSchemaCase | No | string |
Case transformation to apply to source schema names. Default is NONE. Example:
NONE |
| tableMappings | sourceTableCase | No | string |
Case transformation to apply to source table names. Default is NONE. Example:
NONE |
| tableMappings | sourceColumnCase | No | string |
Case transformation to apply to source column names. Default is NONE. Example:
NONE |
Response body examples
Example status code responses for this method are shown here. To view the response schemas, you can download the Data Integration API specification (Precisely Integration Adapter Service) from the Precisely Developer Portal.
{
"id": "mainframe-pipeline-001",
"name": "CustomerMainframePipeline",
"internalName": "customer_mainframe_pipeline_internal",
"agents": [
{
"type": "APPLY_ENGINE",
"name": "agent-1"
}
],
"description": "Synchronizes customer data from mainframe to cloud.",
"pipelineType": "ENGINE_KAFKA",
"replicationType": "ENGINE",
"runtimeEngineId": "runtime-engine-123",
"entryFileId": "entry-file-abc",
"configJsonFileId": "config-json-xyz",
"projectId": "project-789",
"autoStart": true,
"stagePipelineConfiguration": true,
"activatePipelineConfiguration": true,
"pipelineState": "DEPLOYED_WITH_SUCCESS",
"sourceDataConnectionId": "source-conn-001",
"targetDataConnectionId": "target-conn-002",
"selectedResources": {
"source": {
"topics": [
"topicA",
"topicB"
]
},
"target": {
"schemasAndTables": [
{
"schema": "target-schema",
"tables": [
"target-table1",
"target-table2"
]
}
]
}
},
"cdcFieldMappings": {
"sourceMessageProducerFormat": "custom",
"fieldMappings": [
{
"sourceField": "sv_sending_table",
"targetField": "Dataset name",
"valueMappings": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
]
},
"createdBy": "john.doe@example.com",
"modifiedBy": "jane.smith@example.com",
"deployedBy": "carol.white@example.com",
"committedAt": "2025-11-06T09:17:47Z",
"deployedAt": "2025-11-06T10:00:00Z",
"validatedAt": "2025-11-06T10:30:00Z",
"tableMappings": [
{
"sourceSchema": "source-schema",
"sourceTable": "source-table1",
"targetSchema": "target-schema",
"targetTable": "target-table1",
"sourceSchemaCase": "UPPER_CASE",
"sourceTableCase": "LOWER_CASE",
"sourceColumnCase": "TOGGLE_CASE"
},
{
"sourceSchema": "source-schema",
"sourceTable": "source-table2",
"targetSchema": "target-schema",
"targetTable": "target-table2",
"sourceSchemaCase": "UPPER_CASE",
"sourceTableCase": "LOWER_CASE",
"sourceColumnCase": "TOGGLE_CASE"
}
]
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation error occurred",
"instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0000"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": 403,
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0002"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": 404,
"detail": "Not Found - Resource does not exist",
"instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
"properties": {
"errorCode": "DI-ADAPTER-DFL-0007"
}
}{
"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/projects/{projectId}/pipelines/{pipelineId}",
"properties": {
"errorCode": "DI-ADAPTER-DFL-0002"
}
}