Get database creation status - 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

Fetches the status of an asynchronous target dataset creation task for the specified pipeline.

HTML

GET https://hostname/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/datasets/status

Behavior & semantics

  • The endpoint returns a DatasetCreationStatusResponse describing the overall creation status and per-schema details (total, success, in-progress, failed) and any per-table errors.
  • Allowed type values: currently TABLE only. This value determines which creation workflow status is returned.
  • The status returned is authoritative from the back-end table-creation service that performs the asynchronous work.

Usage & polling guidance

  • Poll the endpoint returned in the POST response `Location` header, or call this endpoint directly to monitor progress. Use exponential backoff when polling frequently to avoid overwhelming the back-end service.
  • Once the overall `status` becomes `SUCCESS` or `FAILED`, the creation is considered terminal.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project containing the pipeline.
pipelineId Yes string

Unique identifier of the pipeline.

Query parameters

Key Required Type Description
type Yes string

The type of dataset creation task for which to check status.

Response

Response body properties

Ancestors Property Type Description
  status string

Overall status of the dataset creation process.

The status (overall) is one of SUCCESS, PENDING, IN_PROGRESS, FAILED

  • SUCCESS: all tables for the requested schemas were created successfully.
  • IN_PROGRESS / PENDING: creation is still ongoing for one or more schemas.
  • FAILED: creation failed for all requested tables/schemas.
  • schemaDetails: per-target schema breakdown including counts and a list of per-table errors (if any). Use these details to diagnose failures.
  schemaDetails array[object]

Details of the target schema where tables are being created. for type TABLE.
schemaDetails schemaName string

List of target table details, including source/target schema and table names.
schemaDetails status string

Details of the source table.
schemaDetails totalCount integer

Total number of tables to be created.
schemaDetails successCount integer

Number of tables successfully created.
schemaDetails inProgressCount integer

Number of tables currently in progress of being created.
schemaDetails failedCount integer

Number of tables that failed to be created.
schemaDetails errors array[object]

List of error messages if any tables failed to be created.

Response examples

{
  "status": "IN_PROGRESS",
  "schemaDetails": [
    {
      "schemaName": "TESTSCHEMA",
      "status": "IN_PROGRESS",
      "totalCount": 4,
      "successCount": 1,
      "inProgressCount": 2,
      "failedCount": 1,
      "errors": []
    }
  ]
}
 
{
  "status": "IN_PROGRESS",
  "schemaDetails": [
    {
      "schemaName": "TESTSCHEMA",
      "status": "IN_PROGRESS",
      "totalCount": 4,
      "successCount": 1,
      "inProgressCount": 2,
      "failedCount": 1,
      "errors": []
    }
  ]
}
 
{
  "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}/datasets/status",
  "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}/datasets/status",
  "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}/datasets/status",
  "properties": {
    "errorCode": "DI-ADAPTER-DTS-0004"
  }
}
 
{
  "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}/datasets/status",
  "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}/datasets/status",
  "properties": {
    "errorCode": "DI-ADAPTER-DTS-0005"
  }
}