Create project and pipeline - 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

Creates a new continuous data integration pipeline with specified configuration parameters.

HTML

POST https://hostname/v1/integration/continuous/pipelines

Process overview

  1. Project Verification—Validates or creates the specified project.
  2. Pipeline Creation—Creates the pipeline with provided configuration.
  3. Connection Association—Links source and target connections to the pipeline.
  4. Configuration Application—Applies data flow type and properties.
  5. Validation & Persistence—Validates and saves the complete configuration.

Supported Pipeline Types:

  • COPY - One-time data copy operation
  • REPLICATE - Continuous data replication
  • SYNCHRONIZE - Bidirectional data synchronization
  • AUDIT - Data audit and compliance tracking

Required permissions

replication-pipeline::manage

Request

Request body properties

Property Required Type Description
projectName   string The name of the project that will contain this replication pipeline. A project contains a collection of replication pipelines.
pipelineName   string The name of the replication pipeline to be created. A replication pipeline is a collection of data transfer tasks that filters and transfers data to a specified target.
description Yes string Description of the replication pipeline.
pipelineType Yes string The type of replication pipeline. Can be COPY (one-time copy), REPLICATE (continuous replication), SYNCHRONIZE (copy then replicate) or AUDIT (auditing data changes).
sourceConnectionId Yes string The ID of the source data connection to use for the pipeline. A data connection contains information on how to access the database or data source along with the required credentials.
targetConnectionId Yes string The ID of the target data connection to use for the pipeline. A data connection contains information on how to access the database or data along with the required credentials.
properties   object[string] Additional configuration properties for the replication pipeline, such as row filters, settings, or process-specific options

Request body

{
  "projectName": "data-integration-project",
  "pipelineName": "customer-data-sync",
  "description": "Pipeline for synchronizing customer data between systems",
  "pipelineType": "SYNCHRONIZE",
  "sourceConnectionId": "conn-src-uuid",
  "targetConnectionId": "conn-tgt-uuid",
  "properties": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Response

Response body properties

Property Required Type Description
projectIdstring Required string ID of the project containing the pipeline. This is the project that was either found or created during the pipeline creation process.
pipelineId Required string ID of the created pipeline. This identifier can be used to query the pipeline status, modify its configuration, or manage its lifecycle.

Response examples

{
  "projectId": "data-integration-project-id-123",
  "pipelineId": "customer-data-synchronization-pipeline-456"
}
 
{
  "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/pipelines",
  "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/pipelines",
  "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/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-AUT-0002"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Unprocessable Entity - Request is syntactically correct but semantically invalid",
  "instance": "/v1/integration/continuous/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0001"
  }
}
 
{
  "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/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0004"
  }
}