Suggest source assets - 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

Suggests source assets (DATABASE, SCHEMA, TABLE, TOPIC, KAFKA_SCHEMA) matching the provided search patterns for a pipeline.

HTML

POST https://hostname/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/suggest/source

Process overview

  1. Input Validation—Validates input parameters and permissions.
  2. Asset Discovery—Matches cataloged assets using provided regex patterns.
  3. Detailed Response—Returns full asset path details for the matching source resources.

Supported asset types

  • DATABASE—RDBMS database assets
  • SCHEMA—RDBMS schema assets
  • TABLE—RDBMS table assets
  • TOPIC—Kafka topic assets
  • KAFKA_SCHEMA—Schema Registry subject assets

Use cases

  • Source asset selection and validation during pipeline setup.
  • Interactive workflows for asset discovery and filtering.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

The unique identifier of the project containing the pipeline.
pipelineId Yes string

The unique identifier of the pipeline for which assets have to be selected.

Query parameters

Key Required Type Description
type Yes string Type of source asset to match

Request body example

{
   "database":"sales_db",
   "schema":"",
   "patterns":"order_.*",
   "patterns":"customer_.*"
}

Request body properties

Property Required Type Description
database No string Database name for schema/table matching.
schema No string Schema name for table matching.
patterns Yes array[string] List of regex patterns for matching assets.

Response

Response body properties

Property Required Type Description
database No string

Database name (for RDBMS assets)

Example: "db1"
schema No string

Schema name (for RDBMS assets)

Example: "public"
table No string

Table name (for RDBMS assets)

Example: "users"
journal No string

Journal name (for DB2I/DB2ZOS RDBMS assets)

Example: "user/journal"
topic No No

Kafka topic name (for Kafka assets)

Example: "user-events"
subject No string

Schema Registry subject (for Schema Registry assets)

Example: "users-value"

Response examples

Example status code responses for this method are shown here.

Examples
{
   "database":"sales_db",
   "schema":"",
   "table":"order_2023",
   "journal":"order/journal"
}
 
{
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "properties":{
     "errorCode":"DI-ADAPTER-MAP-0006"}
}
 
{
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "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/projects/{projectId}/pipelines/{pipelineId}/suggest/source",
   "properties":{
     "errorCode":"DI-ADAPTER-MAP-0007"}
}