Retrieve flow definition by flow ID - 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

Retrieves the Multipass flow definition for the specified flow ID. The flow definition contains the complete configuration and processing steps for the flow.

GET https://hostname/v1/multipass/flows/{flowId}

Request

Path parameters

Key Required Type Description
flowId Yes string

Unique identifier for the Multipass flow

Header keys

Table 1.
Key Required Type Description
X-Request-Id No String

An optional header that allows clients to supply a unique identifier for the request. When provided, this value is recorded by the system and can be used to trace and diagnose issues more efficiently. Supplying an X‑Request‑Id enables precise request tracking without manual log searches. The maximum supported length is 38 characters.

Response

This API returns the full definition of the flow that was executed or retrieved. The response includes the execution status, the flow identifier, and a detailed breakdown of all operators that make up the flow.

Response body properties

Property Type Description
status string

Represents the outcome of the operation. Common values include SUCCESS or FAILURE, depending on whether the request was processed successfully.
flowId string The unique identifier of the Multipass flow associated with the request or response. This value corresponds to the flow being retrieved.
flowDefinition object

Describes the sequence of operators that make up the execution flow. Each operator includes an identifier, type, description, and routing information

Response examples

Example status code responses for this method are shown here.

Examples
{
  "status": "OK",
  "flowId": "default_flow",
  "flowDefinition": {
    "operators": [
      {
        "id": "Default Flow start",
        "description": "Java Test Flow Start",
        "nextNode": "return_input",
        "type": "Start"
      },
      {
        "id": "return_input",
        "resultExpression": "$",
        "type": "Return"
      }
    ]
  }
}
 
{
  "id": "0049c2dbb58b8393e8bced346fd8d660",
  "errors": [
    {
      "code": "DIS-1001",
      "detail": "Unauthorized"
    }
  ]
}
 
{
  "id": "b17e82b13b6b7d88eaf886636fae8b4d",
  "errors": [
    {
      "code": "DIS-1002",
      "detail": "You do not have permission to access this API"
    }
  ]
}
 

  "id": "f287c3b95d11f9ff28472ccc9ff38929",
  "errors": [
    {
      "code": "DIS-1005",
      "detail": "Rate limit exceeded"
    }
  ]
}
 
{
  "id": "6900b63d72d75452c6c982afef49dc70",
  "errors": [
    {
      "code": "DIS-MP-1002",
      "detail": "Invalid Flow Id. Flow ID cannot be null or empty."
    }
  ]
}
 
{
  "id": "f287c3b95d11f9ff28472ccc9ff38929",
  "errors": [
    {
      "code": "DIS-1003",
      "detail": "Issue with internal services. Please try again after sometime"
    }
  ]
}
 
{
  "id": "29839eb5a3d5be926bcd789fb3d71585",
  "errors": [
    {
      "code": "DIS-1003",
      "detail": "Issue with internal services. Please try again after sometime"
    }
  ]
}