Nuix · Schema

ItemSetRequest

Schema for ItemSetRequest in Nuix REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
query	string	Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items.
batchName	string	Defaults to date in format yy/MM/dd kk:mm:ss z
name	string	name
deduplication	string	How the deduplication is applied. None returns all items matching the query including duplicates. Other options return deduplicated items based on the deduplication methods used. Defaults to None
description	string	The itemset description.
deduplicateBy	string	deduplicateBy. Defaults to INDIVIDUAL
custodianRanking	array	List of custodian names ordered from highest ranked to lowest ranked. If this parameter is present and the deduplication parameter has not been specified, MD5 Randed Custodian is assumed. If deduplica

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-itemsetrequest.json",
  "title": "ItemSetRequest",
  "description": "Schema for ItemSetRequest in Nuix REST API",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Query items that should be included. If a query is not supplied it defaults to an empty string, which returns all items."
    },
    "batchName": {
      "type": "string",
      "description": "Defaults to date in format yy/MM/dd kk:mm:ss z"
    },
    "name": {
      "type": "string",
      "description": "name"
    },
    "deduplication": {
      "type": "string",
      "description": "How the deduplication is applied.  None returns all items matching the query including duplicates.  Other options return deduplicated items based on the deduplication methods used.  Defaults to None",
      "enum": [
        "md5",
        "per custodian",
        "md5 ranked custodian",
        "none"
      ],
      "default": "none"
    },
    "description": {
      "type": "string",
      "description": "The itemset description."
    },
    "deduplicateBy": {
      "type": "string",
      "description": "deduplicateBy.  Defaults to INDIVIDUAL",
      "enum": [
        "individual",
        "family"
      ],
      "default": "individual"
    },
    "custodianRanking": {
      "type": "array",
      "description": "List of custodian names ordered from highest ranked to lowest ranked.  If this parameter is present and the deduplication parameter has not been specified, MD5 Randed Custodian is assumed.  If deduplication is any value other than MD5 Randed Custodian this list is ignored.",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "name"
  ]
}