DataResult Class

Relativity Services API
Inheritance Hierarchy

System.Object
  Relativity.Services.ObjectQuery.DataResult

Namespace:  Relativity.Services.ObjectQuery
Assembly:  Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 13.3.1.1 045207d562027f7bb0eaa843477ebb7cba5b9f0a
Syntax

public class DataResult

The DataResult type exposes the following members.

Constructors

  NameDescription
Public methodDataResult
Initializes a new instance of the DataResult class
Top
Properties

  NameDescription
Public propertyArtifactTypeGuids
Guids for the artifact type of the query result artifacts. Some artifact types will not have a GUID.
Public propertyArtifactTypeId
Id of artifact type of the query result artifacts.
Public propertyArtifactTypeName
Name of artifact type of the query result artifacts.
Public propertyCurrentStartIndex
Start index of the results relative to the entire query result set.
Public propertyDataResults
Query result artifacts.
Public propertyIncludes
Related items are included in the result set based on this field.
Public propertyNextPage
Generated url of that can be used to retrieve the next page of query results based on the provided start and pageSize parameters of the query execution.
Public propertyPreviousPage
Generated url of that can be used to retrieve the previous page of query results based on the provided start and pageSize parameters of the query execution.
Public propertyQueryToken
Token that can be used to lookup a subset of the cached query.
Public propertyRankWindow
Retrieves the set of Ranks used to prime the review tool's session.
Public propertyResultCount
Count of return artifacts returned for this call.
Public propertySample
Token that can be used to persist an existing sample from one call to the next.
Public propertyTotalResultCount
Total count of return artifacts in the entire query (Including artifacts that were not returned in this call due to requeseted page size being smaller than TotalResultCount).
Public propertyWindow
Retrieves the set of IDs used to prime the review tool's session.
Public propertyWorkspaceId
Id of the workspace which contains the query result artifacts. If artifacts belong to the admin level, this value will equal -1.
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