Delete a mainframe pipeline by ID - 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

Deletes a mainframe pipeline by its ID within a project. Supports optional deletion of pipeline configuration only.

HTML

DELETE https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}

Process overview

  1. Validates that the project and pipeline exist and the user has permission to delete the pipeline.
  2. The configOnly query parameter setting determines whether to delete both the pipeline configuration and the runtime components or only the pipeline configuration.

Delete pipeline configuration only behavior

We recommend that you do not delete only the pipeline configuration (configOnly=true). Use this setting only when the runtime processes for this pipeline no longer exist. This action cannot be undone. Exporting the pipeline before continuing is highly recommended.

Manual cleanup of runtime process is required after the pipeline configuration is deleted from the Data Integrity Suite.

Required permissions

replication-pipeline::manage

Request

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 to delete

Query parameters

Key Required Type Description
configOnly No boolean

If true, deletes only the pipeline configuration.

  • If this option is set to true, the method deletes only the pipeline configuration from the Data Integrity Suite. We do not recommend this option.
  • If is set to false (default), the method performs a full deletion including runtime components.

Response

Response examples

Example status code responses for this method are shown here.

Examples
{
   "type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
   "title":"Bad Request",
   "status":"400",
   "detail":"Validation error occurred",
   "instance":"/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
   "properties":{
     "errorCode":"DI-ADAPTER-VAL-0000"}
}
 
{
   "type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
   "title":"Unauthorized",
   "status":"401",
   "detail":"Authorization failed - missing or invalid credentials",
   "instance":"/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
   "properties":{
     "errorCode":"DI-ADAPTER-AUT-0001"}
}
 
{
   "type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
   "title":"Forbidden",
   "status":"403",
   "detail":"Authorization failed - insufficient permissions",
   "instance":"/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
   "properties":{
     "errorCode":"DI-ADAPTER-AUT-0002"}
}
 
{
   "type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
   "title":"Not Found",
   "status":"404",
   "detail":"Not Found - Resource does not exist",
   "instance":"/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
   "properties":{
     "errorCode":"DI-ADAPTER-DFL-0007"}
}
 
{
   "type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
   "title":"Internal Server Error",
   "status":"500",
   "detail":"An unexpected error occurred",
   "instance":"/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}",
   "properties":{
     "errorCode":"DI-ADAPTER-MFD-0013"}
}