Build and Configure Mainframe Integration Projects
Update pipeline parameter
Updates an existing pipeline parameter by its unique identifier with new values, type, or description.
Process Overview:
- Request Validation - Validates parameter payload and identifier
- Parameter Retrieval - Fetches existing parameter to check current state
- Security Validation - Ensures encrypted parameters cannot be changed to plain text
- Parameter Update - Updates the parameter with new details
Parameter Types:
- PARAMETER_DATA_TYPE_STRING - Plain text parameter for non-sensitive values
- PARAMETER_DATA_TYPE_ENCRYPTED_STRING - Encrypted parameter for sensitive values like passwords
Security Constraints:
- Encrypted parameters cannot be changed to plain text (STRING type)
- This prevents accidental exposure of sensitive data
Parameter Naming Rules:
- Variable name cannot have a space or special characters except underscore (_)
Use Cases:
- Modify parameter values or descriptions
- Change parameter types (with security constraints)
- Update pipeline configuration parameters
Required Permissions: replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.
put/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/parameters/{parameterId}
Request
- Base URL: https://integration-adapter.connect.cloud.precisely.com
- URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/parameters/{parameterId}
- Auth: HTTP bearer
Path parameters
projectIdstring required
Unique identifier of the project
pipelineIdstring required
Unique identifier of the pipeline
parameterIdstring required
Unique identifier of the parameter to update
Request body
Example request
{
"name": "user",
"value": "********",
"type": "PARAMETER_DATA_TYPE_STRING",
"description": "Mainframe connection user"
}Response
Parameter updated successfully
Changes
No recorded changes to this operation across all 1 revision of this API.