Monitor and Trigger Mainframe Integration Projects

Trigger start/stop actions for mainframe pipelines

Submits an asynchronous lifecycle action (START or STOP) for one or more mainframe pipelines in a project. 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). Use the /logs and /status API to monitor the pipeline execution logs.

Process Overview:

  • Validate that all specified pipeline IDs belong to the given project.
  • Dispatch the start/stop action asynchronously.
  • 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

post/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/trigger
  • Auth: HTTP bearer

Path parameters

projectIdstring required

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

Request body

pipelinesstring[] required

List of pipeline IDs on which the action should be applied.

action'START' | 'STOP' required

Action to perform on the specified pipelines.

Example request

{
  "pipelines": [
    "pipelineId1",
    "pipelineId2"
  ],
  "action": "START"
}

Response

Accepted - Trigger request submitted successfully

messagestring

Informational message describing the outcome of the submission.

status'Submitted' | 'InProgress' | 'Completed' | 'Partial' | 'Failed' | 'Cancelled'

Overall submission status of the trigger request.

Example response

{
  "message": "request START submitted",
  "status": "Submitted"
}

Changes

No recorded changes to this operation across all 1 revision of this API.