QueryRequest Class

Relativity Services API
Describes conditions, sorts and fields to be returned for a query.
Inheritance Hierarchy

System.Object
  Relativity.Services.Objects.DataContracts.QueryRequest

Namespace:  Relativity.Services.Objects.DataContracts
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax

public class QueryRequest

The QueryRequest type exposes the following members.

Constructors

  NameDescription
Public methodQueryRequest
Initializes a new instance of the QueryRequest class
Top
Properties

  NameDescription
Public propertyActiveArtifactID
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.
Public propertyCondition
Gets or sets the search criteria. It can be a simple, single-field condition or a complex expression made by combining conditions.
Public propertyConvertNumberFieldValuesToString
Gets or sets a Boolean value indicating whether to convert the numbers returned in the query to text.
Public propertyExecutingSavedSearchID
Gets or sets the ID of the currently executing saved search.
Public propertyExecutingViewID
Gets or sets the ID of the currently executing view.
Public propertyFields
Gets or sets a collection of fields like a SELECT statement in an SQL query.
Public propertyIncludeIDWindow
Gets or sets Boolean value indicating whether the query results should include the IDs of the objects included in the current results set.
Public propertyIncludeNameInQueryResult
Gets or sets Boolean value indicating whether the Name property on the result objects is populated.
Public propertyIsAdhocQuery
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.
Public propertyLongTextBehavior
Gets or sets the behavior used when a long text field exceeds the configured character limit.
Public propertyMaxCharactersForLongTextValues
Gets or sets the maximum number of characters returned in the query results for long text fields.
Public propertyObjectType
Gets or sets the ObjectTypeRef for the type of object the query will run against.
Public propertyQueryHint
Gets or sets the QueryHint of the currently executing search. It is used to optimize the view.
Public propertyRankSortOrder
Gets or sets the sorting direction of Rank column in the Relativity UI, as either ascending or descending.
Public propertyRelationalField
Gets or sets the FieldRef used to include related items in query result.
Public propertyRowCondition
Gets or sets the row condition criteria.
Public propertySampleParameters
Gets or sets the SampleParameters used to take a sample of the query result set.
Public propertySearchProviderCondition
Gets or sets the search provider search condition.
Public propertySorts
Gets or sets the sort order for view results specified as a collection of Sort objects.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference