Unified Project Lifecycle APIs

List project file metadata

Retrieves file metadata through the unified project API for either Advanced Replication (DSL) or Mainframe Replication projects.

Features:

  • Returns metadata only (identity, path, version, phase, MIME type, size, and content hash). File content is intentionally excluded; call the get-file endpoint when content is needed.
  • For Mainframe Replication, pipelineId scopes the listing to one pipeline. For Advanced Replication, pipelineId is ignored and file listing is driven by view and revisionNumber.
  • view=CURRENT returns the current working set (including in-progress file states such as draft updates). view=COMMITTED returns a committed snapshot; if revisionNumber is omitted, the latest committed revision is returned.
  • pathPrefix limits the response to files under a specific folder or path prefix.
  • projectType is an optional routing hint and is normally inferred from the project.

Use Cases:

  • Populate a file-tree UI for a project.
  • Enumerate committed files at a specific revision.

Authorization: Requires replication-pipeline::view.

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

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/projects/{projectId}/files
  • 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 to list files for (Mainframe Replication only). Ignored for Advanced Replication, which scopes by revisionNumber/view instead.

view'CURRENT' | 'COMMITTED'

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

File-tree view to list: CURRENT | COMMITTED

revisionNumberinteger

Optional revision number to list when view is COMMITTED

pathPrefixstring

Optional path prefix filter restricting the listed files

Response

Project file metadata retrieved

projectIdstring

Unique identifier of the project

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

Type of the listed project

view'CURRENT' | 'COMMITTED'

File-tree view represented by this listing

revisionNumberinteger

Revision number represented by this listing, when view is COMMITTED

latestRevisionNumberinteger

Latest available committed revision number for the project

Example response

{
  "projectId": "project-123",
  "files": [
    {
      "fileId": "file-002",
      "fileName": "customers.dis.yaml",
      "flattenedPath": "sources/customers.dis.yaml",
      "version": 1,
      "mimeType": "application/yaml",
      "encoding": "utf-8",
      "sizeBytes": 512
    }
  ]
}

Changes

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