Download mainframe files and directories as ZIP - Precisely Data Integrity Suite

Data Integrity Suite APIs
Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Downloads all mainframe files and directories for the specified pipeline as a ZIP archive.

HTML

GET https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/download

Process overview

  1. Content Collection—Gathers all files and directories associated with the pipeline.
  2. Archive Creation—Packages files and directories into a ZIP archive preserving structure.
  3. Stream Preparation—Prepares the archive for download.
  4. Response Delivery—Returns the ZIP file with appropriate headers.

Key features

  • Single operation bulk file and directory download.
  • Efficient streaming for large file sets.
  • Directory structure preservation in archive.

Use cases

  • Backup mainframe files and directories.
  • Transfer content between environments.
  • Archive pipeline configurations with structure.

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

Response

This method returns the 200 status code when is successfully downloads the ZIP archive of mainframe files.

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.

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.

Examples
{
  "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}/files/upload",
  "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}/files/upload",
  "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}/files/upload",
  "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}/files/upload",
  "properties": {
    "errorCode": "DI-ADAPTER-MFF-0004"
  }
}
 
{
  "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}/files/upload",
  "properties": {
    "errorCode": "DI-ADAPTER-MFF-0006"
  }