Update pipeline parameter - 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

Updates an existing pipeline parameter by its unique identifier with new values, type, or description.

HTML

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

Process overview

  1. Request Validation—Validates parameter payload and identifier.
  2. Parameter Retrieval—Fetches existing parameter to check current state.
  3. Security Validation—Ensures encrypted parameters cannot be changed to plain text.
  4. Parameter Update—Updates the parameter with new details.

Use cases

  • Modify parameter values or descriptions.
  • Change parameter types (with security constraints).
  • Update pipeline configuration parameters.

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 update.

Request body properties

Property Required Type Description
name Yes string

Specifies the parameter name. The name must be unique within the pipeline. It must also contain only alphanumeric and underscore characters. The name cannot contain other special characters or spaces.

Example: "user"
value Yes string

Specifies the parameter value.

Example: "adminPassword123"
type No string

Specifies the parameter type. This must be one of the following:

  • PARAMETER_DATA_TYPE_STRING—Plain text parameter for non-sensitive values.
  • PARAMETER_DATA_TYPE_ENCRYPTED_STRING—Encrypted parameter for sensitive values like passwords.

To prevent accidental exposure of sensitive data, encrypted parameters cannot be changed to plain text (STRING type).

Example: "PARAMETER_DATA_TYPE_STRING"
description No string

Provides an optional human-friendly description for the parameter

Example: "Mainframe connection user"

Request body example

{
"name": "database_password",
"value": "newSecurePassword456",
"type": "PARAMETER_DATA_TYPE_ENCRYPTED_STRING",
"description": "Updated database connection password"
}

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 one of the following reasons:

  • Invalid project or pipeline ID
  • Invalid parameter payload (missing required fields)
  • Invalid parameter type
  • Parameter name contains disallowed characters
  • Encrypted parameter cannot be changed to plain text
{
  "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-0004"
  }
}