Generate mainframe application scripts - 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

Generates the mainframe pipeline scripts for a given pipeline.

HTML

POST https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/application

Process Overview

  1. Request Validation—Validates pipeline ID and parameters.
  2. Script Generation—Generates the mainframe application scripts.
  3. Response—Returns success status and message.

Key features

  • Supports case transformation for object names.
  • Optional force regeneration.
  • Variable usage for schema.

Use cases

  • Generate mainframe scripts for a pipeline.
  • Re-generate scripts with updated configurations.

Required permissions

replication-pipeline::manage

Request

Path parameters

Key Required Type Description
projectId Yes string

Unique identifier of the project.
pipelineId Yes string

Unique identifier of the pipeline.

Query parameters

Key Required Type Description
forceRegeneration No boolean

Force regeneration even if scripts already exist.

When true, regenerates scripts even if they already exist. When false (default), skips regeneration if scripts are already present.
useSchemaVariables No boolean

Use variables for schema references.

When true (default), uses variables for schema references in generated scripts. When false, uses hard-coded schema names.
sourceObjectCase No string

Case transformation for source object names.

Applies case transformation to source object names (schemas, tables, columns) in the generated scripts. Options include NONE, MATCH_ORIGINAL_CASE, SENTENCE_CASE, LOWER_CASE, UPPER_CASE, TOGGLE_CASE, CAPITALIZE_EACH_WORD.
targetObjectCase No string

Case transformation for target object names.

Applies case transformation to target object names (schemas, tables, columns) in the generated scripts. The options for this parameter are the same as sourceObjectCase.

Response

Response body properties

Property Required Type Description
success No boolean

Indicates whether the application generation was successful.
statusMessage No boolean

Status message providing details about the generation result.

Response body examples

Example status code responses for this method are shown here. To view the response schemas, you can download the Data Integration API specification (Precisely Integration Adapter Service) from the Precisely Developer Portal.

Examples
{
  "success": true,
  "statusMessage": "Application generated successfully."
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Validation error occurred",
  "instance": "/v1/integration/mainframe/dataflows/{pipelineId}/application",
  "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/mainframe/dataflows/{pipelineId}/application",
  "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/mainframe/dataflows/{pipelineId}/application",
  "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/mainframe/dataflows/{pipelineId}/application",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0007"
  }
}
 
{
  "type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.9",
  "title": "Conflict",
  "status": 409,
  "detail": "Mainframe pipeline script already exists for the given pipeline",
  "instance": "/v1/integration/mainframe/dataflows/{pipelineId}/application",
  "properties": {
    "errorCode": "DI-ADAPTER-MFD-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/mainframe/dataflows/{pipelineId}/application",
  "properties": {
    "errorCode": "DI-ADAPTER-MFD-0004"
  }
}