Trigger clear operation for backlog rows - 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 clear operation for backlog rows associated with a pipeline in a project.

HTML

POST https://hostname/v1/integration/continuous/monitoring/projects/{projectId}/backlog/trigger

Process Overview

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

Request

Path parameters

Key Required Type Description
projectId Yes string

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

Request body properties

Property Required Type Description
pipeline Yes string
  • Minimum length: 1 characters
forced No boolean

This property may be set to true or false.
action Yes string

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

  • CLEAR

Request body example

"pipeline": "orders",
"forced": "true",
"action": "CLEAR"

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) and the Location header points to the alerts endpoint for monitoring.

Header keys

Key Required Type Description
Location No string URL of the project alerts endpoint for monitoring post-trigger alerts.

Response body properties

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 CLEAR 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/continuous/monitoring/projects/{projectId}/backlog/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/continuous/monitoring/projects/{projectId}/backlog/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/continuous/monitoring/projects/{projectId}/backlog/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-AUT-0002"
}
 
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": "404",
"detail": "Not Found - Resource does not exist",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/backlog/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-PRJ-0005"
}
 
"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/continuous/monitoring/projects/{projectId}/backlog/trigger",
"properties": {
  "errorCode": "DI-ADAPTER-BLT-0001"
}