Retrieve flow Ids of all available flows - 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 a list of all available Multipass Service. This API lets the user know what flows are available for any flow specific operation.

GET https://hostname/v1/multipass/flows

Response

The response returns a JSON object containing metadata about the request and a list of all registered Multipass flow identifiers. Specifically, the response includes:
  • status: Indicates the outcome of the request (for example "OK").
  • flowIds : An array of strings, where each string represents a unique flowId corresponding to a flow definition stored in the Multipass system

This response enables clients to determine which flows are available for retrieval, execution, update, or deletion.

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.
flowIds array

An array of strings that lists all the flow identifiers available or registered within the system for the user.

Response examples

Example status code responses for this method are shown here:

Examples
{
  "status": "OK",
  "flowIds": [
    "default_flow",
    "customer_validation_flow",
    "address_standardization_flow"
  ]
}
 
{
  "id": "0049c2dbb58b8393e8bced346fd8d660",
  "errors": [
    {
      "code": "DIS-1001",
      "detail": "Unauthorized"
    }
  ]
}
 
{
  "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"
    }
  ]
}