Build and Configure Mainframe Integration Projects

Get mainframe files and directories for a pipeline

Retrieves the list of mainframe files and directories associated with the specified pipeline within a project.

Features:

Complete file and directory metadata retrieval
Hidden/system files excluded by default (includeHidden=false)
File application type classification
User tracking information (created by, modified by)
Pipeline and data flow associations
Directory structure and composition

Use Cases:

Browse available files and directories for a pipeline
Access file and directory metadata for management operations
List pipeline content structure

Required Permissions: replication-pipeline::view

get/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files

Request

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

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

Query parameters

includeHiddenboolean

Include hidden/system files in response

Response

Successfully retrieved files

idstring

Unique identifier of the mainframe file.

fileNamestring

Name of the mainframe file.

fileContentstring

Base64-encoded content of the mainframe file.

contentHashstring

SHA-256 content hash of the decoded file bytes.

sizeinteger

File size in bytes.

uploadedDatestring date-time

Date when the file was uploaded.

modifiedDatestring date-time

Date when the file was last modified.

lastModifiedBystring

Username of the last person who modified the file.

fileApplicationType'ENGINE_SCRIPT' | 'CONFIGURATION'

Application type of the file, e.g., ENGINE_SCRIPT or CONFIGURATION.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "fileName": "DATAFILE01",
  "fileContent": "SGVsbG8sIFdvcmxkIQ==",
  "contentHash": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
  "size": 1024,
  "uploadedDate": "2024-01-01T12:00:00Z",
  "modifiedDate": "2024-01-02T15:30:00Z",
  "lastModifiedBy": "jane.smith@example.com",
  "fileApplicationType": "ENGINE_SCRIPT"
}

Changes

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