Relativity.Services.Search.dtSearch

public class dtSearch : SavedSearchRef, ISavedSearch, IRelativityApplicationAssociable

Represent an instance of dtSearch. Relativity's dtSearch engine provides advanced search functionality such as proximity, stemming, fuzzy searches, and Boolean operators.

Documentation

public int ArtifactTypeID { get; set; }

The Artifact Type ID of the object for the search (currently only Document is supported).

public DashboardRef Dashboard { get; set; }

Dashboard associated with the saved search.

public bool EnableStemming { get; set; }

Enables search for grammatical variations of the search term.

public List<FieldRef> Fields { get; set; }

The fields to be included in the search result set specified as a collection of Field objects.

public int FuzzinessLevel { get; set; }

Fuzziness level defines the level of search term variations.

public FieldRef Includes { get; set; }

Field identifying documents related to the documents matching the search criteria. The related documents will be included in the result set alongside with the documents that match the search criteria.

public string Keywords { get; set; }

Optional field for recording additional information associated with the search as keywords.

public string Notes { get; set; }

Detailed description of the saved search.

public UserRef Owner { get; set; }

User(s) who can access the saved search. Setting the ArtifactID value to 0 enables all users with permissions to the saved search are able to see it.

public string QueryHint { get; set; }

String parameter used to optimize views. Only use the query hint if instructed by the kCura Client Services team. Currently, you can use Hashjoin:(true/false) or Maxdrop:(x) to populate the field.

public List<RelativityApplicationRef> RelativityApplications { get; set; }

RelativityApplications associated with this saved search.

public bool RequiresManualRun { get; set; }

Requires users to rerun a saved search when they return to it to ensure up-to-date results.

public ScopeType Scope { get; set; }

The scope of the search specified as a ScopeType enumeration.

public SearchContainerRef SearchContainer { get; set; }

SearchContainer of the saved search folder. If no value is specified, the search will be saved at the logical root of the saved search view.

public CriteriaCollection SearchCriteria { get; set; }

Search Criteria specified as a CriteriaCollection object.

public List<FolderRef> SearchFolders { get; set; }

If folders or subfolders are specified as the dtSearch.