Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IRelationalDatasetsApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< BatchDeleteRelationalDataResponse >	BatchDeleteRelationalDataAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, DeleteRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< BatchDeleteRelationalDataResponse > >	BatchDeleteRelationalDataWithHttpInfoAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, DeleteRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition. More...

System.Threading.Tasks.Task< BatchUpsertRelationalDatasetsResponse >	BatchUpsertRelationalDataAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, UpsertRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< BatchUpsertRelationalDatasetsResponse > >	BatchUpsertRelationalDataWithHttpInfoAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, UpsertRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition. More...

System.Threading.Tasks.Task< PagedResourceListOfRelationalDataPointResponse >	QueryRelationalDataAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), QueryRelationalDatasetRequest? queryRelationalDatasetRequest=default(QueryRelationalDatasetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. More...

System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationalDataPointResponse > >	QueryRelationalDataWithHttpInfoAsync (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), QueryRelationalDatasetRequest? queryRelationalDatasetRequest=default(QueryRelationalDatasetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ BatchDeleteRelationalDataAsync()

System.Threading.Tasks.Task<BatchDeleteRelationalDataResponse> Lusid.Sdk.Api.IRelationalDatasetsApiAsync.BatchDeleteRelationalDataAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, DeleteRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition.

Batch Delete Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
requestBody	The Delete Request.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of BatchDeleteRelationalDataResponse

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

◆ BatchDeleteRelationalDataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchDeleteRelationalDataResponse> > Lusid.Sdk.Api.IRelationalDatasetsApiAsync.BatchDeleteRelationalDataWithHttpInfoAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, DeleteRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

BatchDeleteRelationalData: Batch Delete Relational Data Points for a given Relational Dataset Definition.

Batch Delete Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
requestBody	The Delete Request.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (BatchDeleteRelationalDataResponse)

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

◆ BatchUpsertRelationalDataAsync()

System.Threading.Tasks.Task<BatchUpsertRelationalDatasetsResponse> Lusid.Sdk.Api.IRelationalDatasetsApiAsync.BatchUpsertRelationalDataAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, UpsertRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition.

Batch Upsert Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
requestBody	The DataPoints to upsert.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of BatchUpsertRelationalDatasetsResponse

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

◆ BatchUpsertRelationalDataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchUpsertRelationalDatasetsResponse> > Lusid.Sdk.Api.IRelationalDatasetsApiAsync.BatchUpsertRelationalDataWithHttpInfoAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, UpsertRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

BatchUpsertRelationalData: Batch Upsert Relational Data Points for a given Relational Dataset Definition.

Batch Upsert Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
requestBody	The DataPoints to upsert.
successMode	Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status code. (optional, default to "Partial")
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (BatchUpsertRelationalDatasetsResponse)

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

◆ QueryRelationalDataAsync()

System.Threading.Tasks.Task<PagedResourceListOfRelationalDataPointResponse> Lusid.Sdk.Api.IRelationalDatasetsApiAsync.QueryRelationalDataAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		QueryRelationalDatasetRequest?	queryRelationalDatasetRequest = `default(QueryRelationalDatasetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition.

Query Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to query the datasets. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue query datasets. This value is returned from the previous call. If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
queryRelationalDatasetRequest	The query request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfRelationalDataPointResponse

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

◆ QueryRelationalDataWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDataPointResponse> > Lusid.Sdk.Api.IRelationalDatasetsApiAsync.QueryRelationalDataWithHttpInfoAsync	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		QueryRelationalDatasetRequest?	queryRelationalDatasetRequest = `default(QueryRelationalDatasetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition.

Query Relational Data Points for a given Relational Dataset Definition.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

relationalDatasetDefinitionScope	The Scope of the relational dataset definition.
relationalDatasetDefinitionCode	The Code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the dataset(s). Defaults to returning the latest version of each dataset if not specified. (optional)
effectiveAt	The effective datetime or cut label at which to query the datasets. Defaults to the current LUSID system datetime if not specified. (optional)
page	The pagination token to use to continue query datasets. This value is returned from the previous call. If a pagination token is provided, the filter, customSortBy, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
queryRelationalDatasetRequest	The query request. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfRelationalDataPointResponse)

Implemented in Lusid.Sdk.Api.RelationalDatasetsApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/RelationalDatasetsApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ BatchDeleteRelationalDataAsync()

◆ BatchDeleteRelationalDataWithHttpInfoAsync()

◆ BatchUpsertRelationalDataAsync()

◆ BatchUpsertRelationalDataWithHttpInfoAsync()

◆ QueryRelationalDataAsync()

◆ QueryRelationalDataWithHttpInfoAsync()