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

Inheritance diagram for Lusid.Sdk.Api.ISystemConfigurationApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< TransactionSetConfigurationData >	CreateConfigurationTransactionTypeAsync (TransactionConfigurationDataRequest? transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	CreateConfigurationTransactionTypeWithHttpInfoAsync (TransactionConfigurationDataRequest? transactionConfigurationDataRequest=default(TransactionConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type More...

System.Threading.Tasks.Task< TransactionSetConfigurationData >	CreateSideDefinitionAsync (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateSideDefinition: Create side definition More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	CreateSideDefinitionWithHttpInfoAsync (SideConfigurationDataRequest? sideConfigurationDataRequest=default(SideConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateSideDefinition: Create side definition More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteTransactionConfigurationSourceAsync (string source, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteTransactionConfigurationSourceWithHttpInfoAsync (string source, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source More...

System.Threading.Tasks.Task< TransactionSetConfigurationData >	GetTransactionConfigurationSourceAsync (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	GetTransactionConfigurationSourceWithHttpInfoAsync (string source, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source More...

System.Threading.Tasks.Task< TransactionSetConfigurationData >	ListConfigurationTransactionTypesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	ListConfigurationTransactionTypesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types More...

System.Threading.Tasks.Task< TransactionSetConfigurationData >	SetConfigurationTransactionTypesAsync (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	SetConfigurationTransactionTypesWithHttpInfoAsync (TransactionSetConfigurationDataRequest? transactionSetConfigurationDataRequest=default(TransactionSetConfigurationDataRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types More...

System.Threading.Tasks.Task< TransactionSetConfigurationData >	SetTransactionConfigurationSourceAsync (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source More...

System.Threading.Tasks.Task< ApiResponse< TransactionSetConfigurationData > >	SetTransactionConfigurationSourceWithHttpInfoAsync (string source, List< SetTransactionConfigurationSourceRequest > setTransactionConfigurationSourceRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

Member Function Documentation

◆ CreateConfigurationTransactionTypeAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.CreateConfigurationTransactionTypeAsync	(	TransactionConfigurationDataRequest?	transactionConfigurationDataRequest = `default(TransactionConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type

Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest	A transaction type definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ CreateConfigurationTransactionTypeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.CreateConfigurationTransactionTypeWithHttpInfoAsync	(	TransactionConfigurationDataRequest?	transactionConfigurationDataRequest = `default(TransactionConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] CreateConfigurationTransactionType: Create transaction type

Create a new transaction type by specifying a definition and mappings to movements.

Exceptions

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

Parameters

transactionConfigurationDataRequest	A transaction type definition. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ CreateSideDefinitionAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.CreateSideDefinitionAsync	(	SideConfigurationDataRequest?	sideConfigurationDataRequest = `default(SideConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateSideDefinition: Create side definition

Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

sideConfigurationDataRequest	The definition of the side. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ CreateSideDefinitionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.CreateSideDefinitionWithHttpInfoAsync	(	SideConfigurationDataRequest?	sideConfigurationDataRequest = `default(SideConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateSideDefinition: Create side definition

Create a new side definition for use in a transaction type. For more information, see https://support.lusid.com/knowledgebase/article/KA-01875.

Exceptions

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

Parameters

sideConfigurationDataRequest	The definition of the side. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ DeleteTransactionConfigurationSourceAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ISystemConfigurationApiAsync.DeleteTransactionConfigurationSourceAsync	(	string	source,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source

/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to delete transaction configurations for
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ DeleteTransactionConfigurationSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.DeleteTransactionConfigurationSourceWithHttpInfoAsync	(	string	source,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteTransactionConfigurationSource: Delete all transaction configurations for a source

/// WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to delete transaction configurations for
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ GetTransactionConfigurationSourceAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.GetTransactionConfigurationSourceAsync	(	string	source,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source

Returns failure if requested source is not found

Exceptions

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

Parameters

source	The source for which to retrieve transaction configurations
asAt	The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ GetTransactionConfigurationSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.GetTransactionConfigurationSourceWithHttpInfoAsync	(	string	source,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetTransactionConfigurationSource: Get all transaction configurations for a source

Returns failure if requested source is not found

Exceptions

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

Parameters

source	The source for which to retrieve transaction configurations
asAt	The asAt datetime at which to retrieve the transaction configurations. Defaults to returning the latest version of the transaction configurations if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ ListConfigurationTransactionTypesAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.ListConfigurationTransactionTypesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types

Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ ListConfigurationTransactionTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.ListConfigurationTransactionTypesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListConfigurationTransactionTypes: List transaction types

Get the list of current transaction types. For information on the default transaction types provided with LUSID, see https://support.lusid.com/knowledgebase/article/KA-01873/.

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the transaction types. Defaults to returning the latest versions if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ SetConfigurationTransactionTypesAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.SetConfigurationTransactionTypesAsync	(	TransactionSetConfigurationDataRequest?	transactionSetConfigurationDataRequest = `default(TransactionSetConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types

Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

transactionSetConfigurationDataRequest	The complete set of transaction type definitions. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ SetConfigurationTransactionTypesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.SetConfigurationTransactionTypesWithHttpInfoAsync	(	TransactionSetConfigurationDataRequest?	transactionSetConfigurationDataRequest = `default(TransactionSetConfigurationDataRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] SetConfigurationTransactionTypes: Set transaction types

Configure all existing transaction types. Note it is not possible to configure a single existing transaction type on its own. WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

transactionSetConfigurationDataRequest	The complete set of transaction type definitions. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ SetTransactionConfigurationSourceAsync()

System.Threading.Tasks.Task<TransactionSetConfigurationData> Lusid.Sdk.Api.ISystemConfigurationApiAsync.SetTransactionConfigurationSourceAsync	(	string	source,
		List< SetTransactionConfigurationSourceRequest >	setTransactionConfigurationSourceRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source

This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to set the transaction configurations for
setTransactionConfigurationSourceRequest	The set of transaction configurations
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of TransactionSetConfigurationData

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

◆ SetTransactionConfigurationSourceWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<TransactionSetConfigurationData> > Lusid.Sdk.Api.ISystemConfigurationApiAsync.SetTransactionConfigurationSourceWithHttpInfoAsync	(	string	source,
		List< SetTransactionConfigurationSourceRequest >	setTransactionConfigurationSourceRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] SetTransactionConfigurationSource: Set transaction types for a source

This will replace all the existing transaction configurations for the given source WARNING! Changing existing transaction types has a material impact on how data, new and old, is processed and aggregated by LUSID, and will affect your whole organisation. Only call this API if you are fully aware of the implications of the change.

Exceptions

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

Parameters

source	The source to set the transaction configurations for
setTransactionConfigurationSourceRequest	The set of transaction configurations
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (TransactionSetConfigurationData)

Implemented in Lusid.Sdk.Api.SystemConfigurationApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateConfigurationTransactionTypeAsync()

◆ CreateConfigurationTransactionTypeWithHttpInfoAsync()

◆ CreateSideDefinitionAsync()

◆ CreateSideDefinitionWithHttpInfoAsync()

◆ DeleteTransactionConfigurationSourceAsync()

◆ DeleteTransactionConfigurationSourceWithHttpInfoAsync()

◆ GetTransactionConfigurationSourceAsync()

◆ GetTransactionConfigurationSourceWithHttpInfoAsync()

◆ ListConfigurationTransactionTypesAsync()

◆ ListConfigurationTransactionTypesWithHttpInfoAsync()

◆ SetConfigurationTransactionTypesAsync()

◆ SetConfigurationTransactionTypesWithHttpInfoAsync()

◆ SetTransactionConfigurationSourceAsync()

◆ SetTransactionConfigurationSourceWithHttpInfoAsync()