Create a new 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

Creates a new pipeline parameter in the specified pipeline with the provided name, value, type, and description.

HTML

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

Process overview

  1. Request Validation—Validates parameter name format, value, type, and description
  2. Duplicate Check—Ensures parameter name doesn't already exist in the pipeline
  3. Parameter Creation—Creates the parameter with specified details and generates unique ID

Use cases

  • Add configuration parameters to pipelines.
  • Create encrypted credentials for data connections.
  • Set up pipeline-specific variables.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project.
pipelineId Yes string

Unique identifier of the pipeline.

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.
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": "securePassword123",
  "type": "PARAMETER_DATA_TYPE_ENCRYPTED_STRING",
  "description": "Database connection password for production environment"
}

Response

Header keys

Key Required Type Description
Location No string

URI of the newly created parameter.

Example: /v1/integration/mainframe/projects/project-123/pipelines/pipeline-456/parameters/param-789

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
  • Parameter payload missing required fields
  • Invalid parameter type
  • Disallowed characters in parameter name.
{
  "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",
  "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",
  "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",
  "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",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0007"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.9",
  "title": "Conflict",
  "status": 409,
  "detail": "Parameter creation failed - parameter already exists",
  "instance": "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/parameters",
  "properties": {
    "errorCode": "DI-ADAPTER-MFP-0006"
  }
}
 
{
  "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",
  "properties": {
    "errorCode": "DI-ADAPTER-MFP-0003"
  }
}