Skip to main content
Version: v0.17.0

NuixRemoveFromItemSet

Alias:NuixRemoveFromItemSet

Output:Unit

Requires Nuix.Version 7.0

Requires Nuix.Features: ANALYSIS

Removes particular items from a Nuix item set.

ParameterTypeRequiredPositionDefault ValueExampleSummary
ItemSetName
ItemSet
string1The name of the item set to remove results from.
SearchTerm
Search
string2Tag:sushiThe search term to use for choosing which items to remove.
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.
RemoveDuplicatesbooltrueIf true (default), duplicates of (top-level and above-top-level) originals are removed. When false, only the found items are removed causing new originals to be chosen from the remaining duplicates.
SearchOptionsentityNo search options providedPass additional search options to nuix. For an unsorted search (default) the only available option is defaultFields. When using SortSearch=true the options are defaultFields, order, and limit. Please see the nuix API for Case.search and Case.searchUnsorted for more details.
SearchTypeSearchTypeItemsOnlyDefines the type of search that is done. By default only the items responsive to the search terms are tagged, but the result set can be augmented using this parameter.
SortSearchboolfalseBy default the search is not sorted by relevance which increases performance. Set this to true to sort the search by relevance and enabling additional SearchOptions.