<PackageReference Include="Relativity.Server.Testing.Framework.SDK" Version="10.3.0" />

KeywordSearch

public class KeywordSearch : NamedArtifact
Represents an instance of keyword search. Keyword search (or SQL index search) is Relativity's default search engine.
public int ArtifactTypeID { get; set; }

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

public NamedArtifact Dashboard { get; set; }

Gets or sets dashboard associated with the saved search.

public NamedArtifact[] Fields { get; set; }

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

public NamedArtifact Includes { get; set; }

Gets or sets 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; }

Gets or sets optional field for recording additional information associated with the search as keywords.

public string Notes { get; set; }

Gets or sets detailed description of the saved search.

public NamedArtifact Owner { get; set; }

Gets or sets 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; }

Gets or sets 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<NamedArtifact> RelativityApplications { get; set; }

Gets or sets relativityApplications associated with this saved search.

public bool RequiresManualRun { get; set; }

Gets or sets a value indicating whether requires users to rerun a saved search when they return to it to ensure up-to-date results.

public ScopeType Scope { get; set; }

Gets or sets the scope of the search specified as a ScopeType enumeration.

public CriteriaCollection SearchCriteria { get; set; }

Gets or sets search Criteria specified as a CriteriaCollection object.

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

Gets or sets if folders or subfolders are specified as the KeywordSearch.

public NamedArtifact SearchIndex { get; set; }

Gets or sets searchIndex of the keyword index used by the search.

public string SearchText { get; set; }

Gets or sets search terms.

public bool SortByRank { get; set; }

Gets or sets a value indicating whether indicates that the search results must be sort by relevance rank.

public List<Sort> Sorts { get; set; }

Gets or sets sort order for search results specified as a Sorts object.

public NamedArtifact SystemCreatedBy { get; set; }

Gets or sets artifactID of the user who created the saved search.

public DateTime? SystemCreatedOn { get; set; }

Gets or sets date and time in UTC when the saved search was created.

public NamedArtifact SystemLastModifiedBy { get; set; }

Gets or sets artifactID of the user who last modified the saved search.

public DateTime? SystemLastModifiedOn { get; set; }

Gets or sets date and time in UTC when the search was last modified.

public KeywordSearch()

public KeywordSearch FillRequiredProperties()

Fills the Name on the KeywordSearch if its null.