Retrieve Engine logs - 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 retrieves deployed Engine logs.

HTTP Request
  • Supported Method: POST/api/v1/pipeline/logs/
  • Parameter name: serverRequest
    • 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.
  • projectId - string value of the project. The minimum length is 1. For example, 1234.
    Note: This parameter is required.
  • includeDaemon - boolean value "True" or "False"

Code example

You can use cURL to execute the call. For example,

curl 'http://localhost:8026/api/v1/pipeline/logs?projectId=1234&includeDaemon=true|false'
-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/logs?projectId=1234&includeDaemon=true|false

Response Fields

Code 200 - OK or Code 404 - Not Found or Code 500 - Internal Server Error
{
  "daemonLog": {
    "currentPage": 0,
    "lines": [
      "string"
    ],
    "totalPages": 0
  },
  "pipelineLog": {
    "currentPage": 0,
    "lines": [
      "string"
    ],
    "totalPages": 0
  }
}
Response Element Type Description
daemonLog responses.LogPageInfo
  • currentPage - integer
  • lines - string
  • totalPages - integer
  
pipelineLog responses.LogPageInfo
  • currentPage - integer
  • lines - string
  • totalPages - integer
  

Code 400 - Bad Request

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