Execute a flow with input data - 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

Executes the specified Multipass flow with the provided input data. Returns the processed results based on the flow's configuration.

POST https://hostname/v1/multipass/flows/{flowId}/execute

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.

Request body example

{
  "metadata": {
    "geocodeUrl": "https://example.geocode"
  },
  "input": [
    {
      "data_key1": "data_value1",
      "data_key2": "data_value2"
    },
    {
      "data_key1": "data_value3",
      "data_key2": "data_value4"
    }
  ]
}

Response

Returns the processed results of the executed Multipass flow as a JSON object. If execution fails due to invalid input or a runtime error, the response includes error details describing the issue.

Response body properties

Property Type Description
results Array

A list of result objects returned by the flow or operation. Each entry represents one processed output.

Response examples

Example status code responses for this method are shown here.

Examples
{
  "results": [
    {
      "processedData": "value123"
    },
    {
      "processedData": "value456"
    }
  ]
}
 
{
  "id": "6900b63d72d75452c6c982afef49dc70",
  "results": [
    {
      "processedData": "value"
    },
    {
      "code": "INVALID_INPUT",
      "detail": "Flow execution failed: Missing required field 'address'"
    }
  ]
}
 
{
  "id": "6900b63d72d75452c6c982afef49dc70",
  "errors": [
    {
      "code": "DIS-MP-1002",
      "detail": "Invalid Flow Id. Flow ID cannot be null or empty."
    }
  ]
}
 
{
  "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": "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"
    }
  ]
}