Search Results for

    Show / Hide Table of Contents

    Class DocumentHistorySearchRequest

    Inheritance
    object
    DocumentHistorySearchRequest
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class DocumentHistorySearchRequest

    Properties

    DocumentId

    Limits the search to a specific document ID. E.g. contentId

    Declaration
    [JsonProperty("documentId", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string DocumentId { get; set; }
    Property Value
    string

    DocumentType

    Limits the search to a specific document type.

    Declaration
    [JsonProperty("documentType", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string DocumentType { get; set; }
    Property Value
    string

    DocumentVersion

    The document version to search. Default to -1 to not limit to a specific document version.

    Declaration
    [JsonProperty("documentVersion", Required = Required.Always)]
    public long DocumentVersion { get; set; }
    Property Value
    long

    From

    Limits the start date of the search request. By default no limitation set.

    Declaration
    [JsonProperty("from", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime From { get; set; }
    Property Value
    DateTime

    Limit

    Limits the document count of the result set. Defaults to 30.

    Declaration
    [JsonProperty("limit", Required = Required.Always)]
    public int Limit { get; set; }
    Property Value
    int

    PageToken

    To get a large amount of data, page token returned from the response can be used to get all data.

    Declaration
    [JsonProperty("pageToken", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string PageToken { get; set; }
    Property Value
    string

    Sort

    Sorts the search results. Sorting on a not indexed field will throw an exception.

    Declaration
    [JsonProperty("sort", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<SortInfo> Sort { get; set; }
    Property Value
    ICollection<SortInfo>

    To

    Limits the end date of the search request. By default no limitation set.

    Declaration
    [JsonProperty("to", Required = Required.Always)]
    [Required(AllowEmptyStrings = true)]
    public DateTime To { get; set; }
    Property Value
    DateTime

    Methods

    FromJson(string)

    Declaration
    public static DocumentHistorySearchRequest FromJson(string data)
    Parameters
    string data

    Returns
    DocumentHistorySearchRequest

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX