Build and Configure Mainframe Integration Projects

Get pull status for mainframe files

Returns pull readiness status and size count for mainframe file hydration.

Features:

  • Validates project/pipeline association before evaluation
  • Hidden/system files excluded by default (includeHidden=false)
  • If fileIds is omitted or empty, all visible pipeline files are selected for evaluation
  • If fileIds is provided, evaluates only those specific file IDs against the latest remote snapshot
  • Returns available/missing counts and total payload size (real count, not estimated)
  • Surfaces explicit ready, unavailable, or nothing_to_fetch pull status

Use Cases:

  • UX preflight before user confirms pull
  • Showing selected file count and expected download footprint
  • Detecting stale selections when files were removed remotely
  • Full-pipeline evaluation when no fileIds specified

Required Permissions: replication-pipeline::view

get/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/pull-status

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-status
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

Query parameters

fileIdsstring[]

Selected file IDs for pull-status evaluation (if omitted or empty, evaluates all visible pipeline files)

includeHiddenboolean

Include hidden/system files in pull-status evaluation

Response

Successfully computed pull readiness status

projectIdstring

Project ID

pipelineIdstring

Pipeline ID

requestedFileCountinteger

Selected file count

availableFileCountinteger

Number of selected files available for hydration

totalSizeBytesinteger

Total payload size in bytes (real count, not estimated)

unavailableFileIdsstring[]

IDs that are missing from current remote snapshot

status'ready' | 'nothing_to_fetch' | 'unavailable'

Pull readiness status

Example response

{
  "projectId": "project-123",
  "pipelineId": "pipeline-456",
  "requestedFileCount": 2,
  "availableFileCount": 2,
  "totalSizeBytes": 8192,
  "status": "ready"
}

Changes

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