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

Inheritance diagram for Lusid.Sdk.Api.RelationalDatasetDefinitionApi:

[legend]

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

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

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

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

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

RelationalDatasetDefinition	CreateRelationalDatasetDefinition (CreateRelationalDatasetDefinitionRequest createRelationalDatasetDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition. More...

Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition >	CreateRelationalDatasetDefinitionWithHttpInfo (CreateRelationalDatasetDefinitionRequest createRelationalDatasetDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition. More...

async System.Threading.Tasks.Task< RelationalDatasetDefinition >	CreateRelationalDatasetDefinitionAsync (CreateRelationalDatasetDefinitionRequest createRelationalDatasetDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition > >	CreateRelationalDatasetDefinitionWithHttpInfoAsync (CreateRelationalDatasetDefinitionRequest createRelationalDatasetDefinitionRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition. More...

DeletedEntityResponse	DeleteRelationalDatasetDefinition (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationalDatasetDefinitionWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteRelationalDatasetDefinitionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteRelationalDatasetDefinitionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points. More...

RelationalDatasetDefinition	GetRelationalDatasetDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier. More...

Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition >	GetRelationalDatasetDefinitionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier. More...

async System.Threading.Tasks.Task< RelationalDatasetDefinition >	GetRelationalDatasetDefinitionAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition > >	GetRelationalDatasetDefinitionWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier. More...

PagedResourceListOfRelationalDatasetDefinition	ListRelationalDatasetDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationalDatasetDefinition >	ListRelationalDatasetDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria. More...

async System.Threading.Tasks.Task< PagedResourceListOfRelationalDatasetDefinition >	ListRelationalDatasetDefinitionsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfRelationalDatasetDefinition > >	ListRelationalDatasetDefinitionsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria. More...

RelationalDatasetDefinition	UpdateRelationalDatasetDefinition (string scope, string code, UpdateRelationalDatasetDefinitionRequest? updateRelationalDatasetDefinitionRequest=default(UpdateRelationalDatasetDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition. More...

Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition >	UpdateRelationalDatasetDefinitionWithHttpInfo (string scope, string code, UpdateRelationalDatasetDefinitionRequest? updateRelationalDatasetDefinitionRequest=default(UpdateRelationalDatasetDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< RelationalDatasetDefinition >	UpdateRelationalDatasetDefinitionAsync (string scope, string code, UpdateRelationalDatasetDefinitionRequest? updateRelationalDatasetDefinitionRequest=default(UpdateRelationalDatasetDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition > >	UpdateRelationalDatasetDefinitionWithHttpInfoAsync (string scope, string code, UpdateRelationalDatasetDefinitionRequest? updateRelationalDatasetDefinitionRequest=default(UpdateRelationalDatasetDefinitionRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition. More...

RelationalDatasetDefinition	UpdateRelationalDatasetDetails (string scope, string code, UpdateRelationalDatasetDetails? updateRelationalDatasetDetails=default(UpdateRelationalDatasetDetails?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition >	UpdateRelationalDatasetDetailsWithHttpInfo (string scope, string code, UpdateRelationalDatasetDetails? updateRelationalDatasetDetails=default(UpdateRelationalDatasetDetails?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< RelationalDatasetDefinition >	UpdateRelationalDatasetDetailsAsync (string scope, string code, UpdateRelationalDatasetDetails? updateRelationalDatasetDetails=default(UpdateRelationalDatasetDetails?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition > >	UpdateRelationalDatasetDetailsWithHttpInfoAsync (string scope, string code, UpdateRelationalDatasetDetails? updateRelationalDatasetDetails=default(UpdateRelationalDatasetDetails?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

RelationalDatasetDefinition	UpdateRelationalDatasetFieldSchema (string scope, string code, UpdateRelationalDatasetFieldSchema? updateRelationalDatasetFieldSchema=default(UpdateRelationalDatasetFieldSchema?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition >	UpdateRelationalDatasetFieldSchemaWithHttpInfo (string scope, string code, UpdateRelationalDatasetFieldSchema? updateRelationalDatasetFieldSchema=default(UpdateRelationalDatasetFieldSchema?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< RelationalDatasetDefinition >	UpdateRelationalDatasetFieldSchemaAsync (string scope, string code, UpdateRelationalDatasetFieldSchema? updateRelationalDatasetFieldSchema=default(UpdateRelationalDatasetFieldSchema?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< RelationalDatasetDefinition > >	UpdateRelationalDatasetFieldSchemaWithHttpInfoAsync (string scope, string code, UpdateRelationalDatasetFieldSchema? updateRelationalDatasetFieldSchema=default(UpdateRelationalDatasetFieldSchema?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this 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

◆ RelationalDatasetDefinitionApi() [1/4]

Lusid.Sdk.Api.RelationalDatasetDefinitionApi.RelationalDatasetDefinitionApi ( )

inline

Initializes a new instance of the RelationalDatasetDefinitionApi class.

Returns

◆ RelationalDatasetDefinitionApi() [2/4]

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

inline

Initializes a new instance of the RelationalDatasetDefinitionApi class.

Returns

◆ RelationalDatasetDefinitionApi() [3/4]

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

inline

Initializes a new instance of the RelationalDatasetDefinitionApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ RelationalDatasetDefinitionApi() [4/4]

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

inline

Initializes a new instance of the RelationalDatasetDefinitionApi 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

◆ CreateRelationalDatasetDefinition()

RelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.CreateRelationalDatasetDefinition	(	CreateRelationalDatasetDefinitionRequest	createRelationalDatasetDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition.

Exceptions

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

Parameters

createRelationalDatasetDefinitionRequest	The relational dataset definition to create.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ CreateRelationalDatasetDefinitionAsync()

async System.Threading.Tasks.Task<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.CreateRelationalDatasetDefinitionAsync	(	CreateRelationalDatasetDefinitionRequest	createRelationalDatasetDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition.

Exceptions

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

Parameters

createRelationalDatasetDefinitionRequest	The relational dataset definition to create.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ CreateRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.CreateRelationalDatasetDefinitionWithHttpInfo	(	CreateRelationalDatasetDefinitionRequest	createRelationalDatasetDefinitionRequest,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition.

Exceptions

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

Parameters

createRelationalDatasetDefinitionRequest	The relational dataset definition to create.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ CreateRelationalDatasetDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.CreateRelationalDatasetDefinitionWithHttpInfoAsync	(	CreateRelationalDatasetDefinitionRequest	createRelationalDatasetDefinitionRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

CreateRelationalDatasetDefinition: Create a Relational Dataset Definition Create a new relational dataset definition.

Exceptions

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

Parameters

createRelationalDatasetDefinitionRequest	The relational dataset definition to create.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ DeleteRelationalDatasetDefinition()

DeletedEntityResponse Lusid.Sdk.Api.RelationalDatasetDefinitionApi.DeleteRelationalDatasetDefinition	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ DeleteRelationalDatasetDefinitionAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.DeleteRelationalDatasetDefinitionAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ DeleteRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.DeleteRelationalDatasetDefinitionWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ DeleteRelationalDatasetDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.DeleteRelationalDatasetDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition Delete a relational dataset definition. WARNING! This operation is irreversible. Deleting a relational dataset definition will also delete all associated data points.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ GetRelationalDatasetDefinition()

RelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.GetRelationalDatasetDefinition	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ GetRelationalDatasetDefinitionAsync()

async System.Threading.Tasks.Task<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.GetRelationalDatasetDefinitionAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ GetRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.GetRelationalDatasetDefinitionWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ GetRelationalDatasetDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.GetRelationalDatasetDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetRelationalDatasetDefinition: Get a Relational Dataset Definition Retrieve a relational dataset definition by its identifier.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
asAt	The asAt datetime at which to retrieve the relational dataset definition. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ ListRelationalDatasetDefinitions()

PagedResourceListOfRelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.ListRelationalDatasetDefinitions	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfRelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ ListRelationalDatasetDefinitionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfRelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.ListRelationalDatasetDefinitionsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfRelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ ListRelationalDatasetDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.ListRelationalDatasetDefinitionsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfRelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ ListRelationalDatasetDefinitionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.ListRelationalDatasetDefinitionsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListRelationalDatasetDefinitions: List Relational Dataset Definitions List all relational dataset definitions matching particular criteria.

Exceptions

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

Parameters

asAt	The asAt datetime at which to list the relational dataset definitions. Defaults to return the latest version if not specified. (optional)
page	The pagination token to use to continue listing relational dataset definitions from a previous call to list relational dataset definitions. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfRelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetDefinition()

RelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDefinition	(	string	scope,
		string	code,
		UpdateRelationalDatasetDefinitionRequest?	updateRelationalDatasetDefinitionRequest = `default(UpdateRelationalDatasetDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDefinitionRequest	The updated relational dataset definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetDefinitionAsync()

async System.Threading.Tasks.Task<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDefinitionAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetDefinitionRequest?	updateRelationalDatasetDefinitionRequest = `default(UpdateRelationalDatasetDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDefinitionRequest	The updated relational dataset definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDefinitionWithHttpInfo	(	string	scope,
		string	code,
		UpdateRelationalDatasetDefinitionRequest?	updateRelationalDatasetDefinitionRequest = `default(UpdateRelationalDatasetDefinitionRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDefinitionRequest	The updated relational dataset definition. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetDefinitionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDefinitionWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetDefinitionRequest?	updateRelationalDatasetDefinitionRequest = `default(UpdateRelationalDatasetDefinitionRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDefinition: Update a Relational Dataset Definition Update an existing relational dataset definition. Applicable only to the definitions that are not yet in use i.e. there are no DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDefinitionRequest	The updated relational dataset definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetDetails()

RelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDetails	(	string	scope,
		string	code,
		UpdateRelationalDatasetDetails?	updateRelationalDatasetDetails = `default(UpdateRelationalDatasetDetails?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDetails	The updated details of the relational dataset. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetDetailsAsync()

async System.Threading.Tasks.Task<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDetailsAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetDetails?	updateRelationalDatasetDetails = `default(UpdateRelationalDatasetDetails?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDetails	The updated details of the relational dataset. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetDetailsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDetailsWithHttpInfo	(	string	scope,
		string	code,
		UpdateRelationalDatasetDetails?	updateRelationalDatasetDetails = `default(UpdateRelationalDatasetDetails?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDetails	The updated details of the relational dataset. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetDetailsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetDetailsWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetDetails?	updateRelationalDatasetDetails = `default(UpdateRelationalDatasetDetails?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetDetails: Update Relational Dataset Details: DisplayName, Description and ApplicableEntityTypes Update an existing relational dataset definition. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetDetails	The updated details of the relational dataset. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetFieldSchema()

RelationalDatasetDefinition Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetFieldSchema	(	string	scope,
		string	code,
		UpdateRelationalDatasetFieldSchema?	updateRelationalDatasetFieldSchema = `default(UpdateRelationalDatasetFieldSchema?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetFieldSchema	Relational dataset fields to add, update or remove. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetFieldSchemaAsync()

async System.Threading.Tasks.Task<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetFieldSchemaAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetFieldSchema?	updateRelationalDatasetFieldSchema = `default(UpdateRelationalDatasetFieldSchema?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetFieldSchema	Relational dataset fields to add, update or remove. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetFieldSchemaWithHttpInfo	(	string	scope,
		string	code,
		UpdateRelationalDatasetFieldSchema?	updateRelationalDatasetFieldSchema = `default(UpdateRelationalDatasetFieldSchema?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetFieldSchema	Relational dataset fields to add, update or remove. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of RelationalDatasetDefinition

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> > Lusid.Sdk.Api.RelationalDatasetDefinitionApi.UpdateRelationalDatasetFieldSchemaWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdateRelationalDatasetFieldSchema?	updateRelationalDatasetFieldSchema = `default(UpdateRelationalDatasetFieldSchema?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema Update an existing relational dataset definition with the new field schema. Applicable only to the definitions that are already in use i.e. contain DataPoints associated with this definition.

Exceptions

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

Parameters

scope	The scope of the relational dataset definition.
code	The code of the relational dataset definition.
updateRelationalDatasetFieldSchema	Relational dataset fields to add, update or remove. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (RelationalDatasetDefinition)

Implements Lusid.Sdk.Api.IRelationalDatasetDefinitionApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.RelationalDatasetDefinitionApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.RelationalDatasetDefinitionApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.RelationalDatasetDefinitionApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.RelationalDatasetDefinitionApi.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/RelationalDatasetDefinitionApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RelationalDatasetDefinitionApi() [1/4]

◆ RelationalDatasetDefinitionApi() [2/4]

◆ RelationalDatasetDefinitionApi() [3/4]

◆ RelationalDatasetDefinitionApi() [4/4]

Member Function Documentation

◆ CreateRelationalDatasetDefinition()

◆ CreateRelationalDatasetDefinitionAsync()

◆ CreateRelationalDatasetDefinitionWithHttpInfo()

◆ CreateRelationalDatasetDefinitionWithHttpInfoAsync()

◆ DeleteRelationalDatasetDefinition()

◆ DeleteRelationalDatasetDefinitionAsync()

◆ DeleteRelationalDatasetDefinitionWithHttpInfo()

◆ DeleteRelationalDatasetDefinitionWithHttpInfoAsync()

◆ GetBasePath()

◆ GetRelationalDatasetDefinition()

◆ GetRelationalDatasetDefinitionAsync()

◆ GetRelationalDatasetDefinitionWithHttpInfo()

◆ GetRelationalDatasetDefinitionWithHttpInfoAsync()

◆ ListRelationalDatasetDefinitions()

◆ ListRelationalDatasetDefinitionsAsync()

◆ ListRelationalDatasetDefinitionsWithHttpInfo()

◆ ListRelationalDatasetDefinitionsWithHttpInfoAsync()

◆ UpdateRelationalDatasetDefinition()

◆ UpdateRelationalDatasetDefinitionAsync()

◆ UpdateRelationalDatasetDefinitionWithHttpInfo()

◆ UpdateRelationalDatasetDefinitionWithHttpInfoAsync()

◆ UpdateRelationalDatasetDetails()

◆ UpdateRelationalDatasetDetailsAsync()

◆ UpdateRelationalDatasetDetailsWithHttpInfo()

◆ UpdateRelationalDatasetDetailsWithHttpInfoAsync()

◆ UpdateRelationalDatasetFieldSchema()

◆ UpdateRelationalDatasetFieldSchemaAsync()

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfo()

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory