Nuix · Schema

ItemSetItemsResponse

Schema for ItemSetItemsResponse 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.
itemSetName	string	The item set name.
operationType	string	The operation to perform on the item set.
failedItemGuidList	array	The list of failed item guids.
successfulItemGuidList	array	The list of successful item guids.

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-itemsetitemsresponse.json",
  "title": "ItemSetItemsResponse",
  "description": "Schema for ItemSetItemsResponse 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."
    },
    "itemSetName": {
      "type": "string",
      "description": "The item set name."
    },
    "operationType": {
      "type": "string",
      "description": "The operation to perform on the item set.",
      "enum": [
        "ADD",
        "DELETE"
      ]
    },
    "failedItemGuidList": {
      "type": "array",
      "description": "The list of failed item guids.",
      "items": {
        "type": "string"
      }
    },
    "successfulItemGuidList": {
      "type": "array",
      "description": "The list of successful item guids.",
      "items": {
        "type": "string"
      }
    }
  }
}