FolderSpec

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-ecc-folderspec.json",
  "title": "FolderSpec",
  "description": "Schema for FolderSpec in Nuix ECC REST API",
  "type": "object",
  "properties": {
    "folder": {
      "type": "string",
      "description": "full path of the folder to collect from."
    },
    "excludeFolders": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "optional, path(s) of folder(s) to exclude.  These are relative paths, relative to the `folder` to collect from."
      }
    },
    "excludeFiles": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "optional, path(s) of file(s) to exclude.  These are relative paths, relative to the `folder` to collect from."
      }
    },
    "excludeWildcards": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "optional, wildcard specification(s) (e.g *.pdf) specifying files to exclude from `folder` path.\n\nNote that wildcard exclusions are recursive under `folder` path."
      }
    }
  }
}