Build and Configure Mainframe Integration Projects
Create a new pipeline parameter
Creates a new pipeline parameter in the specified pipeline with the provided name, value, type, and description.
Process Overview:
- Request Validation - Validates parameter name format, value, type, and description
- Duplicate Check - Ensures parameter name doesn't already exist in the pipeline
- Parameter Creation - Creates the parameter with specified details and generates unique ID
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
Parameter Naming Rules:
- Variable name cannot have a space or special characters except underscore (_)
- Must be unique within the pipeline
Use Cases:
- Add configuration parameters to pipelines
- Create encrypted credentials for data connections
- Set up pipeline-specific variables
Required Permissions: replication-pipeline::create when permission harmonization is enabled; otherwise, replication-pipeline::manage.
post/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/parameters
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
- Auth: HTTP bearer
Path parameters
projectIdstring required
Unique identifier of the project
pipelineIdstring required
Unique identifier of the pipeline
Request body
Example request
{
"name": "user",
"value": "********",
"type": "PARAMETER_DATA_TYPE_STRING",
"description": "Mainframe connection user"
}Response
Parameter created successfully. Location header contains the URI of the newly created parameter for future reference.
Changes
No recorded changes to this operation across all 1 revision of this API.