Unified Project Lifecycle APIs

Rename or clone project files

Renames or clones one or more project files in a single request, for either an Advanced Replication (DSL) project or a Mainframe Replication pipeline.

Features:

  • action=RENAME moves each matched file to its new path and removes it from the old path; action=CLONE copies each matched file to the new path and leaves the original in place.
  • Each entry's currentFilePath/newFilePath can target a single file, or — when pathPrefix=true on that entry — every file under a path prefix (for example renaming an entire sources/ folder to sources-legacy/ in one call).
  • conflictResolution (Mainframe Replication only) controls what happens when a computed target path already exists: REPLACE_ALL overwrites every conflicting target, IGNORE_ALL skips every conflicting entry and reports it, PARTIAL applies the non-conflicting entries and reports the rest. Advanced Replication always reports conflicts individually instead.

Use Cases:

  • VS Code extension renames a file via the project explorer.
  • User duplicates a template file to bootstrap a new source definition.

Authorization: Requires replication-pipeline::update when permission harmonization is enabled; otherwise, replication-pipeline::manage.

put/v1/integration/projects/{projectId}/files/move

Request

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

Path parameters

projectIdstring required

Unique identifier of the project

Query parameters

projectType'REPLICATION' | 'MAINFRAME_REPLICATION' | 'ADVANCED_REPLICATION'

Supported project types for unified project operations

Optional project type hint: REPLICATION | MAINFRAME_REPLICATION | ADVANCED_REPLICATION

pipelineIdstring

Unique identifier of the Mainframe Replication pipeline (Mainframe Replication only). Ignored for Advanced Replication.

revisionNumberinteger

Optional revision number targeted by the move

action'RENAME' | 'CLONE'

Action to perform when moving project files: RENAME moves a file to a new path, CLONE copies it while leaving the original in place

The move action: RENAME | CLONE

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

Strategy used when a rename or clone target path already exists (Mainframe Replication only): REPLACE_ALL overwrites every conflicting target, IGNORE_ALL skips every conflicting entry and reports it, PARTIAL applies the entries that do not conflict and reports the rest

Optional conflict-resolution strategy applied when the target path exists (Mainframe Replication only)

Request body

replaceFilesstring[]

Optional paths whose existing target files may be replaced without a conflict

Example request

{
  "files": [
    {
      "currentFilePath": "sources/customers.dis.yaml",
      "newFilePath": "sources/customers_v2.dis.yaml"
    }
  ]
}

Response

File operation completed successfully

filesRenamedOrClonedstring[]

Paths of files successfully renamed or cloned

filesIgnoredstring[]

Paths ignored because they did not match any existing file

filesDeletedstring[]

Paths deleted as a side effect of the move, when applicable

conflictedFilesstring[]

Target paths that already existed and were not replaced

validationErrorsstring[]

Validation errors that prevented individual entries from completing

Changes

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