Describes conditions, sorts and fields to be returned for a query.
Inheritance Hierarchy
Relativity.Services.Objects.DataContracts.QueryRequest
Namespace: Relativity.Services.Objects.DataContracts
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The QueryRequest type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | QueryRequest | Initializes a new instance of the QueryRequest class |
Properties
| Name | Description | |
|---|---|---|
 | ActiveArtifactID |
Gets or sets the Artifact ID of an item when available in the query results. This item is used to override the start position for the result page.
|
| Condition |
Gets or sets the search criteria. It can be a simple, single-field condition or a complex expression made by combining conditions.
|
| ConvertNumberFieldValuesToString |
Gets or sets a Boolean value indicating whether to convert the numbers returned in the query to text.
|
| ExecutingSavedSearchID |
Gets or sets the ID of the currently executing saved search.
|
| ExecutingViewID |
Gets or sets the ID of the currently executing view.
|
| Fields |
Gets or sets a collection of fields like a SELECT statement in an SQL query.
|
| IncludeIDWindow |
Gets or sets Boolean value indicating whether the query results should include the IDs of the objects included in the current results set.
|
| IncludeNameInQueryResult |
Gets or sets Boolean value indicating whether the Name property on the result objects is populated.
|
| IsAdhocQuery |
Gets or sets a Boolean value indicating whether the query engine should handle the search or view condition as a query type or simple condition.
|
| LongTextBehavior |
Gets or sets the behavior used when a long text field exceeds the configured character limit.
|
| MaxCharactersForLongTextValues |
Gets or sets the maximum number of characters returned in the query results for long text fields.
|
| ObjectType |
Gets or sets the ObjectTypeRef for the type of object the query will run against.
|
| QueryHint |
Gets or sets the QueryHint of the currently executing search. It is used to optimize the view.
|
| RankSortOrder |
Gets or sets the sorting direction of Rank column in the Relativity UI, as either ascending or descending.
|
| RelationalField |
Gets or sets the FieldRef used to include related items in query result.
|
| RowCondition |
Gets or sets the row condition criteria.
|
| SampleParameters |
Gets or sets the SampleParameters used to take a sample of the query result set.
|
| SearchProviderCondition |
Gets or sets the search provider search condition.
|
| Sorts |
Gets or sets the sort order for view results specified as a collection of Sort objects.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also