Trigger 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 continuous replication pipelines in a project.

HTML

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

Process overview

  1. Validate caller has replication-pipeline::operate permission.
  2. Interpret request:
    1. pipelines omitted/empty then target all pipelines in latest deployed snapshot
    2. pipelines provided then forward as-is.
  3. If targeting all, fetch latest deployed snapshot and ensure at least one pipeline is available; fail otherwise.
  4. If action = START, optionally treat resumeRequest=true as warm/resume start; if STOP, ignore resumeRequest.
  5. Dispatch start or stop request through the portal client.
  6. 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 pipeline control (omit list for ALL, supply list for specific pipelines).
  • Warm/resume semantics for START via resumeRequest flag.
  • 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 pipelines should be acted upon.

Request body properties

Property Required Type Description
pipelines Yes array[string] Unique identifier of the project whose pipelines should be acted upon.
resumeRequest No boolean List of pipeline names on which the action should be applied. If this is not provided, the action will be applied to all pipelines associated with the project.
action Yes string Indicates whether this trigger is to resume a previously paused or failed request (idempotent retry).

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

Informational message describing the outcome of the submission.

Example: request START submitted
status No string

Overall submission status of the trigger request.

Example: Submitted

Response examples

{
  "pipelines": [
    "orders",
    "inventory"
  ],
  "action": "START",
  "resumeRequest": true
}
 
{
  "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}/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/continuous/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/continuous/monitoring/projects/{projectId}/pipelines/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}/pipelines/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}/pipelines/trigger",
  "properties": {
    "errorCode": "DI-ADAPTER-PIP-0003"
  }
}