Imports multiple mainframe pipelines from a ZIP archive containing their configurations and associated files.
Process overview
- Request Validation—Validates ZIP file.
- Archive Extraction—Extracts pipeline configurations and files from ZIP.
- Pipeline Creation—Creates pipelines based on extracted configurations.
- File Association—Associates extracted files with created pipelines.
- Validation—Validates imported pipeline configurations.
Key features
- Bulk import support for multiple pipelines in a single operation.
- Supports pipeline configurations, parameters, and associated files.
- Validates imported configurations before creation.
Use cases
- Restore pipeline configurations from backup.
- Transfer pipeline configurations between environments.
- Deploy preconfigured pipeline sets.
Required permissions
replication-pipeline::manage
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Specifies the unique identifier of the project. |
Request body properties
| Property | Required | Type | Description |
|---|---|---|---|
| file | Yes | string | Specifies the compressed ZIP file containing mainframe pipelines to import. Maximum size is 15 MB. Example:
"pipelines_backup.zip" |
| resolveConflictsForPipelineNames | No | array[string] | Resolve conflicts for pipelines with these names during import by importing them with new pipeline names (new_name = given_name + "_imported") if a "Pipeline1" already exists, the imported pipeline will be named "Pipeline1_imported. Example:
["Pipeline1", "Pipeline2"] |
| ignorePipelinesNames | No | array[string] | Ignore pipelines with these names during import if conflicts are detected. Example:
["Pipeline3", "Pipeline4"] |
Response
Response body properties
| Ancestors | Property | Required | Type | Description |
|---|---|---|---|---|
| successes | No | array[object] | List of pipelines that were successfully imported. |
|
| successes | projectId | No | string | Unique identifier of the project where the pipeline was imported. |
| successes | pipelineId | No | string | Unique identifier assigned to the imported pipeline. |
| successes | pipelineName | No | string | Original name of the pipeline in the ZIP archive. |
| successes | importedPipelineName | No | string | Name of the pipeline after import (may differ if renamed due to conflicts). |
| successes | status | No | string | Import status of the pipeline. |
| errors | No | array[object] | List of pipelines that failed to import with error details |
|
| errors | errorType | No | string | Type of error that occurred during import:
|
| errors | pipelineName | No | string | Name of the pipeline that failed to import. |
| errors | errorMessage | No | string | Detailed error message explaining what went wrong. |
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.
{
"successes": [
{
"projectId": "456",
"pipelineId": "67f8d2c8e4b0a1b2c3d4e5f6",
"pipelineName": "customer-data-pipeline",
"importedPipelineName": "customer-data-pipeline",
"status": "IMPORTED"
}
],
"errors": [
{
"errorType": "CONFLICT_ERROR",
"pipelineName": "failed-pipeline",
"errorMessage": "Pipeline with name 'failed-pipeline' already exists in the project."
}
]
}Validation failed due to one of the following reasons:
- Invalid project ID
- Invalid archive format
- Invalid file size
{
"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}/import",
"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}/import",
"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}/import",
"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}/import",
"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}/import",
"properties": {
"errorCode": "DI-ADAPTER-MFD-0002"
}
}