Get mainframe pipelines by project ID - 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

Retrieves all mainframe data integration pipelines associated with a specific project with pagination and sorting.

HTML

GET https://hostname/v1/integration/mainframe/projects/{projectId}/pipelines

Features

Pagination support with configurable page size and number
Pipeline sorting by multiple properties
Optional section-based data loading for pipeline details
Project-specific pipeline filtering

Use cases

Browse mainframe pipelines within a specific project
Monitor pipeline status and configuration
Access pipeline details for management operations

Required permissions

replication-pipeline::view

Request

Path parameters

Key	Required	Type	Description
projectId	Yes	string

Query parameters

Key	Required	Type	Description
sections	No	array	Set of pipeline sections to include in the response. Allowed values: `[]` (empty): No sections selected Any combination of section `enums` except `ALL_SECTIONS` `[ALL_SECTIONS]` by itself
page	No	integer	Zero-based page index (`0..N`). Validation rules: Must be greater than or equal to 0 Default: 0 (first page) Examples: `page=0` (first page) `page=1` (second page) `page=5` (sixth page)
size	No	integer	The number of items to return per page. Validation Rules: Must be between 1 and 100 (inclusive). Default: 10 items per page. Values exceeding 100 will return a validation error/ Examples: `size=10` (10 items per page) `size=50` (50 items per page) `size=100` (maximum allowed)
sort	No	array	Sorting criteria with flexible format options. Multiple sort parameters supported for multi-level sorting. Sort order options: `asc`, sort in ascending order (default) `desc`, sort in ascending order Sort Format Options: `sort=property` (for example, `sort=name` defaults to ascending) `sort=property`,direction (for example, `sort=name,asc` or `sort=createdAt,desc`) `sort=property,asc,ignoreCase` (for case-insensitive sorting) Multi-level Sorting: `sort=property1,asc&sort=property2,desc` First sort criteria takes priority, subsequent criteria are used for tie-breaking/ Sort properties: `name`—Pipeline name `internalName`—Internal pipeline name `pipelineType`—Pipeline type `replicationType`—Replication type `pipelineState`—Pipeline state `committedAt`—Commit timestamp `deployedAt`—Deploy timestamp `validatedAt`—Validation timestamp `createdBy`—Creator user `modifiedBy`—Last modifier user `deployedBy`—Deployer user Note: Supported sort properties vary by endpoint. Check the specific endpoint documentation for the list of valid sort properties for that resource type. Examples: `"sort=name,asc"` (sort by name ascending) `"sort=createdAt,desc"` (sort by creation date descending) `"sort=type,asc&sort=name,asc"` (multi-level sort) `"sort=deployedAt,desc,ignoreCase"` (case-insensitive sort)

Response

Response body properties

Ancestors	Property	Required	Type	Description
	content	No	array[object]	List of pipelines in the current page.
content	id	No	string	Unique identifier of the mainframe pipeline. Example: `mainframe-pipeline-001`
content	name	No	string	Name of the mainframe pipeline. Example: `CustomerMainframePipeline`
content	internalName	No	string	Internal system name used for the pipeline. Example: `customer_mainframe_pipeline_internal`
content	agents	No	array[object]	Agents associated with this pipeline.
content/agents	type	No	string	Type of the mainframe agent. Example: `APPLY_ENGINE`
content/agents	name	No	string	Name of the agent. Example: `agent-1`
content	description	No	string	Description of the pipeline purpose and functionality. Example: `Synchronizes customer data from mainframe to cloud.`
content	pipelineType	No	string	Type of mainframe pipeline, defining its purpose and behavior.
content	replicationType	No	string	Type of mainframe replication. Example: `MAINFRAME_REPLICATION_TYPE_ENGINE`
content	runtimeEngineId	No	string	Identifier of the runtime engine associated with this pipeline. Example: `runtime-engine-123`
content	entryFileId	No	string	Identifier of the entry file for this pipeline. Example: `entry-file-abc`
content	configJsonFileId	No	string	Identifier of the configuration JSON file for this pipeline. Example: `config-json-xyz`
content	projectId	No	boolean	Identifier of the project to which this pipeline belongs. Example: `project-789`
content	autoStart	No	boolean	Flag indicating whether the pipeline should automatically start when deployed. Example: `true`
content	stagePipelineConfiguration	No	boolean	Flag indicating whether to stage the pipeline configuration Example: `true`
content	activatePipelineConfiguration	No	boolean	Flag indicating whether to activate the pipeline configuration. Example: `true`
content	pipelineState	No	string	Current state of the pipeline. Example: `PIPELINE_STATE_DEPLOYED_WITH_SUCCESS`
content	sourceDataConnectionId	No	string	Identifier of the data connection used as the source for this pipeline. Example: `source-conn-001`
content	targetDataConnectionId	No	string	Identifier of the data connection used as the target for this pipeline. Example: `target-conn-002`
content	selectedResources	No	object	Source and target resources selected for this pipeline.
content/selectedResources	source	No	object	Source assets selected for the pipeline.
content/selectedResources	target	No	object	Target assets selected for the pipeline.
content	cdcFieldMappings	No	object	Field mapping configuration for Change Data Capture operations
content/cdcFieldMappings	sourceMessageProducerFormat	No	string	Source message producer format.
content/cdcFieldMappings	fieldMappings	No	string	Field mappings for CDC.
content/cdcFieldMappings/fieldMappings	sourceField	No	string	Source field name. Example: `sv_sending_table`
content/cdcFieldMappings/fieldMappings	targetField	No	string	Target field name. Example: `Dataset name`
content/cdcFieldMappings/fieldMappings	valueMappings	No	object[string]	Value mappings for the field.
content	createdBy	No	string	User who created the pipeline. Example: `john.doe@example.com`
content	modifiedBy	No	string	User who last modified the pipeline. Example: `jane.smith@example.com`
content	deployedBy	No	string	User who deployed the pipeline. Example: `carol.white@example.com`
content	committedAt	No	string	Date and time when the pipeline was last committed. Example: `2025-11-06T09:17:47Z`
content	deployedAt	No	string	Date and time when the pipeline was last deployed. Example: `2025-11-06T10:00:00Z`
content	validatedAt	No	string	Date and time when the pipeline was last validated. Example: `2025-11-06T10:30:00Z`
content	tableMappings	No	array[object]	List of table mappings configured for this pipeline.
content/tableMappings	sourceDatabase	No	string	Name of the source database Example: `source-database`
content/tableMappings	sourceSchema	No	string	Name of the source schema Example: `source-schema`
content/tableMappings	sourceTable	No	string	Name of the source table Example: `source-table`
content/tableMappings	targetDatabase	No	string	Name of the target database/ Example: `target-database`
content/tableMappings	targetSchema	No	string	Name of the target schema. Example: `target-schema`
content/tableMappings	targetTable	No	string	Name of the target table. Example: `target-table`
content/tableMappings	targetTopic	No	string	Name of the target topic. Example: `target-topic`
content/tableMappings	targetSubject	No	string	Name of the target subject for schema registry. Example: `target-subject`
content/tableMappings	sourceSchemaCase	No	string	Case transformation to apply to source schema names. Default is NONE. Example: `NONE`
content/tableMappings	sourceTableCase	No	string	Case transformation to apply to source table names. Default is NONE. Example: `NONE`
content/tableMappings	sourceColumnCase	No	string	Case transformation to apply to source column names. Default is NONE. Example: `NONE`
	pageNumber	No	integer	Zero-based page number. Example: `0`
	pageSize	No	integer	Number of items per page (requested size). Example: `20`
	numberOfElements	No	integer	Actual number of pipelines in the current page. Example: `15`
	totalElements	No	integer	Total number of pipelines across all pages. Example: `157`
	totalPages	No	integer	Total number of pages available. Example: `8`
	first	No	boolean	Indicates if this is the first page. Example: `true`
	last	No	boolean	Indicates if this is the last page. Example: `false`

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

