Class RecordsRequestBuilder
Builds and executes requests for operations under \docs{docId}\tables{tableId}\records
Inherited Members
Namespace: Grist4NET.Kiota.Docs.Item.Tables.Item.Records
Assembly: Grist4NET.Kiota.dll
Syntax
public class RecordsRequestBuilder : BaseRequestBuilder
Constructors
RecordsRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new RecordsRequestBuilder and sets the default values.
Declaration
public RecordsRequestBuilder(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. |
RecordsRequestBuilder(string, IRequestAdapter)
Instantiates a new RecordsRequestBuilder and sets the default values.
Declaration
public RecordsRequestBuilder(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
public DeleteRequestBuilder DeletePath { get; }
Property Value
| Type | Description |
|---|---|
| DeleteRequestBuilder |
Methods
GetAsync(Action<RequestConfiguration<RecordsRequestBuilderGetQueryParameters>>, CancellationToken)
Fetch records from a table
Declaration
public Task<RecordsList> GetAsync(Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderGetQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderGetQueryParameters>> | 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<RecordsList> |
PatchAsync(RecordsList, Action<RequestConfiguration<RecordsRequestBuilderPatchQueryParameters>>, CancellationToken)
Modify records of a table
Declaration
public Task<Stream> PatchAsync(RecordsList body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPatchQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsList | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPatchQueryParameters>> | 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<Stream> | A Stream |
PostAsync(RecordsWithoutId, Action<RequestConfiguration<RecordsRequestBuilderPostQueryParameters>>, CancellationToken)
Add records to a table
Declaration
public Task<RecordsWithoutFields> PostAsync(RecordsWithoutId body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPostQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsWithoutId | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPostQueryParameters>> | 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<RecordsWithoutFields> |
PutAsync(RecordsWithRequire, Action<RequestConfiguration<RecordsRequestBuilderPutQueryParameters>>, CancellationToken)
Add or update records of a table
Declaration
public Task<Stream> PutAsync(RecordsWithRequire body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPutQueryParameters>> requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsWithRequire | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPutQueryParameters>> | 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<Stream> | A Stream |
ToGetRequestInformation(Action<RequestConfiguration<RecordsRequestBuilderGetQueryParameters>>)
Fetch records from a table
Declaration
public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderGetQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderGetQueryParameters>> | requestConfiguration | Configuration for the request such as headers, query parameters, and middleware options. |
Returns
| Type | Description |
|---|---|
| RequestInformation | A Microsoft.Kiota.Abstractions.RequestInformation |
ToPatchRequestInformation(RecordsList, Action<RequestConfiguration<RecordsRequestBuilderPatchQueryParameters>>)
Modify records of a table
Declaration
public RequestInformation ToPatchRequestInformation(RecordsList body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPatchQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsList | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPatchQueryParameters>> | requestConfiguration | Configuration for the request such as headers, query parameters, and middleware options. |
Returns
| Type | Description |
|---|---|
| RequestInformation | A Microsoft.Kiota.Abstractions.RequestInformation |
ToPostRequestInformation(RecordsWithoutId, Action<RequestConfiguration<RecordsRequestBuilderPostQueryParameters>>)
Add records to a table
Declaration
public RequestInformation ToPostRequestInformation(RecordsWithoutId body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPostQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsWithoutId | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPostQueryParameters>> | requestConfiguration | Configuration for the request such as headers, query parameters, and middleware options. |
Returns
| Type | Description |
|---|---|
| RequestInformation | A Microsoft.Kiota.Abstractions.RequestInformation |
ToPutRequestInformation(RecordsWithRequire, Action<RequestConfiguration<RecordsRequestBuilderPutQueryParameters>>)
Add or update records of a table
Declaration
public RequestInformation ToPutRequestInformation(RecordsWithRequire body, Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPutQueryParameters>> requestConfiguration = null)
Parameters
| Type | Name | Description |
|---|---|---|
| RecordsWithRequire | body | The request body |
| Action<RequestConfiguration<RecordsRequestBuilder.RecordsRequestBuilderPutQueryParameters>> | 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 RecordsRequestBuilder WithUrl(string rawUrl)
Parameters
| Type | Name | Description |
|---|---|---|
| string | rawUrl | The raw URL to use for the request builder. |
Returns
| Type | Description |
|---|---|
| RecordsRequestBuilder |