Build and Configure Mainframe Integration Projects

Rename mainframe files or directories

Rename one or more mainframe files or directories in the specified pipeline. Supports conflict resolution strategies.

Process Overview:

  1. Request Validation - Validates file/directory identifiers
  2. Conflict Detection - Checks for naming conflicts with existing files or directories
  3. Resolution Strategy - Applies specified conflict resolution (REPLACE_ALL, IGNORE_ALL, PARTIAL)
  4. Rename Execution - Performs the rename operation(s)
  5. Response Generation - Returns results with success/failure details per file or directory

Conflict Resolution Strategies:

  • REPLACE_ALL - Replace all existing files or directories with conflicting names
  • IGNORE_ALL - Skip all files or directories with conflicting names
  • PARTIAL - Replace only provided in replaceFiles list, other conflicts are ignored

Key Features:

  • Batch rename support for multiple files and directories
  • Comprehensive error reporting with failure reasons

Required Permissions: replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.

put/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/rename

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/files/rename
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project

pipelineIdstring required

Unique identifier of the pipeline

Query parameters

conflictResolution'REPLACE_ALL' | 'IGNORE_ALL' | 'PARTIAL'

Conflict resolution strategy to use when name conflicts occur:

  • REPLACE_ALL: Replace all existing files with conflicting names
  • IGNORE_ALL: Skip all files with conflicting names
  • PARTIAL: Replace only files specified in the replaceFiles list; other conflicts are ignored

Request body

replaceFilesstring[]

List of files to be replaced during the operation. only applicable for PARTIAL conflict resolution.

Response

Files renamed or cloned successfully

filesCreatedstring[]

List of files that were renamed during the operation.

filesRenamedstring[]

List of files that were renamed during the operation.

filesConflictedstring[]

List of files that were conflicted during the operation.

filesUpdatedstring[]

List of files that were updated during the operation.

filesDeletedstring[]

List of files that were deleted during the operation.

filesIgnoredstring[]

List of files that were ignored during the operation.

errorsstring[]

List of error messages encountered during the operation.

Changes

No recorded changes to this operation across all 1 revision of this API.