Get pipeline status - 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

This method gets the runtime status of the pipeline for a specific Engine name.

HTTP Request
  • Supported Method: POST /api/v1/pipeline/status/{name}
  • Parameter name: serverRequest
    • name: Agent or Engine name
      Note: The parameter is required.
    • Input Field
      Parameter Type Description
      runtimeServerHost string The name of the runtime server. For example, Localhost.
      runtimeServerPort integer This port number should match whatever listener port you selected when installing the Apply engine. For example, 2626.
  • Parameter content type - Both request body data and response data are formatted as JSON. Content type for responses will always be application/json.

Code example

curl 'http://localhost:8026/api/v1/pipeline/status/{name}'
-H "Content-Type: application/json"
-X POST
-d '
{
  "runtimeServerHost": "localhost",
  "runtimeServerPort": 2626
}
Postman works the same way. Use Postman to query the end point with the Json payload list below. For example,
{
  "runtimeServerHost": "localhost",
  "runtimeServerPort": 2626
}
"url": http://localhost:8026/api/v1/pipeline/status/{name}

Response Fields

Code 200 - OK

Response Element Type Description
createdAt string  
id string  
message string  
result string  
success boolean  
version string