Trigger start/stop actions for mainframe pipelines - 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

Submits an asynchronous lifecycle action (START or STOP) for one or more mainframe pipelines in a project.

HTML

POST https://hostname/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger

Use the /logs and /status API to monitor the pipeline execution logs.

Process overview

  1. Validate that all specified pipeline IDs belong to the given project.
  2. Dispatch the start/stop action asynchronously.
  3. Build 202 response with body status (SUBMITTED if dispatch succeeded, FAILED if an internal exception occurred).

Key features

  • Targeted pipeline control (supply specific pipeline IDs).
  • Uniform 202 response; body-level status differentiates dispatch success vs failure.
  • Monitor pipeline execution using the /logs and /status API.

Required permissions

replication-pipeline::operate

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project whose pipelines should be acted upon.

Request body properties

Property Required Type Description
pipelines Yes array  
action Yes string

This property is an enumerated string type (enum) set to one of these values:

  • START
  • STOP

Request body example

"pipelines":"pipelineId1",
"pipelines":"pipelineId2",
"action":"START"

Response

A 202 Accepted response indicates the request was validated and dispatched (not that execution is complete). The response body contains a status field (SUBMITTED or FAILED).

Response body properties

Ancestors Property Required Type Description
  message No string  
  status No string

This property is an enumerated string type (enum) set to one of these values:

  • Submitted
  • InProgress
  • Completed
  • Partial
  • Failed
  • Cancelled

Response examples

Example status code responses for this method are shown here.

Examples
"message": "request START submitted",
"status": "Submitted"
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": "400",
"detail": "Validation error occurred",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-VAL-0000"}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": "401",
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0001"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": "403",
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0002"
}
 
"message": "Failed to dispatch trigger request",
"status": "Failed"
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": "500",
"detail": "An unexpected error occurred",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-MFD-0012"
}