Synchronously activates a mainframe data integration pipeline by performing validation, staging, activation, and starting operations based on the provided request flags.
HTML
POST https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/activationProcess 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 run 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 case
- Supports selective operations based on request flags for flexible pipeline management.
- 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
replication-pipeline::manage
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project |
| pipelineId | Yes | string |
Unique identifier of the pipeline |
Request body properties
| Property | Required | Type | Description |
|---|---|---|---|
| validate | No | boolean |
This property may be set to |
| stage | No | boolean |
This property may be set to |
| activate | No | boolean |
This property may be set to |
| start | No | boolean |
This property may be set to |
Request body example
"validate": "true",
"stage": "true",
"activate": "true",
"start": "true"Response
Header keys
| Key | Required | Type | Description |
|---|---|---|---|
| Location | No | string | URL to access pipeline logs when the pipeline is successfully started. Only present when the start operation succeeds. |
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| validate | No | ||
| stage | No | ||
| deploy | No | ||
| start | No |
Response examples
Example status code responses for this method are shown here.
"validate": {
"success": "true"
}
"stage": {
"success": "true"
}
"deploy": {
"success": "true"
}
"start": {
"success": "true"
}"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}/activation",
"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/mainframe/projects/{projectId}/pipelines/{pipelineId}/activation",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0001"
}"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}/activation",
"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}/activation",
"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}/activation",
"properties": {
"errorCode": "DI-ADAPTER-MFD-0009"
}