Monitor and Trigger Continuous Integration Projects

Trigger clear operation for backlog rows

Submits an asynchronous clear operation for backlog rows associated with a pipeline 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) and the Location header points to the alerts endpoint for monitoring.

Process Overview:

  • Validate caller has replication-pipeline::operate permission.
  • Validate that action is CLEAR and pipeline is specified.
  • If forced is true, forcibly clear all backlog rows (may result in data loss for unreplicated rows).
  • Dispatch clear 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:

  • Targeted backlog clear operation for a specific pipeline.
  • Forced clear option for data loss scenarios.
  • 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}/backlog/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}/backlog/trigger
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project whose backlog rows should be cleared.

Request body

pipelinestring required

Name of the pipeline for which backlog rows should be cleared.

forcedboolean

Set to true to force the clear operation. When forced, all backlog rows that have not been replicated for any data connection in the pipeline will be deleted. This may result in data loss.

action'CLEAR' required

Action to perform on the backlog rows.

Example request

{
  "action": "CLEAR"
}

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.

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.