Relativity.Services.DataVisualization.V1.View.Models.ViewRequest

ViewRequest

public class ViewRequest : IHaveName

Represents a View.

Documentation

public int ArtifactID { get; set; }

Gets or sets the Artifact ID of the view.

public int ArtifactTypeID { get; set; }

Gets or set the Artifact Type ID of the object the view is assigned to.

public Securable<DisplayableObjectIdentifier> Dashboard { get; set; }

Gets or sets Dashboard associated with the view.

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

Gets or sets the fields included in the view result set. They are specified as a collection of FieldRef objects.

public int? GroupDefinitionFieldArtifactID { get; set; }

Gets or sets the Group Definition Field Artifact ID.

public bool IsRelationalFieldView { get; set; }

Gets or sets a Boolean value indicating whether the view is used to display relational fields.

public bool IsSystemView { get; set; }

Gets or sets a Boolean value indicating whether the view is a system view.

public bool IsVisible { get; set; }

Gets or sets a Boolean value indicating whether the view is visible in the system.

public string Name { get; set; }

Gets or sets a descriptive for the view.

public int Order { get; set; }

Gets or sets the position of the view in the view drop-down list.

public Securable<DisplayableObjectIdentifier> Owner { get; set; }

Gets or sets the users who owns the view. Setting the Artifact ID on this property to 0 enables all users with View permissions to see the view.

public string QueryHint { get; set; }

Gets or sets a string parameter used to optimize views. Use the query hint only when instructed by the Relativity Client Services team. Currently, you can use Hashjoin:(true/false) or Maxdrop:(x) to populate the field.

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

Gets or sets the Relativity applications associated with the view.

public CriteriaCollection SearchCriteria { get; set; }

Gets or sets search criteria specified as a CriteriaCollection object.

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

Gets or sets the sort order for view results specified as a collection of Sort objects.

public bool VisibleInDropdown { get; set; }

Gets or sets a Boolean value indicating whether the view is visible in the view drop-down list.

public ViewRequest(ViewResponse response)

Converts a ViewResponse to a new instance of a ViewRequest.

public ViewRequest()

Initializes an instance of the ViewRequest class with all properties set to their default values.

public static ViewRequest op_Implicit(ViewResponse response)

Implicitly converts a ViewResponse to a new instance of a ViewRequest.