Exports multiple mainframe pipelines as a ZIP archive containing their configurations and associated files.
Process overview
- Request Validation—Validates project ID and pipeline IDs.
- Pipeline Collection—Gathers all specified pipelines and their configurations.
- Content Aggregation—Collects pipeline configurations, parameters, and associated files.
- Archive Creation—Packages all pipeline data into a ZIP archive preserving structure.
- Stream Preparation—Prepares the archive for download.
- Response Delivery—Returns the ZIP file with appropriate headers.
Key features
- Bulk export support for multiple pipelines in a single operation.
- Includes pipeline configurations, parameters, and associated files.
- Efficient streaming for large export sets.
- Directory structure preservation in archive.
Use cases
- Backup multiple pipeline configurations
- Transfer pipeline configurations between environments
- Archive project pipeline configurations
Required permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Specifies the unique identifier of the project. |
Response
Header keys
| Key | Required | Type | Description |
|---|---|---|---|
| Cache-Control | No | string |
No-cache headers to prevent caching of the ZIP file. |
| Content-Disposition | No | string | Indicates that the content is an attachment with filename. |
The method returns the 200 status code when it successfully exports the ZIP archive of pipelines.
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.
Validation failed due to one of the following reasons:
- Invalid project ID
- Invalid or empty pipeline IDs set
- Pipeline IDs contain invalid formats
{
"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}/export",
"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}/export",
"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}/export",
"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}/export",
"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}/export",
"properties": {
"errorCode": "DI-ADAPTER-MFD-0001"
}
}