Grist4NET
Search Results for

    Show / Hide Table of Contents

    Class DataRequestBuilder

    Builds and executes requests for operations under \docs{docId}\tables{tableId}\data

    Inheritance
    object
    BaseRequestBuilder
    DataRequestBuilder
    Inherited Members
    BaseRequestBuilder.PathParameters
    BaseRequestBuilder.RequestAdapter
    BaseRequestBuilder.UrlTemplate
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Grist4NET.Kiota.Docs.Item.Tables.Item.Data
    Assembly: Grist4NET.Kiota.dll
    Syntax
    public class DataRequestBuilder : BaseRequestBuilder

    Constructors

    DataRequestBuilder(Dictionary<string, object>, IRequestAdapter)

    Instantiates a new DataRequestBuilder and sets the default values.

    Declaration
    public DataRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    Dictionary<string, object> pathParameters

    Path parameters for the request

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    DataRequestBuilder(string, IRequestAdapter)

    Instantiates a new DataRequestBuilder and sets the default values.

    Declaration
    public DataRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    IRequestAdapter requestAdapter

    The request adapter to use to execute the requests.

    Properties

    DeletePath

    The deletePath property

    Declaration
    [Obsolete("")]
    public DeleteRequestBuilder DeletePath { get; }
    Property Value
    Type Description
    DeleteRequestBuilder

    Methods

    GetAsync(Action<RequestConfiguration<DataRequestBuilderGetQueryParameters>>, CancellationToken)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public Task<Data> GetAsync(Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderGetQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<Data>

    A Data

    PatchAsync(Data, Action<RequestConfiguration<DataRequestBuilderPatchQueryParameters>>, CancellationToken)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public Task<List<int?>> PatchAsync(Data body, Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPatchQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    Data body

    The request body

    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPatchQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<List<int?>>

    A List<int>

    PostAsync(DataWithoutId, Action<RequestConfiguration<DataRequestBuilderPostQueryParameters>>, CancellationToken)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public Task<List<int?>> PostAsync(DataWithoutId body, Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPostQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    DataWithoutId body

    The request body

    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPostQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    CancellationToken cancellationToken

    Cancellation token to use when cancelling requests

    Returns
    Type Description
    Task<List<int?>>

    A List<int>

    ToGetRequestInformation(Action<RequestConfiguration<DataRequestBuilderGetQueryParameters>>)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderGetQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderGetQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    ToPatchRequestInformation(Data, Action<RequestConfiguration<DataRequestBuilderPatchQueryParameters>>)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public RequestInformation ToPatchRequestInformation(Data body, Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPatchQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    Data body

    The request body

    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPatchQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    ToPostRequestInformation(DataWithoutId, Action<RequestConfiguration<DataRequestBuilderPostQueryParameters>>)

    Deprecated in favor of records endpoints. We have no immediate plans to remove these endpoints, but consider records a better starting point for new projects.

    Declaration
    [Obsolete("")]
    public RequestInformation ToPostRequestInformation(DataWithoutId body, Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPostQueryParameters>> requestConfiguration = null)
    Parameters
    Type Name Description
    DataWithoutId body

    The request body

    Action<RequestConfiguration<DataRequestBuilder.DataRequestBuilderPostQueryParameters>> requestConfiguration

    Configuration for the request such as headers, query parameters, and middleware options.

    Returns
    Type Description
    RequestInformation

    A Microsoft.Kiota.Abstractions.RequestInformation

    WithUrl(string)

    Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

    Declaration
    [Obsolete("")]
    public DataRequestBuilder WithUrl(string rawUrl)
    Parameters
    Type Name Description
    string rawUrl

    The raw URL to use for the request builder.

    Returns
    Type Description
    DataRequestBuilder

    A DataRequestBuilder

    In this article
    Back to top Generated by DocFX