Retrieves the list of pipeline parameters associated with the specified pipeline within a project.
HTML
GET https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/parametersFeatures
- Complete parameter metadata retrieval
- Parameter type classification (
STRING,ENCRYPTED_STRING) - Parameter descriptions and values
Use cases
- Browse available parameters for a pipeline
- Access parameter metadata for management operations
- List pipeline configuration parameters
Required permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project. |
| pipelineId | Yes | string |
Unique identifier of the pipeline. |
Response
This method returns the 200 status code after it successfully retrieves the list of pipeline parameters associated with the specified pipeline.
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| id | No | string | Unique identifier of the parameter. Example:
"absc1234-5678-def0-1234-56789abcdef0" |
| name | No | string | Name of the parameter Example:
"user" |
| value | No | string | Value of the parameter. Example:
"USER123" |
| type | No | string | Data type of the parameter. Example:
"STRING" |
| description | No | string | Description of the parameter. Example:
"Mainframe user ID" |
| lastModifiedBy | No | string | Username of the last person who modified the parameter. Example:
"john.doe@example.com" |
| lastUpdatedAt | No | string | Timestamp when the parameter was last updated. Example:
"2025-11-04T09:37:52.638Z" |
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.
[
{
"id": "param-123",
"name": "DB_USER",
"value": "admin",
"type": "PARAMETER_DATA_TYPE_STRING",
"description": "Database username for connection",
"lastModifiedBy": "user1@example.com",
"lastUpdatedAt": "2024-01-02T12:00:00Z"
},
{
"id": "param-456",
"name": "DB_PASSWORD",
"type": "PARAMETER_DATA_TYPE_ENCRYPTED_STRING",
"description": "Database password for connection",
"lastModifiedBy": "user2@example.com",
"lastUpdatedAt": "2024-01-02T12:00:00Z"
}
]{
"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.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-0002"
}
}