Unified Project Lifecycle APIs

Get one project file

Retrieves one project file's metadata, and optionally its content, for either an Advanced Replication (DSL) project or a Mainframe Replication pipeline.

Features:

  • Set includeContent=true to also return the file's Base64-encoded content; omit it (or set it to false) to fetch only metadata when you don't need the file body, saving payload size for large files.
  • Pass the caller's last-known ETag value in the If-None-Match request header to check for changes without re-downloading unchanged content — if nothing changed since that value, the client library returns a not-modified result with no body.
  • The response ETag header is a fingerprint hash of the current content.

Use Cases:

  • VS Code extension opens a file for editing.
  • User polls for content changes using ETags to avoid unnecessary downloads.

Authorization: Requires replication-pipeline::view.

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

Request

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

Path parameters

projectIdstring required

Unique identifier of the project

fileIdstring required

Unique identifier of the file to retrieve

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.

includeContentboolean

When true, includes the file content in the response

Headers

If-None-Matchstring

Optional If-None-Match header value for conditional retrieval

Response

Project file retrieved

fileIdstring

Unique identifier of the file

dataFlowIdstring

Advanced Replication dataflow identifier owning this file, when applicable

fileNamestring

File name derived from the flattened path

flattenedPathstring

Path of the file within the project's flattened file tree

versioninteger

Current version number of the file

phase'DRAFT' | 'APPROVED' | 'PENDING_DELETION'

Lifecycle phase of the file

mimeTypestring

MIME type of the file content

encodingstring

Encoding of the file content

sizeBytesinteger

Size of the file content in bytes

contentHashstring

Hash of the file content, used for change detection

entryFileboolean

Whether this file is the project's designated entry file

contentstring

Base64-encoded file content, present only when requested

Example response

{
  "fileId": "file-002",
  "fileName": "customers.dis.yaml",
  "flattenedPath": "sources/customers.dis.yaml",
  "version": 1,
  "mimeType": "application/yaml",
  "encoding": "utf-8",
  "sizeBytes": 512,
  "content": "c291cmNlOlxuICBjb25uZWN0aW9uOiBvcmFjbGVfc291cmNlXG4="
}

Changes

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