Unified Project Lifecycle APIs

Download all project files as a ZIP archive

Downloads every file currently associated with the project — not a single file — bundled into one ZIP archive. This is a bulk read/export operation; it never changes the lifecycle phase of a file. Passes through the generated archive response without application-side byte-array buffering.

Features:

  • Streams the ZIP directly, one entry at a time.
  • Optionally scoped by view, revisionNumber, and pathPrefix.
  • A size pre-flight runs before any bytes are written, so an over-budget request fails cleanly with 413 instead of half-writing a ZIP. A content-read failure that occurs after streaming has started aborts the connection instead of returning a new HTTP problem response — the 500 example below only applies to failures detected before streaming begins.

Use Cases:

  • VS Code extension downloads a project snapshot for offline inspection.
  • User exports a committed revision's files for audit retention.

Authorization: Requires replication-pipeline::view.

get/v1/integration/projects/{projectId}/files/archive

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/projects/{projectId}/files/archive
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project

Query parameters

projectType'REPLICATION' | 'MAINFRAME_REPLICATION' | 'ADVANCED_REPLICATION'

Supported project types for unified project operations

Optional project type hint: REPLICATION | MAINFRAME_REPLICATION | ADVANCED_REPLICATION

pipelineIdstring

Unique identifier of the Mainframe Replication pipeline (Mainframe Replication only). Ignored for Advanced Replication.

view'CURRENT' | 'COMMITTED'

Project file-tree view scope: CURRENT (working set) or COMMITTED (a specific revision)

Optional file-tree view to export: CURRENT | COMMITTED

revisionNumberinteger

Optional revision number whose files are exported

pathPrefixstring

Optional path prefix filter restricting the exported files

Response

ZIP archive of every file associated with the project

Changes

No recorded changes to this operation across all 1 revision of this API.