Nuix · Schema

launchCaseCollectionByConfigurationRequest

Schema for launchCaseCollectionByConfigurationRequest 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 (must be unique)
computerId string GUID value that identifies the computer
configurationId integer id of the collection configuration to use for collection criteria
location string destination of the collection (if blank uses the location within the specified collection configuration)
View JSON Schema on GitHub

JSON Schema

nuix-ecc-launchcasecollectionbyconfigurationrequest.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-ecc-launchcasecollectionbyconfigurationrequest.json",
  "title": "launchCaseCollectionByConfigurationRequest",
  "description": "Schema for launchCaseCollectionByConfigurationRequest 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 (must be unique)"
    },
    "computerId": {
      "type": "string",
      "description": "GUID value that identifies the computer"
    },
    "configurationId": {
      "type": "integer",
      "description": "id of the collection configuration to use for collection criteria"
    },
    "location": {
      "type": "string",
      "description": "destination of the collection (if blank uses the location within the specified collection configuration)"
    }
  }
}