Advanced DSL Project Management

Get a single project file

Retrieves metadata and optional content for a specific file within the project.

Features:

  • Single-file metadata retrieval
  • Optional content inclusion (CLOB fetch)
  • Version, phase, and hash information

Use Cases:

  • File detail inspection in VS Code explorer
  • Selective single-file download
  • Pre-edit conflict check on individual files

Scenarios:

  • Quick content fetch for a single file preview
  • Metadata fetch only (includeContent=false) for lightweight checks

Required Permissions: replication-pipeline::view

get/v1/integration/advanced-dsl/projects/{projectId}/files/{fileId}

Request

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

Path parameters

projectIdstring required

Unique project identifier

fileIdstring required

The catalog asset ID of the file

Query parameters

includeContentboolean

Whether to include base64-encoded file content

Response

Successfully retrieved file

catalogAssetIdstring

The catalog asset ID for this file

flattenedPathstring

The flattened path of the file within the project

namestring

The file name

versioninteger

The version number of this file asset

phase'draft' | 'approved' | 'pending_deletion'

The lifecycle phase of the file

contentstring

Base64-encoded file content (present only when includeContent=true)

contentHashstring

SHA-256 hash of the file content

sizeBytesinteger

Size of the file in bytes

mimeTypestring

MIME type of the file

encodingstring

Logical file encoding format

createdAtstring date-time

Timestamp when the file was created

updatedAtstring date-time

Timestamp when the file was last updated

createdBystring

User who created the file

updatedBystring

User who last updated the file

catalogLinkstring

Direct link to the asset in the Data Catalog UI

Example response

{
  "catalogAssetId": "asset-file-001",
  "flattenedPath": "pipelines/customer-sync.dis.yaml",
  "name": "customer-sync.dis.yaml",
  "version": 2,
  "phase": "approved",
  "contentHash": "e3b0c44298fc1c149afbf4c8996fb924...",
  "sizeBytes": 2048,
  "mimeType": "application/x-yaml",
  "encoding": "utf-8",
  "createdAt": "2026-05-10T08:30:00Z",
  "updatedAt": "2026-05-15T14:20:00Z",
  "createdBy": "john.doe@example.com",
  "updatedBy": "jane.smith@example.com",
  "catalogLink": "https://catalog.precisely.com/assets/asset-file-001"
}

Changes

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