Delete pipeline parameter 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 pipeline parameter by its id.

HTML

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

Use cases

Remove obsolete parameters.
Clean up unused configuration parameters.
Delete parameters no longer needed by the pipeline.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key	Required	Type	Description
projectId	Yes	string	Specifies the unique identifier of the project.
pipelineId	Yes	string	Specifies the unique identifier of the pipeline.
parameterId	Yes	string	Specifies the unique identifier of the parameter to delete.

Response

Response body examples

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Integration API specification (Precisely Integration Adapter Service) from the Precisely Developer Portal.

Examples

Validation failed due to Invalid project, pipeline, parameter ID.

{
  "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}/parameters/{parameterId}",
  "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}/parameters/{parameterId}",
  "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}/parameters/{parameterId}",
  "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}/parameters/{parameterId}",
  "properties": {
    "errorCode": "DI-ADAPTER-MFP-0001"
  }
}

{
  "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}/parameters/{parameterId}",
  "properties": {
    "errorCode": "DI-ADAPTER-MFP-0005"
  }
}