{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-searchnativerequest.json",
  "title": "SearchNativeRequest",
  "description": "Schema for SearchNativeRequest in Nuix REST API",
  "type": "object",
  "properties": {
    "caseId": {
      "type": "string",
      "description": "The case identification token."
    },
    "query": {
      "type": "string",
      "description": "Identifies what items should be returned.  If a query is not supplied it defaults to an empty string, which returns all items."
    },
    "sortField": {
      "type": "string",
      "description": "Any field in the metadata profile which you want to sort by.\n\nUse the following supported fields in the sortFields:\nposition,kind,duplicates\n"
    },
    "sortOrder": {
      "type": "string",
      "description": "Sets the sort order for the results. Defaults to \"ASC\".",
      "enum": [
        "asc",
        "desc"
      ],
      "default": "asc"
    },
    "startIndex": {
      "type": "integer",
      "default": 0,
      "description": "The index of the first record that should be returned. Defaults to 0.",
      "format": "int32"
    },
    "numberOfRecordsRequested": {
      "type": "integer",
      "description": "The number of records that should be returned per page. Defaults to 100 records.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of results to return.",
      "format": "int32"
    },
    "deduplication": {
      "type": "string",
      "description": "Deduplicate content based on the Value field selection.  Defaults to no deduplication.",
      "enum": [
        "md5",
        "per custodian",
        "none"
      ]
    },
    "maintainDeduplicatedSearchOrder": {
      "type": "boolean",
      "default": true,
      "description": "Specifies whether the original search result order based on the query should be maintained for deduplicated results.  Default is true.  Setting this field to false may improve deduplication performance especially for Elasticsearch cases.  This field is ignored if a sort field has been specified."
    },
    "metadataProfile": {
      "type": "string",
      "description": "Defines the metadata profile to be appied to the results. Needed to get custom metadata. Defaults to no metadata profile."
    },
    "fieldList": {
      "type": "array",
      "description": "List of fields to be returned for each item in the results.\nUse the following supported fields in the fieldList:\n\n* `all` - Returns all fields for the item.\n* `auditedSize` - Returns the item''s audited size.\n* `children` - Returns a list of the item''s children.\n* `clusterPivotResemblances` - Returns a map where the keys are cluster IDs and the values are resemblances.\n* `clusterPivots` - Returns a map where the keys are cluster IDs and the values are boolean flags.\n* `comment` - Returns item comments.\n* `communication` - If the item is a communication, this returns item communication information.\n* `correctedExtension` - Returns the extension based on Nuix''s identification of the item''s MIME type.\n* `custodian` - Returns the custodian assigned to an item.\n* `customMetadata` - Returns custom metadata for the item as a map. Must provide metadataProfile to get this.\n* `date` - Returns the item date.\n* `descendants` - Gets the list of items which are descendants of this item.\n* `digests` - Returns a map of the computed digests for an item.\n* `duplicateCustodianSet` - Returns the set of custodian names associated with this item and its duplicates.\n* `duplicates` - Returns duplicates of this item.\n* `evidenceMetadata` - Returns custom evidence metadata for the item.\n* `exclusion` - Returns the reason for an item''s exclusion.\n* `family` - Returns a list of items in the same family.\n* `fileSize` - Returns the item''s file size if it is readable, or returns null if this is not file data.\n* `fileType` - Returns the name of the file type.\n* `guid` - Returns the item''s globally unique identifier (GUID).\n* `history` - Returns the item''s history in ascending order by date.\n* `id` - Returns the item''s ID.\n* `isAudited` - Tests whether the item is considered audited and returns true or false.\n* `isBinaryAvailable` - Tests whether the item''s binary is available before attempting to export it.  This returns\ntrue if the item had binary data at processing time that was not stored. This\ndiffers from isStored() as this method returns true if the item had binary\ndata at processing time that was not stored.\n* `isBinaryStored` - Tests whether the item has binary stored against it in the database. True is returned\nif stored binary exists. In this case, the source data isn''t required for\nbinary export.\n* `isChatMessage` - Tests whether the item is a chat message.\n* `isChatConversation` - Tests whether the item is a chat conversation.\n* `isDeleted` - Tests whether the item was marked as deleted and returns true or false.\n* `isEmailThreadMember` - Tests whether the item is part of an email thread.\n* `isEncrypted` - Tests whether the item was marked as encrypted and returns true or false.\n* `isExcluded` - Tests whether the item was marked as excluded.\n* `isFamilyMember` - Tests whether the item is a member of a family (i.e. it has a top-level item).\n* `isIncuded` - Tests whether the item is included and returns true or false.\n* `isLooseFile` - Tests whether the item is a loose file and returns true or false.\n* `isPhysicalFile` - Tests whether the item is a physical file and returns true or false.\n* `isPrintedImageStored` - Tests whether the printed image is stored and returns true or false. This field\nis useful when you only need to know if a printed image exists for this item.\nThis is faster and uses fewer resources than requesting the printedImageInfo\nfield.\n* `isTextAvailable` - Tests whether the item''s text is available before attempting to read or export it.\n* `isTextStored` - Tests hether the item has text stored against it in the database.  In the event\nwhere you only want to know if the item had text but didn''t need the text\nthis field is considerably faster and more conservative of resources than\nisTextAvailable.\n* `isThumbnailStored` - Tests whether a thumbnail is stored for this item in the database and returns true or false.\n* `isTopLevel` - Tests whether this is a top-level item and returns true or false.\n* `itemCategory` - Returns the item category.\n* `kind` - Returns the item kind.\n* `language` - Returns the language identified by the item.\n* `localisedName` - Returns the item name or the localised placeholder (for example, [Unnamed Image])\nif the name is blank.\n* `localisedPathNames` - Returns a list of item names on the path from the root evidence container to the item.\n* `name` - Returns the item name.\n* `originalExtension` - Returns the original extension listed on the source file.\n* `parent` - Returns the parent of this item.\n* `path` - Returns an item list which represents the path from the root evidence container to the item.\n* `pathIDs` - Returns a list of the IDs of items on the path from the root evidence container up to the item itself.\n* `pathNames` - Returns a list of item names on the path from the root evidence container to the item.\n* `position` - Returns the item position number which identifies where this item exists in the tree of all ingested items.\n* `printedImageInfo` - Returns information about the printed image.\n* `properties` - Returns item properties.\n* `root` - Returns the root item. If this item is the root, the item itself is returned.\n* `rootUri` - Returns the item''s root URI as a string.\n* `tags` - Returns the item tags.\n* `text` - Returns the text of the item as a string.\n* `textHtml` - Returns the text of the item escaped for HTML.\n* `textSummary` - Returns the stored text summary of the item if one exists, otherwise null.\n* `textSummaryHtml` - Returns the stored text summary of the item escaped for HTML if one exists, otherwise null.\n* `threadItems` - Returns items that are in the same discussion thread as this item.\n* `topLevelItem` - Returns the associated top-level item.\n* `topLevelItemDate` - Returns the associated top-level item date.\n* `type` - Returns the type name.\n* `typeLocalisedName` - Returns the type name, localised appropriately for display to users.\n* `uri` - Returns the item''s uniform resource identifier (URI) as a string.\n",
      "items": {
        "type": "string"
      }
    },
    "customMetadataList": {
      "description": "List of custom metadata fields to be returned for each item in the results.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "propertyList": {
      "type": "array",
      "description": "List of properties to be returned for each item in the results.",
      "items": {
        "type": "string"
      }
    },
    "itemParameterizedFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specifies parameterized fields in a key/value pair separated by a colon. * `entities` - corresponds to item.getEntities.  (e.g., \"entities:company\") * `serializedItem` - returns a serialized copy of the item.  (e.g., \"seralizedItem:topLevelItem\") * `textTruncated` - returns the item text, truncated (if needed) to the specified maximum size in bytes (e.g., \"textTruncated:10000\") * `thumbnail` - corresponds to an item thumbnail. The parameter specifies the thumbnail dimensions (e.g., \"thumbnail:200x200\") * `nearDupeThreshold` - (e.g., \"nearDupeThreshold:0.9\") * `emailThreadCluster` - value corresponds to a Run - Cluster (e.g., \"emailThreadCluster:cluster-1\")"
    },
    "showAvailableThumbnails": {
      "type": "boolean",
      "description": "Show thumbnails that have been generated"
    },
    "useCache": {
      "type": "boolean",
      "default": false,
      "description": "Specifies whether the results should be loaded from and stored in cache. Defaults to false."
    },
    "forceCacheDelete": {
      "type": "boolean",
      "default": false,
      "description": "Specifies whether the cached results should be deleted before performing the search. Defaults to false."
    },
    "searchRetry": {
      "type": "integer",
      "format": "int32",
      "description": "Specifies the search retry count."
    },
    "relationType": {
      "type": "string",
      "description": "The relation to apply to the found items. For performance reasons, the family option is run against the top-level items.",
      "enum": [
        "family",
        "topTypes",
        "descendants"
      ]
    },
    "entities": {
      "type": "array",
      "description": "List of entity names to include in response (e.g. company,email).  Maintained for backward compatibility.",
      "items": {
        "type": "string"
      }
    },
    "property": {
      "type": "array",
      "description": "List of properties to be returned for each item in the results.  Deprecated use propertyList.",
      "items": {
        "type": "string"
      },
      "deprecated": true
    },
    "field": {
      "type": "array",
      "description": "List of fields to be returned for each item in the results.  Deprecated use fieldList.",
      "items": {
        "type": "string"
      },
      "deprecated": true
    },
    "s": {
      "type": "integer",
      "format": "int32",
      "description": "The index of the first record that should be returned.  Deprecated use startIndex.",
      "deprecated": true
    },
    "p": {
      "type": "integer",
      "format": "int32",
      "description": "The number of records that should be returned.  Deprecated use numberOfRecordsRequested.",
      "deprecated": true
    },
    "customMetadataField": {
      "type": "array",
      "description": "List of custom metadata to be returned for each item in the results.  Deprecated use customMetadataList.",
      "items": {
        "type": "string"
      },
      "deprecated": true
    }
  }
}