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

Inheritance diagram for Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync:

[legend]

Public Member Functions
RelationalDatasetDefinition	CreateRelationalDatasetDefinition (CreateRelationalDatasetDefinitionRequest createRelationalDatasetDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null)
	CreateRelationalDatasetDefinition: Create a Relational Dataset Definition More...

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

DeletedEntityResponse	DeleteRelationalDatasetDefinition (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteRelationalDatasetDefinitionWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	DeleteRelationalDatasetDefinition: Delete a Relational Dataset Definition More...

RelationalDatasetDefinition	GetRelationalDatasetDefinition (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetRelationalDatasetDefinition: Get a Relational Dataset Definition 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 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 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 More...

RelationalDatasetDefinition	UpdateRelationalDatasetDefinition (string scope, string code, UpdateRelationalDatasetDefinitionRequest? updateRelationalDatasetDefinitionRequest=default(UpdateRelationalDatasetDefinitionRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetDefinition: Update a Relational Dataset 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 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 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 More...

RelationalDatasetDefinition	UpdateRelationalDatasetFieldSchema (string scope, string code, UpdateRelationalDatasetFieldSchema? updateRelationalDatasetFieldSchema=default(UpdateRelationalDatasetFieldSchema?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpdateRelationalDatasetFieldSchema: Update Relational Dataset Field Schema 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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateRelationalDatasetDefinition()

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

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ CreateRelationalDatasetDefinitionWithHttpInfo()

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

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ DeleteRelationalDatasetDefinition()

DeletedEntityResponse Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ DeleteRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ GetRelationalDatasetDefinition()

RelationalDatasetDefinition Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ GetRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ ListRelationalDatasetDefinitions()

PagedResourceListOfRelationalDatasetDefinition Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ ListRelationalDatasetDefinitionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfRelationalDatasetDefinition> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetDefinition()

RelationalDatasetDefinition Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetDefinitionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetDetails()

RelationalDatasetDefinition Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetDetailsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetFieldSchema()

RelationalDatasetDefinition Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<RelationalDatasetDefinition> Lusid.Sdk.Api.IRelationalDatasetDefinitionApiSync.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.

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

Implemented in Lusid.Sdk.Api.RelationalDatasetDefinitionApi.

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/RelationalDatasetDefinitionApi.cs

Public Member Functions

Detailed Description

Member Function Documentation

◆ CreateRelationalDatasetDefinition()

◆ CreateRelationalDatasetDefinitionWithHttpInfo()

◆ DeleteRelationalDatasetDefinition()

◆ DeleteRelationalDatasetDefinitionWithHttpInfo()

◆ GetRelationalDatasetDefinition()

◆ GetRelationalDatasetDefinitionWithHttpInfo()

◆ ListRelationalDatasetDefinitions()

◆ ListRelationalDatasetDefinitionsWithHttpInfo()

◆ UpdateRelationalDatasetDefinition()

◆ UpdateRelationalDatasetDefinitionWithHttpInfo()

◆ UpdateRelationalDatasetDetails()

◆ UpdateRelationalDatasetDetailsWithHttpInfo()

◆ UpdateRelationalDatasetFieldSchema()

◆ UpdateRelationalDatasetFieldSchemaWithHttpInfo()