Skip to main content
Version: v0.17.0

NuixAddItem

Alias:NuixAddItem, NuixAdd, NuixImportItem

Output:Unit

Requires Nuix.Version 5.0

Requires Nuix.Features: CASE_CREATION

Adds a file or directory to a Nuix Case.

ParameterTypeRequiredPositionDefault ValueExampleRequirementsSummary
Paths
Directories
Files
array<string>1C:/Data/File.txtThe path of the file or directory to add to the case.
Container
ToContainer
string2The name of the evidence container to add items to.
Description
ContainerDescription
string3No DescriptionThe description of the evidence container.
CasePath
Directory
stringUse the current open caseC:/Cases/MyCaseThe case path to use. If this is set, that case will be opened. If it is not set, the existing case will be used. If it is not set and no existing case is open this will result in an error.
ContainerEncoding
Encoding
stringDefault system encodingUTF-8Set the encoding for the evidence container.
ContainerLocale
Locale
stringDefault system localeen-GBVersion 7.2Set the locale for the evidence container.
ContainerTimeZone
TimeZone
stringDefault system time zoneUTCNuixVersion 0.9.0-11.0Set the time zone for the evidence container. If the time zone given is not known to Nuix, the GMT time zone will be used.
Custodian
ContainerCustodian
stringNo custodian assignedThe custodian to assign to the new evidence container.
CustomMetadataentityNo custom metadata will be addedSets additional metadata on the evidence container.
MimeTypeSettingsarray<entity>Use default settings for all MIME types("mimeType": "application/pdf" "enabled": "true" "processEmbedded": false)Version 8.2Special settings for individual mime types. Should have a 'mimeType' property and then any other special properties.
ParallelProcessingSettingsentityParallel processing settings will not be changedSets the parallel processing settings to use. These settings correspond to the same settings in the desktop application, however the user's preferences are not used to derive the defaults.
PasswordFilePath
PasswordFile
stringDo not attempt decryptionC:/Data/Passwords.txtVersion 7.6The path of a file containing passwords to use for decryption.
ProcessingProfileName
UsingProfile
stringThe default processing profile will be used.MyProcessingProfileVersion 7.6The name of the Processing profile to use.
ProcessingProfilePath
UsingProfilePath
stringThe default processing profile will be used.C:/Profiles/MyProcessingProfile.xmlVersion 7.6The path to the Processing profile to use
ProcessingSettings
Settings
entityProcessing settings will not be changedSets the processing settings to use. These settings correspond to the same settings in the desktop application, however the user's preferences are not used to derive the defaults.
ProgressIntervalintEvery 5000 itemsThe number of items at which the Nuix processor logs a progress message.