Unified Project Lifecycle APIs

Search project file paths and content

Searches project file paths and content through the unified project API.

Features:

  • Supports plain-text, case/word-sensitive, and regular-expression search.
  • Restricts scanning with filesToInclude glob/exact/regex selectors.

Use Cases:

  • VS Code extension implements project-wide "Find in Files".
  • User locates every reference to a connection name before renaming it.

Authorization: Requires replication-pipeline::view.

post/v1/integration/projects/{projectId}/files/search

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/projects/{projectId}/files/search
  • 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.

Request body

searchTermstring required

Text or regular expression to search for

matchCaseboolean

When true, the search is case-sensitive

matchWordboolean

When true, only whole-word matches are returned

regexboolean

When true, searchTerm is treated as a regular expression

view'CURRENT' | 'COMMITTED'

File-tree view to search: CURRENT | COMMITTED

revisionNumberinteger

Optional revision number to search when view is COMMITTED

Example request

{
  "searchTerm": "oracle_source",
  "filesToInclude": [
    {
      "pattern": "sources/*.dis.yaml"
    }
  ],
  "view": "CURRENT"
}

Response

Project file search completed

filesScannedinteger

Total number of files scanned

matchCountinteger

Total number of matches found

filesSkippedinteger

Number of files skipped, for example due to size limits

truncatedboolean

Whether results were truncated before completion

Example response

{
  "files": [
    {
      "fileId": "file-002",
      "fileName": "customers.dis.yaml",
      "flattenedPath": "sources/customers.dis.yaml",
      "matches": [
        {
          "line": 2,
          "startColumn": 15,
          "endColumn": 28,
          "searchContentResult": "oracle_source"
        }
      ]
    }
  ],
  "filesScanned": 12,
  "matchCount": 1
}

Changes

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