Nuix · Schema

launchCaseCollectionRequest

Schema for launchCaseCollectionRequest in Nuix ECC REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
caseId	integer	id of the case within which to start a collection
name	string	name of the new collection
configurationId	integer	id of the collection configuration to use for collection criteria
location	string	destination of the collection (if blank then destination determined by the specified collection configuration)
custodianIds	array	id(s) of the custodian(s) for which to launch this collection

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-ecc-launchcasecollectionrequest.json",
  "title": "launchCaseCollectionRequest",
  "description": "Schema for launchCaseCollectionRequest in Nuix ECC REST API",
  "type": "object",
  "properties": {
    "caseId": {
      "type": "integer",
      "description": "id of the case within which to start a collection"
    },
    "name": {
      "type": "string",
      "description": "name of the new collection"
    },
    "configurationId": {
      "type": "integer",
      "description": "id of the collection configuration to use for collection criteria"
    },
    "location": {
      "type": "string",
      "description": "destination of the collection (if blank then destination determined by the specified collection configuration)"
    },
    "custodianIds": {
      "type": "array",
      "description": "id(s) of the custodian(s) for which to launch this collection",
      "items": {
        "type": "integer"
      }
    }
  }
}