Build and Configure Mainframe Integration Projects

Pull selected mainframe files by file IDs

Hydrates selected files by fileIds for Mainframe pipelines using parallel fetching.

Features:

  • Selected-file hydration only (no full-pipeline download)
  • Parallel fetch for improved performance
  • Returns file payload with content and metadata (including size)
  • Validates project/pipeline association before hydration

Use Cases:

  • Initial selective pull for user-selected files
  • Manual refresh of a scoped subset of tracked files
  • Recovering specific remote files during conflict resolution workflows

Required Permissions: replication-pipeline::view

post/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/pull

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

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

Query parameters

fileIdsstring[] required

File IDs to hydrate

includeHiddenboolean

Include hidden/system files in pull hydration. When false (default), hidden files are filtered from responses. Files explicitly requested by ID are always honoured regardless of this flag.

Response

Successfully hydrated selected files

projectIdstring

Project ID

pipelineIdstring

Pipeline ID

requestedFileCountinteger

Number of files requested

hydratedFileCountinteger

Number of files successfully hydrated

Example response

{
  "projectId": "project-123",
  "pipelineId": "pipeline-456",
  "requestedFileCount": 2,
  "hydratedFileCount": 2,
  "files": [
    {
      "id": "67f8d2c8e4b0a1b2c3d4e5f6",
      "fileName": "pipeline.sqd",
      "size": 4096,
      "content": "U1FEIERBVEEuLi4=",
      "fileApplicationType": "ENGINE_SCRIPT",
      "contentHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
    }
  ]
}

Changes

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