Build and Configure Mainframe Integration Projects
Activate a mainframe pipeline
Synchronously activates a mainframe data integration pipeline by performing validation, staging, activation, and starting operations based on the provided request flags.
Process Overview:
- Validates the project and pipeline existence.
- If validate is true, performs validation of the pipeline configuration.
- If stage is true, commits the pipeline configuration to the staging area (requires validation).
- If activate is true, deploys the pipeline to the runtime environment.
- If start is true, starts the pipeline execution.
- Returns phase-wise results for validate, stage, deploy, and start operations.
Execution Details:
- All operations are executed sequentially within a single request.
- If any operation fails, subsequent operations are not attempted.
Key Features:
- Synchronous execution of activation steps with immediate feedback.
- Supports selective operations based on request flags for flexible pipeline management.
Use Cases:
- Deploy and start a newly configured pipeline in one operation.
- Stage pipeline changes for review before activation.
- Restart a stopped pipeline with validation.
- Perform incremental pipeline lifecycle management.
Required Permissions: Either replication-pipeline::create or replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.
post/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/activation
Request
- Base URL: https://integration-adapter.connect.cloud.precisely.com
- URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/activation
- Auth: HTTP bearer
Path parameters
projectIdstring required
Unique identifier of the project
pipelineIdstring required
Unique identifier of the pipeline
Request body
Example request
{
"validate": true,
"stage": true,
"activate": true,
"start": true
}Response
Pipeline activation result
Example response
{
"validate": {
"success": true,
"errors": [
"Error message"
]
},
"stage": {
"success": true,
"errors": [
"Error message"
]
},
"deploy": {
"success": true,
"errors": [
"Error message"
]
},
"start": {
"success": true,
"errors": [
"Error message"
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.