---
title: "Get mainframe project by ID"
method: GET
path: "/v1/integration/mainframe/projects/{projectId}"
tags: ["Build and Configure Mainframe Integration Projects"]
---

# Get mainframe project by ID

`GET /v1/integration/mainframe/projects/{projectId}`

## Request

- Base URL: `https://integration-adapter.connect.cloud.precisely.com`
- URL: `https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/projects/{projectId}`
- Auth: HTTP bearer

Retrieves a specific mainframe data integration project by its unique identifier.

**Features:**
- Complete project information including metadata and configuration
- Optional pipeline details inclusion
- Project existence validation
- Access control enforcement

**Response Content:**
- Project metadata (name, description, type, timestamps)
- User information (creator, last modifier)
- Optional pipeline details if requested

**Use Cases:**
- View detailed mainframe project information
- Check mainframe project configuration and status
- Access project-specific pipeline details

**Required Permissions:** `replication-pipeline::view`

## Path parameters

- `projectId` string, required

## Query parameters

- `includePipelines` boolean

## Response `200`

Successfully retrieved mainframe project details

- ProjectResponse: Response model containing project information
  - `id` string: Unique identifier of the project
  - `name` string: Name of the project
  - `description` string: Description of the project
  - `projectType` 'REPLICATION' | 'MAINFRAME_REPLICATION' | 'ADVANCED_REPLICATION': Type of the project (e.g. COPY, REPLICATION, MAINFRAME_REPLICATION)
  - `createdAt` string, date-time: Timestamp when the project was created
  - `createdBy` string: Username of the person who created the project
  - `modifiedAt` string, date-time: Timestamp when the project was last modified
  - `modifiedBy` string: Username of the person who last modified the project
  - `committedAt` string, date-time: Timestamp when the project was last committed
  - `committedBy` string: Username of the person who committed the project
  - `deployedAt` string, date-time: Timestamp when the project was last deployed
  - `deployedBy` string: Username of the person who deployed the project
  - `parameters` object: Configuration parameters for the project
  - `validationSummary` ProjectValidationSummaryResponse: Project-level validation summary for Advanced Replication projects
    - `status` 'OPEN' | 'INPROGRESS' | 'SUCCESS' | 'COMPLETED' | 'TIMEOUT' | 'ERROR': Overall validation status
    - `message` string: Overall validation message
    - `lastValidatedAt` string, date-time: Timestamp of the latest validation run
    - `scopeStatuses` ProjectValidationScopeSummaryResponse[]: Per-scope validation status summary (DSL_ONLY, FULL)
      - `scope` 'DSL_ONLY' | 'FULL': Scope name
      - `status` 'STARTED' | 'INPROGRESS' | 'SKIPPED' | 'PASSED' | 'FAILED' | 'PASSED_WITH_WARNINGS': Validation status for this scope
      - `message` string: Scope-specific summary message
  - `pipelines` ContinuousPipelineResponse[]: List of Continuous Pipelines associated with this project
    - `id` string: Unique identifier of the pipeline
    - `name` string: Name of the pipeline
    - `description` string: Description of the pipeline
    - `pipelineType` 'SYNCHRONIZE' | 'REPLICATE' | 'COPY': Type of the pipeline (e.g. COPY, REPLICATE, SYNCHRONIZE)
    - `projectId` string: Unique identifier of the project containing this pipeline
    - `source` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `target` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `staging` ConnectionResponse: Data connection details used in pipelines
      - `id` string: Unique identifier of the connection
      - `name` string: Human readable connection name
      - `type` string: Connection type (e.g., DB2I, KAFKA, BIGQUERY)
      - `parameters` object: Connection configuration parameters as key-value pairs
    - `userDatabases` UserDatabaseResponse[]: List of user databases prepared for this pipeline
      - `name` string: Name of the user database
      - `dataConnectionId` string: Identifier of the data connection backing the user database
    - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for all default table mappings in this pipeline
    - `createdAt` string, date-time: Timestamp when the pipeline was created
    - `properties` object: Additional configuration properties for the pipeline
    - `createdBy` string: Username of the pipeline owner
    - `modifiedAt` string, date-time: Timestamp when the pipeline was last modified
    - `modifiedBy` string: Username of the person who last modified the pipeline
    - `tableMappings` ContinuousTableMappingResponse[]: List of table mappings configured for this pipeline
      - `id` string: Unique identifier of the table mapping
      - `sourceDatabase` string: Name of the source database
      - `sourceSchema` string: Name of the source schema
      - `sourceTable` string: Name of the source table
      - `targetDatabase` string: Name of the target database
      - `targetSchema` string: Name of the target schema
      - `targetTable` string: Name of the target table
      - `targetTopic` string: Name of the target topic
      - `targetSubject` string: Name of the target subject for schema registry
      - `type` 'TARGET_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITH_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'BOTH_TARGET_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_DOES_NOT_EXIST_AND_SUBJECT_EXISTS_WITHOUT_MATCH' | 'TARGET_EXISTS_WITH_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'TARGET_EXISTS_WITHOUT_MATCH_AND_SUBJECT_DOES_NOT_EXIST' | 'BOTH_TARGET_AND_SUBJECT_DOES_NOT_EXIST': Type of the table mapping
      - `hasCustomColMappings` boolean: Flag indicating whether the table has custom column mappings
      - `includedCDCRowMetadata` string[]: Metadata fields to include with change data records for this table mapping configuration, this overrides the Metadata fields defined at the pipeline level
      - `schemaVersion` string: Version of the schema used for this mapping
      - `softDeleteColumnName` string: Name of the column used for soft deletes
      - `columnMappings` ColumnMappingResponse[]: List of column mappings for this table
        - `sourceColumnName` string: Name of the source column
        - `targetColumnName` string: Name of the target column
        - `sourceColType` string: Data type of the source column
        - `targetColType` string: Data type of the target column
        - `isDistributionKey` boolean: Flag indicating if this column is used as a distribution key
        - `action` 'Copy' | 'Ignore' | 'SoftDelete': Action to be performed for this column mapping
        - `state` 'TARGET_COLUMN_DATATYPE_NOT_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_SUPPORTED' | 'BOTH_TARGET_AND_SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'SOURCE_COLUMN_DATATYPE_SUPPORTED' | 'TARGET_AND_SOURCE_COLUMN_DATATYPE_NOT_COMPATIBLE' | 'NOT_CHECKED': Current state of the column mapping
        - `sourceColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the source column
        - `targetColumnNullableState` 'NULLABLE_WITH_DEFAULT_VALUE' | 'NULLABLE_WITHOUT_DEFAULT_VALUE' | 'NON_NULLABLE_WITH_DEFAULT_VALUE' | 'NON_NULLABLE_WITHOUT_DEFAULT_VALUE': Nullable state of the target column
        - `metadataMapping` boolean: Flag indicating if this is a change data records metadata mapping
        - `mappingType` 'FIELD' | 'EXPRESSION' | 'RRN': Type of mapping if this is FIELD / EXPRESSION / RRN
  - `advancedPipelines` AdvancedPipelineResponse[]: Read-only Advanced Replication pipelines associated with this project
    - `id` string: Persisted pipeline row identifier
    - `name` string: Pipeline name
    - `description` string: Pipeline description
    - `type` 'SYNCHRONIZE' | 'REPLICATE' | 'COPY': Advanced pipeline type
    - `runOnHost` string: Runtime host selected for the pipeline, when present
    - `sourceFile` string: Catalog-relative DSL source file path
    - `line` integer: Line number of the pipeline declaration in the DSL source file
    - `column` integer: Column number of the pipeline declaration in the DSL source file
    - `validationStatus` 'STARTED' | 'INPROGRESS' | 'SKIPPED' | 'PASSED' | 'FAILED' | 'PASSED_WITH_WARNINGS': High-level validation status for the pipeline
    - `validationMessage` string: Short validation summary message for the pipeline
    - `lastValidatedAt` string, date-time: Timestamp of the most recent validation touching this pipeline
  - `mainframePipelines` MainframePipelineResponse[]: List of Mainframe Pipelines associated with this project
    - `id` string: Unique identifier of the mainframe pipeline
    - `name` string: Name of the mainframe pipeline
    - `internalName` string: Internal system name used for the pipeline
    - `agents` MainframeAgent[]: Agents associated with this pipeline
      - `type` 'APPLY_ENGINE' | 'STREAM_PUBLISHER' | 'REPLICATOR': Type of the mainframe agent.
      - `name` string: Name of the agent.
    - `description` string: Description of the pipeline purpose and functionality
    - `pipelineType` 'NONE' | 'ENGINE_VSAM' | 'ENGINE_IMS' | 'ENGINE_DB2' | 'ENGINE_KAFKA' | 'REPLICATOR_VSAM' | 'REPLICATOR_IMS' | 'REPLICATOR_DB2' | 'REPLICATOR_DEFAULT': Type of mainframe pipeline, defining its purpose and behavior
    - `replicationType` 'ENGINE' | 'REPLICATOR': Type of mainframe replication
    - `runtimeEngineId` string: Identifier of the runtime engine associated with this pipeline
    - `entryFileId` string: Identifier of the entry file for this pipeline
    - `configJsonFileId` string: Identifier of the configuration JSON file for this pipeline
    - `projectId` string: Identifier of the project this pipeline belongs to
    - `autoStart` boolean: Flag indicating whether the pipeline should automatically start when deployed
    - `stagePipelineConfiguration` boolean: Flag indicating whether to stage the pipeline configuration
    - `activatePipelineConfiguration` boolean: Flag indicating whether to activate the pipeline configuration
    - `pipelineState` 'UNKNOWN' | 'CREATING' | 'CREATED' | 'EDITED' | 'STAGED_WITH_SUCCESS' | 'STAGED_WITH_ERROR' | 'DEPLOYED_WITH_SUCCESS': Current state of the pipeline
    - `sourceDataConnectionId` string: Identifier of the data connection used as the source for this pipeline
    - `targetDataConnectionId` string: Identifier of the data connection used as the target for this pipeline
    - `selectedResources` MainframeSelectedResources: Selected resources for mainframe pipeline, including source and target assets.
      - `source` SelectedAssets: Assets selected for a mainframe endpoint, including database, schemas/tables, and topics.
        - `database` string: Name of the selected database.
        - `schemasAndTables` SchemaTables[]: List of selected schemas and associated tables.
          - `schema` string, required: Selected schema.
          - `tables` string[], required: List of selected tables in the schema.
        - `topics` string[]: List of selected topics.
      - `target` SelectedAssets: Assets selected for a mainframe endpoint, including database, schemas/tables, and topics.
        - `database` string: Name of the selected database.
        - `schemasAndTables` SchemaTables[]: List of selected schemas and associated tables.
          - `schema` string, required: Selected schema.
          - `tables` string[], required: List of selected tables in the schema.
        - `topics` string[]: List of selected topics.
    - `cdcFieldMappings` CDCFieldMappings: CDC field mapping configuration
      - `sourceMessageProducerFormat` 'custom' | 'precisely_replication' | 'debezium', required: Source message producer format
      - `fieldMappings` FieldMapping[], required: Field mappings for CDC
        - `sourceField` string: Source field name
        - `targetField` string, required: Target field name
        - `valueMappings` object: Value mappings for the field
    - `createdBy` string: User who created the pipeline
    - `modifiedBy` string: User who last modified the pipeline
    - `deployedBy` string: User who deployed the pipeline
    - `committedAt` string, date-time: Date and time when the pipeline was last committed
    - `deployedAt` string, date-time: Date and time when the pipeline was last deployed
    - `validatedAt` string, date-time: Date and time when the pipeline was last validated
    - `tableMappings` MainframeTableMappingResponse[]: List of table mappings configured for this pipeline
      - `id` string: Unique identifier of the table mapping
      - `sourceDatabase` string: Name of the source database
      - `sourceSchema` string: Name of the source schema
      - `sourceTable` string: Name of the source table
      - `targetDatabase` string: Name of the target database
      - `targetSchema` string: Name of the target schema
      - `targetTable` string: Name of the target table
      - `targetTopic` string: Name of the target topic
      - `targetSubject` string: Name of the target subject for schema registry
      - `sourceSchemaCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source schema names. Default is NONE.
      - `sourceTableCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source table names. Default is NONE.
      - `sourceColumnCase` 'NONE' | 'MATCH_ORIGINAL_CASE' | 'SENTENCE_CASE' | 'LOWER_CASE' | 'UPPER_CASE' | 'TOGGLE_CASE' | 'CAPITALIZE_EACH_WORD': Case transformation to apply to source column names. Default is NONE.
  - `metabases` MetabaseResponse[]: List of Metabases associated with this project
    - `name` string: Name of the Metabase instance
    - `version` string: Version of the Metabase instance
    - `dataConnectionId` string: Unique identifier of the associated data connection
    - `vaultConnectionId` string: Unique identifier of the associated vault connection
    - `parameters` object: Additional configuration parameters for the Metabase instance
  - `logreaders` LogReaderResponse[]: List of Log Readers(Change Selectors) associated with this project
    - `name` string: Name of the Log Reader (Change Selector)
    - `journal` string: Journal name used for log processing
    - `dataConnectionId` string: Unique identifier of the associated data connection
    - `logReaderId` integer: LogReader identifier
    - `parameters` object: Additional configuration parameters for the Log Reader

## Other responses

- `400`: Bad Request - Validation failed due to one of the following reasons: - Invalid project ID format - Missing required parameters
- `401`: Unauthorized - Authentication required, valid credentials not provided
- `403`: Forbidden - User lacks 'replication-pipeline::view' permission
- `404`: Not Found - Project with the specified ID does not exist
- `500`: Internal Server Error - Server encountered an unexpected condition, such as: - Project retrieval failure (ProjectsRetrievalFailedException) - Connect Portal service client errors - Service unavailability - Internal processing failures

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)