Build and Configure Mainframe Integration Projects

Get pipeline parameter by id

Retrieves a pipeline parameter by its unique identifier.

Features:

Complete parameter metadata retrieval
Parameter value and type information
Parameter description and configuration details

Use Cases:

Access individual parameter details
View parameter configuration for editing
Retrieve parameter values for pipeline execution

Required Permissions: replication-pipeline::view

get/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

Response

Parameter retrieved successfully

idstring

Unique identifier of the parameter

namestring

Name of the parameter

valuestring

Value of the parameter

type'PARAMETER_DATA_TYPE_STRING' | 'PARAMETER_DATA_TYPE_ENCRYPTED_STRING'

Data type of the parameter

descriptionstring

Description of the parameter

lastModifiedBystring

Username of the last person who modified the parameter

lastUpdatedAtstring date-time

Timestamp when the parameter was last updated

Example response

{
  "id": "absc1234-5678-def0-1234-56789abcdef0",
  "name": "user",
  "value": "USER123",
  "type": "STRING",
  "description": "Mainframe user ID",
  "lastModifiedBy": "john.doe@example.com",
  "lastUpdatedAt": "2025-11-04T09:37:52.638Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.