Fetch Reports Associated with a Mainframe Pipeline - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Retrieves reports for a specified mainframe pipeline within a project, filtered by agent type.

HTML

GET https://hostname/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/{pipelineId}/reports

Request

Process overview

  • Fetch reports associated with the specified pipeline.
  • Optionally filter reports by the provided agent type.

Key Features

  • Supports optional filtering by agent type for targeted report retrieval.

Required permissions

replication-pipeline::view

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project containing the pipeline

pipelineId Yes string

Unique identifier of the pipeline for which reports are being retrieved

Query parameters

Key Required Type Description
agentType No string Type of agent for which reports are to be retrieved

Response

Response body properties

Property Required Type Description
agentType No string

This property is an enumerated string type (enum) set to one of these values:

  • APPLY_ENGINE
  • STREAM_PUBLISHER
  • REPLICATOR
report No array  

Response example

Example status code responses for this method are shown here.

Example
{
  "agentType":"APPLY_ENGINE",
  "report":"Report line 1",
  "report":"Report line 2"
}