Nuix · Schema

WordCountsRequest

Schema for WordCountsRequest in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
queryList	array	The set of queries which will be executed.
deduplication	string	The deduplication to apply over each query. Defaults to 'none'
field	string	Specifies the field to search over each query. Defaults to all.
sort	string	Sorts the results from most frequent to least frequent. Defaults to off.
minOccurs	integer	Returns only results occurring at least this number of times.
maxOccurs	integer	Returns only results occurring at most this number of times.
minWordLength	integer	Limits results to words whose length is greater than or equal to this value.
maxWordLength	integer	Limits results to words whose length is less than or equal to this value.
filter	string	Limits results to words that match the filter. Default is 'all'
maxResults	integer	Limits the size of the returned list of word counts. Defaults to 200; use -1 for no limit.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-rest-wordcountsrequest.json",
  "title": "WordCountsRequest",
  "description": "Schema for WordCountsRequest in Nuix REST API",
  "type": "object",
  "properties": {
    "queryList": {
      "type": "array",
      "description": "The set of queries which will be executed.",
      "items": {
        "type": "string"
      }
    },
    "deduplication": {
      "type": "string",
      "description": "The deduplication to apply over each query. Defaults to 'none'",
      "default": "none",
      "enum": [
        "none",
        "md5"
      ]
    },
    "field": {
      "type": "string",
      "description": "Specifies the field to search over each query. Defaults to all.",
      "default": "all",
      "enum": [
        "content",
        "properties",
        "all"
      ]
    },
    "sort": {
      "type": "string",
      "description": "Sorts the results from most frequent to least frequent. Defaults to off.",
      "default": false,
      "enum": [
        true,
        false
      ]
    },
    "minOccurs": {
      "type": "integer",
      "description": "Returns only results occurring at least this number of times.",
      "format": "int32"
    },
    "maxOccurs": {
      "type": "integer",
      "description": "Returns only results occurring at most this number of times.",
      "format": "int32"
    },
    "minWordLength": {
      "type": "integer",
      "description": "Limits results to words whose length is greater than or equal to this value.",
      "format": "int32"
    },
    "maxWordLength": {
      "type": "integer",
      "description": "Limits results to words whose length is less than or equal to this value.",
      "format": "int32"
    },
    "filter": {
      "type": "string",
      "description": "Limits results to words that match the filter.  Default is 'all'",
      "enum": [
        "all",
        "numeric",
        "aToZ",
        "foreign",
        "atypicalLength"
      ],
      "default": "all"
    },
    "maxResults": {
      "type": "integer",
      "description": "Limits the size of the returned list of word counts.  Defaults to 200; use -1 for no limit.",
      "format": "int32",
      "default": 200
    }
  }
}