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

Inheritance diagram for Lusid.Sdk.Api.RelationalDatasetsApi:

[legend]

Public Member Functions
	RelationalDatasetsApi ()
	Initializes a new instance of the RelationalDatasetsApi class. More...

	RelationalDatasetsApi (string basePath)
	Initializes a new instance of the RelationalDatasetsApi class. More...

	RelationalDatasetsApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the RelationalDatasetsApi class using Configuration object More...

	RelationalDatasetsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the RelationalDatasetsApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

BatchDeleteRelationalDataResponse	BatchDeleteRelationalData (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, DeleteRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, 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. More...

Lusid.Sdk.Client.ApiResponse< BatchDeleteRelationalDataResponse >	BatchDeleteRelationalDataWithHttpInfo (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, DeleteRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, 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. More...

async 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. Batch Delete Relational Data Points for a given Relational Dataset Definition. More...

async 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. Batch Delete Relational Data Points for a given Relational Dataset Definition. More...

BatchUpsertRelationalDatasetsResponse	BatchUpsertRelationalData (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, UpsertRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, 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. More...

Lusid.Sdk.Client.ApiResponse< BatchUpsertRelationalDatasetsResponse >	BatchUpsertRelationalDataWithHttpInfo (string relationalDatasetDefinitionScope, string relationalDatasetDefinitionCode, Dictionary< string, UpsertRelationalDataPointRequest > requestBody, string? successMode=default(string?), int operationIndex=0, 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. More...

async 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. Batch Upsert Relational Data Points for a given Relational Dataset Definition. More...

async 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. Batch Upsert Relational Data Points for a given Relational Dataset Definition. More...

PagedResourceListOfRelationalDataPointResponse	QueryRelationalData (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, ConfigurationOptions? opts=null)
	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. Query Relational Data Points for a given Relational Dataset Definition. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationalDataPointResponse >	QueryRelationalDataWithHttpInfo (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, ConfigurationOptions? opts=null)
	QueryRelationalData: Query Relational Data Points for a given Relational Dataset Definition. Query Relational Data Points for a given Relational Dataset Definition. More...

async 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. Query Relational Data Points for a given Relational Dataset Definition. More...

async 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. Query Relational Data Points for a given Relational Dataset Definition. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ RelationalDatasetsApi() [1/4]

Lusid.Sdk.Api.RelationalDatasetsApi.RelationalDatasetsApi ( )

inline

Initializes a new instance of the RelationalDatasetsApi class.

Returns

◆ RelationalDatasetsApi() [2/4]

Lusid.Sdk.Api.RelationalDatasetsApi.RelationalDatasetsApi ( string basePath )

inline

Initializes a new instance of the RelationalDatasetsApi class.

Returns

◆ RelationalDatasetsApi() [3/4]

Lusid.Sdk.Api.RelationalDatasetsApi.RelationalDatasetsApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the RelationalDatasetsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ RelationalDatasetsApi() [4/4]

Lusid.Sdk.Api.RelationalDatasetsApi.RelationalDatasetsApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the RelationalDatasetsApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ BatchDeleteRelationalData()

BatchDeleteRelationalDataResponse Lusid.Sdk.Api.RelationalDatasetsApi.BatchDeleteRelationalData	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, DeleteRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: BatchDeleteRelationalDataResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ BatchDeleteRelationalDataAsync()

async System.Threading.Tasks.Task<BatchDeleteRelationalDataResponse> Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

◆ BatchDeleteRelationalDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchDeleteRelationalDataResponse> Lusid.Sdk.Api.RelationalDatasetsApi.BatchDeleteRelationalDataWithHttpInfo	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, DeleteRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ApiResponse of BatchDeleteRelationalDataResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ BatchDeleteRelationalDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchDeleteRelationalDataResponse> > Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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)

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

◆ BatchUpsertRelationalData()

BatchUpsertRelationalDatasetsResponse Lusid.Sdk.Api.RelationalDatasetsApi.BatchUpsertRelationalData	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, UpsertRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: BatchUpsertRelationalDatasetsResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ BatchUpsertRelationalDataAsync()

async System.Threading.Tasks.Task<BatchUpsertRelationalDatasetsResponse> Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

◆ BatchUpsertRelationalDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<BatchUpsertRelationalDatasetsResponse> Lusid.Sdk.Api.RelationalDatasetsApi.BatchUpsertRelationalDataWithHttpInfo	(	string	relationalDatasetDefinitionScope,
		string	relationalDatasetDefinitionCode,
		Dictionary< string, UpsertRelationalDataPointRequest >	requestBody,
		string?	successMode = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ApiResponse of BatchUpsertRelationalDatasetsResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ BatchUpsertRelationalDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<BatchUpsertRelationalDatasetsResponse> > Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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)

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.RelationalDatasetsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ QueryRelationalData()

PagedResourceListOfRelationalDataPointResponse Lusid.Sdk.Api.RelationalDatasetsApi.QueryRelationalData	(	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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: PagedResourceListOfRelationalDataPointResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ QueryRelationalDataAsync()

async System.Threading.Tasks.Task<PagedResourceListOfRelationalDataPointResponse> Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

◆ QueryRelationalDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDataPointResponse> Lusid.Sdk.Api.RelationalDatasetsApi.QueryRelationalDataWithHttpInfo	(	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`,
		ConfigurationOptions?	opts = `null`
	)

inline

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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfRelationalDataPointResponse

Implements Lusid.Sdk.Api.IRelationalDatasetsApiSync.

◆ QueryRelationalDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDataPointResponse> > Lusid.Sdk.Api.RelationalDatasetsApi.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`
	)

inline

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)

Implements Lusid.Sdk.Api.IRelationalDatasetsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.RelationalDatasetsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationalDatasetsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.RelationalDatasetsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationalDatasetsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationalDatasetsApi() [1/4]

◆ RelationalDatasetsApi() [2/4]

◆ RelationalDatasetsApi() [3/4]

◆ RelationalDatasetsApi() [4/4]

Member Function Documentation

◆ BatchDeleteRelationalData()

◆ BatchDeleteRelationalDataAsync()

◆ BatchDeleteRelationalDataWithHttpInfo()

◆ BatchDeleteRelationalDataWithHttpInfoAsync()

◆ BatchUpsertRelationalData()

◆ BatchUpsertRelationalDataAsync()

◆ BatchUpsertRelationalDataWithHttpInfo()

◆ BatchUpsertRelationalDataWithHttpInfoAsync()

◆ GetBasePath()

◆ QueryRelationalData()

◆ QueryRelationalDataAsync()

◆ QueryRelationalDataWithHttpInfo()

◆ QueryRelationalDataWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory