Build and Configure Mainframe Integration Projects

Get mainframe file or directory by ID

Retrieves a mainframe file or directory by its unique file ID.

Response Modes:

  • When contentOnly=true or not provided (default): Returns raw file content as octet-stream for direct download/viewing (files only)
  • When contentOnly=false: Returns complete file/directory metadata including path, name, content, timestamps, and application type as JSON

Use Cases:

  • Download raw file content (contentOnly=true, default, files only)
  • View file or directory details and content (contentOnly=false)
  • Access individual file or directory metadata

Required Permissions: replication-pipeline::view

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

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/{fileId}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

fileIdstring required

Unique identifier of the file

Query parameters

contentOnlyboolean

If true, returns only file content as octet-stream; if false, returns full file metadata as JSON

Response

Successfully retrieved file

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.