Class ApplyRequestBuilder

Builds and executes requests for operations under \docs{docId}\apply

Inheritance

object

BaseRequestBuilder

ApplyRequestBuilder

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.Apply

Assembly: Grist4NET.Kiota.dll

Syntax

public class ApplyRequestBuilder : BaseRequestBuilder

Constructors

ApplyRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new ApplyRequestBuilder and sets the default values.

Declaration

public ApplyRequestBuilder(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.

ApplyRequestBuilder(string, IRequestAdapter)

Instantiates a new ApplyRequestBuilder and sets the default values.

Declaration

public ApplyRequestBuilder(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.

Methods

PostAsync(List<UntypedNode>, Action<RequestConfiguration<ApplyRequestBuilderPostQueryParameters>>, CancellationToken)

Apply a sequence of user actions to a document. This is a low-level endpointfor making batch changes using Grist's internal action format.Each action is an array where the first element is the action type.Common action types:- ["AddRecord", tableId, rowId, {column: value}] - Add a row (use null for auto-assigned rowId)- ["UpdateRecord", tableId, rowId, {column: value}] - Update a row- ["RemoveRecord", tableId, rowId] - Delete a row- ["BulkAddRecord", tableId, [rowIds], {column: [values]}] - Add multiple rows- ["BulkUpdateRecord", tableId, [rowIds], {column: [values]}] - Update multiple rows- ["BulkRemoveRecord", tableId, [rowIds]] - Delete multiple rows- ["AddColumn", tableId, colId, {type, ...}] - Add a column- ["RemoveColumn", tableId, colId] - Remove a column- ["RenameColumn", tableId, oldColId, newColId] - Rename a column- ["AddTable", tableId, [{id, type, ...}]] - Add a table- ["RemoveTable", tableId] - Remove a table

Declaration

public Task<ApplyPostResponse> PostAsync(List<UntypedNode> body, Action<RequestConfiguration<ApplyRequestBuilder.ApplyRequestBuilderPostQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
List<UntypedNode>	body	The request body
Action<RequestConfiguration<ApplyRequestBuilder.ApplyRequestBuilderPostQueryParameters>>	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<ApplyPostResponse>	A ApplyPostResponse

ToPostRequestInformation(List<UntypedNode>, Action<RequestConfiguration<ApplyRequestBuilderPostQueryParameters>>)

Apply a sequence of user actions to a document. This is a low-level endpointfor making batch changes using Grist's internal action format.Each action is an array where the first element is the action type.Common action types:- ["AddRecord", tableId, rowId, {column: value}] - Add a row (use null for auto-assigned rowId)- ["UpdateRecord", tableId, rowId, {column: value}] - Update a row- ["RemoveRecord", tableId, rowId] - Delete a row- ["BulkAddRecord", tableId, [rowIds], {column: [values]}] - Add multiple rows- ["BulkUpdateRecord", tableId, [rowIds], {column: [values]}] - Update multiple rows- ["BulkRemoveRecord", tableId, [rowIds]] - Delete multiple rows- ["AddColumn", tableId, colId, {type, ...}] - Add a column- ["RemoveColumn", tableId, colId] - Remove a column- ["RenameColumn", tableId, oldColId, newColId] - Rename a column- ["AddTable", tableId, [{id, type, ...}]] - Add a table- ["RemoveTable", tableId] - Remove a table

Declaration

public RequestInformation ToPostRequestInformation(List<UntypedNode> body, Action<RequestConfiguration<ApplyRequestBuilder.ApplyRequestBuilderPostQueryParameters>> requestConfiguration = null)

Parameters

Type	Name	Description
List<UntypedNode>	body	The request body
Action<RequestConfiguration<ApplyRequestBuilder.ApplyRequestBuilderPostQueryParameters>>	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

public ApplyRequestBuilder WithUrl(string rawUrl)

Parameters

Type	Name	Description
string	rawUrl	The raw URL to use for the request builder.

Returns

Type	Description
ApplyRequestBuilder	A ApplyRequestBuilder