Monitor and Trigger Continuous Integration Projects

Trigger start/stop actions for capture

Submits an asynchronous lifecycle action (START or STOP) for capture operations on all or specified table identifiers in a pipeline. 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) and the Location header points to the alerts endpoint for monitoring.

Process Overview:

Validate caller has replication-pipeline::operate permission.
If table identifiers omitted/empty, action applies to all table identifiers in the pipeline.
Dispatch start or stop request through the portal client.
Build 202 response with body status (SUBMITTED if dispatch succeeded, FAILED if an internal exception occurred) and Location header to alerts.

Key Features:

Bulk or targeted capture control (omit table identifiers for ALL, supply list for specific table identifiers).
Uniform 202 response; body-level status differentiates dispatch success vs failure.
Immediate monitoring path via Location header (/projects/{projectId}/alerts) for a successfully submitted request.
Idempotent friendly: client can safely retry on FAILED since execution had not been confirmed.

Required Permissions: replication-pipeline::operate

post/v1/integration/continuous/monitoring/projects/{projectId}/capture/trigger

Request

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

Path parameters

projectIdstring required

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

Request body

pipelinestring required

Name of the pipeline for which the capture operation should be triggered.

action'START' | 'STOP' required

Action to perform on the capture operation.

Example request

{
  "tables": [
    {
      "database": "my_database",
      "schema": "public",
      "table": "orders"
    }
  ],
  "action": "START"
}

Response

Accepted. Body status field indicates SUBMITTED or FAILED; If the request is properly submitted, Location header points to alerts endpoint.

messagestring

Informational message describing the outcome of the submission.

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.