Retrieve detailed information about a specific run configuration for a pipeline, including its connection and engine details.
Request
Path parameters
| Key | Required | Type | Value | Description |
|---|---|---|---|---|
| pipelineId | Yes | string | objectId |
Unique identifier of the pipeline to execute. Example:
67e259257f3a733215481765 |
| runConfigId | Yes | string | objectId |
Unique identifier of the run configuration to use for the pipeline job. Example:
689db618617b4bd63438e56d |
Response
The successful response returns the run configuration details.
Response body
Example status code responses for this method are shown here. To view the response schemas, you can download the Data Quality Open API Specification from the Precisely Developer Portal.
{
"pipelineRunConfig": {
"id": "689db618617b4bd63438e56d",
"name": "Test_Run_Config_Name",
"connectionId": "67f39924ba2eee6be1aa968a",
"sourceAssetNamePath": "[Source_Datasource].[dq].[dbo].[test_dataset]",
"sourceAssetTypePath": "[Host].[Database].[Schema].[Table]",
"targetAssetNamePath": null,
"targetAssetTypePath": null,
"overwriteTarget": false,
"dropTarget": false,
"pipelineEngineId": "67f39a36c13a892caca36f80",
"targetAssets": {
"32e52518-532d-0de1-83dd-c20a52da6d8e": {
"connectionId": "67f39924ba2eee6be1aa968a",
"assetNamePath": "[Target_Datasource].[dq].[dbo].[output]",
"assetTypePath": "[Host].[Database].[Schema].[Table]",
"overwriteTarget": true,
"dropTarget": true
}
},
"sourceAssets": {
"initialInput": {
"connectionId": "67f39924ba2eee6be1aa968a",
"assetNamePath": "[Source_Datasource].[dq].[dbo].[test_dataset]",
"assetTypePath": "[Host].[Database].[Schema].[Table]"
}
},
"scheduleConfiguration": null,
"compatibilityStatus": true,
"published": false,
"type": "Batch",
"serviceIdentifierUrl": null,
"description": null,
"lastModifiedBy": null,
"lastModifiedDate": null
},
"connection": {
"id": "67f39924ba2eee6be1aa968a",
"name": "Source_Datasource_SQLServer_Connection",
"type": "Mssql",
"displayName": "SQLServer_Connection",
"exists": false,
"datasourceName": ""
},
"pipelineEngine": {
"id": "67f39a36c13a892caca36f80",
"name": "PipelineEngine_Agent",
"type": "",
"connectionId": "",
"agentVirtualId": "",
"properties": {
"sparkDriverMemory": "1g",
"sparkExecutorInstances": "1",
"sparkExecutorMemory": "3g",
"sparkExecutorCores": "3"
}
}
}{
"type": "about:blank",
"title": "Bad Request",
"status": 400,
"detail": "Invalid pipeline run configuration id",
"instance": "/v1/quality/pipelines/{pipelineId}/run-configs/{runConfigId}",
"errorCode": "DIS-QUALITY-PIPELINES-USR-0004"
}{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "Pipeline run configuration not found",
"instance": "/v1/quality/pipelines/{pipelineId}/run-configs/{runConfigId}",
"errorCode": "DIS-QUALITY-PIPELINES-USR-1002"
}{
"type": "about:blank",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred on the server",
"instance": "/v1/quality/pipelines/{pipelineId}/run-configs/{runConfigId}",
"errorCode": "DIS-QUALITY-PIPELINES-SVC-0001"
}