{
  "content": [
    {
      "id": "mainframe-pipeline-001",
      "name": "CustomerMainframePipeline",
      "internalName": "customer_mainframe_pipeline_internal",
      "agents": [
        {
          "type": "APPLY_ENGINE",
          "name": "agent-1"
        }
      ],
      "description": "Synchronizes customer data from mainframe to cloud.",
      "pipelineType": "ENGINE_KAFKA",
      "replicationType": "ENGINE",
      "runtimeEngineId": "runtime-engine-123",
      "entryFileId": "entry-file-abc",
      "configJsonFileId": "config-json-xyz",
      "projectId": "project-789",
      "autoStart": true,
      "stagePipelineConfiguration": true,
      "activatePipelineConfiguration": true,
      "pipelineState": "DEPLOYED_WITH_SUCCESS",
      "sourceDataConnectionId": "source-conn-001",
      "targetDataConnectionId": "target-conn-002",
      "selectedResources": {
        "source": {
          "topics": [
            "topicA",
            "topicB"
          ]
        },
        "target": {
          "schemasAndTables": [
            {
              "schema": "target-schema",
              "tables": [
                "target-table1",
                "target-table2"
              ]
            }
          ]
        }
      },
      "cdcFieldMappings": {
        "sourceMessageProducerFormat": "custom",
        "fieldMappings": [
          {
            "sourceField": "sv_sending_table",
            "targetField": "Dataset name",
            "valueMappings": {
              "additionalProp1": "string",
              "additionalProp2": "string",
              "additionalProp3": "string"
            }
          }
        ]
      },
      "createdBy": "john.doe@example.com",
      "modifiedBy": "jane.smith@example.com",
      "deployedBy": "carol.white@example.com",
      "committedAt": "2025-11-06T09:17:47Z",
      "deployedAt": "2025-11-06T10:00:00Z",
      "validatedAt": "2025-11-06T10:30:00Z",
      "tableMappings": [
        {
          "sourceSchema": "source-schema",
          "sourceTable": "source-table1",
          "targetSchema": "target-schema",
          "targetTable": "target-table1",
          "sourceSchemaCase": "UPPER_CASE",
          "sourceTableCase": "LOWER_CASE",
          "sourceColumnCase": "TOGGLE_CASE"
        },
        {
          "sourceSchema": "source-schema",
          "sourceTable": "source-table2",
          "targetSchema": "target-schema",
          "targetTable": "target-table2",
          "sourceSchemaCase": "UPPER_CASE",
          "sourceTableCase": "LOWER_CASE",
          "sourceColumnCase": "TOGGLE_CASE"
        }
      ]
    }
  ],
  "pageNumber": 0,
  "pageSize": 20,
  "numberOfElements": 15,
  "totalElements": 157,
  "totalPages": 8,
  "first": true,
  "last": false
}

{
  "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/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-VAL-0000"
  }
}

{
  "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/projects/{projectId}/pipelines",
  "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/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-PRJ-0005"
  }
}

{
  "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/mainframe/projects/{projectId}/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/mainframe/projects/{projectId}/pipelines",
  "properties": {
    "errorCode": "DI-ADAPTER-DFL-0001"
  }
}