Get Pipeline Details

Returns pipeline details, variables, stages and jobs for a specified pipeline code.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.

Required Roles

Service Administrator, Power User

Rest Resource

GET/aif/rest/{api_version}/pipeline?pipelineName=<pipelineCode>

Note:

Use the pipeline code instead of the pipeline name when making the rest call.

The current REST API version for Data Integration must be V1.

Request

Supported Media Types: application/json

Parameters

This API requires the pipelineCode as a parameter. An example of the rest call is as follows:

https://<BASE-URL>/aif/rest/V1/pipeline?pipelineName=ObjectStore

Supported Media Types: application/json

Example of Response Body

The following is an example of the response body in JSON format that shows all details related to the pipeline. This example is for a simple pipeline with one stage and one job, but more complicated pipelines will return additional data.

{
    "status": 0,
    "details": null,
    "response": {
        "name": "ObjectStore",
        "displayName": "Object Store",
        "id": 1,
        "parallelJobs": 2,
        "partitionkey": null,
        "partName": null,
        "variables": [
            {
                "varName": "ATTACH_LOGS",
                "varDisplayName": "Attach Logs",
                "varDefaultValue": "N",
                "varType": "LOOKUP",
                "varValObject": "YES_NO",
                "varSequence": 7,
                "varDefaultParam": "Y"
            },
            {
                "varName": "ENDPERIOD",
                "varDisplayName": "End Period",
                "varDefaultValue": null,
                "varType": "LIST",
                "varValObject": "Global Period Name LOV Query",
                "varSequence": 2,
                "varDefaultParam": "N"
            },
            {
                "varName": "EXPORTMODE",
                "varDisplayName": "Export Mode",
                "varDefaultValue": "Merge",
                "varType": "LIST",
                "varValObject": "Pipeline Export Mode LOV Query",
                "varSequence": 4,
                "varDefaultParam": "N"
            },
            {
                "varName": "IMPORTMODE",
                "varDisplayName": "Import Mode",
                "varDefaultValue": "REPLACE",
                "varType": "LOOKUP",
                "varValObject": "DATA_LOAD_IMPORT_MODES",
                "varSequence": 3,
                "varDefaultParam": "N"
            },
            {
                "varName": "SEND_MAIL",
                "varDisplayName": "Send Mail",
                "varDefaultValue": "NO",
                "varType": "LOOKUP",
                "varValObject": "MAIL_CONDITION",
                "varSequence": 5,
                "varDefaultParam": "Y"
            },
            {
                "varName": "SEND_TO",
                "varDisplayName": "Send To",
                "varDefaultValue": null,
                "varType": "TEXT",
                "varValObject": null,
                "varSequence": 6,
                "varDefaultParam": "N"
            },
            {
                "varName": "STARTPERIOD",
                "varDisplayName": "Start Period",
                "varDefaultValue": null,
                "varType": "LIST",
                "varValObject": "Global Period Name LOV Query",
                "varSequence": 1,
                "varDefaultParam": "N"
            }
        ],
        "stages": [
            {
                "stageName": "Object Store",
                "stageDisplayName": "Stage",
                "stageID": 2,
                "stageSequence": 1,
                "stageParallel": "N",
                "plNextStageSuccess": "CONTINUE",
                "plNextStageFailure": "CONTINUE",
                "jobs": [
                    {
                        "jobType": "copyFromObjectStore",
                        "jobName": "New Job",
                        "jobID": 3,
                        "jobSeq": 1,
                        "jobObject": " ",
                        "jobConnection": "LOCAL",
                        "status": "SUCCESS",
                        "endTime": "Sep 02, 2025 08:09:35 PM",
                        "logFile": "/u03/inbox/outbox/logs/63.log",
                        "processId": 63,
                        "parameters": [
                            {
                                "paramName": "bucket",
                                "paramValue": "Bucket123",
                                "paramLevel": "JOB"
                            },
                            {
                                "paramName": "namespace",
                                "paramValue": "myNameSpace",
                                "paramLevel": "JOB"
                            },
                            {
                                "paramName": "objectName",
                                "paramValue": "Sample_file.dat",
                                "paramLevel": "JOB"
                            },
                            {
                                "paramName": "objectStoreConnection",
                                "paramValue": "Object Store",
                                "paramLevel": "JOB"
                            },
                            {
                                "paramName": "subFolder",
                                "paramValue": null,
                                "paramLevel": "JOB"
                            },
                            {
                                "paramName": "targetLocation",
                                "paramValue": "inbox",
                                "paramLevel": "JOB"
                            }
                        ]
                    }
                ]
            }
        ],
        "status": "SUCCESS",
        "processId": 62,
        "lastUpdatedDate": "Sep 02, 2025 08:09:35 PM",
        "proxyAdminUser": null
    }
}