Mainframe Pipelines Design APIs - 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

These APIs simplify mainframe integration by enabling creation of sync and reverse-sync pipelines. They include safeguards for replication modes, auto-start behavior, and comprehensive error handling.

Methods

GET Get mainframe pipelines by project ID
Retrieves all mainframe data integration pipelines associated with a specific project with pagination and sorting.
GET Get mainframe pipeline by ID
Retrieves a specific mainframe data integration pipeline by its unique identifier.
DELETE Delete a mainframe pipeline by ID
Deletes a mainframe pipeline by its ID within a project. Supports optional deletion of pipeline configuration only.
POST Create a new mainframe pipeline
Creates a new mainframe data integration pipeline in a mainframe project. If the pipeline is successfully created, the response includes the pipeline and project identifiers in the response body.
POST Configure mainframe pipeline components
Configures source assets selection, target assets selection, and field mappings (transformation) for a mainframe pipeline.
POST Configure table mappings for a mainframe pipeline
Configures source-to-target table mappings for a specified pipeline within a mainframe integration project.
POST Generate mainframe application scripts
Generates the mainframe pipeline scripts for a given pipeline.
POST Activate a mainframe pipeline
Synchronously activates a mainframe data integration pipeline by performing validation, staging, activation, and starting operations based on the provided request flags.
GET Get mainframe files and directories for a pipeline
Retrieves the list of mainframe files and directories associated with the specified pipeline within a project.
POST Create a new mainframe file or directory
Creates a new mainframe file or directory in the specified pipeline with the provided content and application type.
GET Get mainframe file or directory by ID
Retrieves a mainframe file or directory by its unique file ID.
PUT Update mainframe file content by ID
Updates the content of an existing mainframe file by its unique file ID with new file content.
DELETE Delete mainframe file or directory by ID
Deletes a mainframe file or directory by its unique file ID from the specified pipeline.
PUT Rename mainframe files or directories
Rename one or more mainframe files or directories in the specified pipeline.
POST Upload multiple mainframe files
Uploads multiple mainframe files to a specified directory path within the pipeline using batch upload API.
GET Download mainframe files and directories as ZIP
Downloads all mainframe files and directories for the specified pipeline as a ZIP archive.
GET Get mainframe pipeline parameters
Retrieves the list of pipeline parameters associated with the specified pipeline within a project.
POST Create a new pipeline parameter
Creates a new pipeline parameter in the specified pipeline with the provided name, value, type, and description.
DELETE Delete all pipeline parameters
Deletes all parameters associated with the specified pipeline.
GET Get pipeline parameter by id
Retrieves a pipeline parameter by its unique identifier.
PUT Update pipeline parameter
Updates an existing pipeline parameter by its unique identifier with new values, type, or description.
DELETE Delete pipeline parameter by id
Deletes a pipeline parameter by its id.
POST Export mainframe pipelines as ZIP
Exports multiple mainframe pipelines as a ZIP archive containing their configurations and associated files.
POST Import mainframe pipelines from ZIP
Imports multiple mainframe pipelines from a ZIP archive containing their configurations and associated files.