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

Inheritance diagram for Lusid.Sdk.Api.AllocationsApi:

[legend]

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

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

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

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

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

DeletedEntityResponse	DeleteAllocation (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteAllocationWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteAllocationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeleteAllocationWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion. More...

Allocation	GetAllocation (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...

Lusid.Sdk.Client.ApiResponse< Allocation >	GetAllocationWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...

async System.Threading.Tasks.Task< Allocation >	GetAllocationAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Allocation > >	GetAllocationWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...

PagedResourceListOfAllocation	ListAllocations (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAllocation >	ListAllocationsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More...

async System.Threading.Tasks.Task< PagedResourceListOfAllocation >	ListAllocationsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAllocation > >	ListAllocationsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history). More...

ResourceListOfAllocation	UpsertAllocations (AllocationSetRequest allocationSetRequest, DateTimeOffset? verificationAsAt=default(DateTimeOffset?), bool? retryWithoutChangedEntities=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfAllocation >	UpsertAllocationsWithHttpInfo (AllocationSetRequest allocationSetRequest, DateTimeOffset? verificationAsAt=default(DateTimeOffset?), bool? retryWithoutChangedEntities=default(bool?), int operationIndex=0, ConfigurationOptions? opts=null)
	UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More...

async System.Threading.Tasks.Task< ResourceListOfAllocation >	UpsertAllocationsAsync (AllocationSetRequest allocationSetRequest, DateTimeOffset? verificationAsAt=default(DateTimeOffset?), bool? retryWithoutChangedEntities=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAllocation > >	UpsertAllocationsWithHttpInfoAsync (AllocationSetRequest allocationSetRequest, DateTimeOffset? verificationAsAt=default(DateTimeOffset?), bool? retryWithoutChangedEntities=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. 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

◆ AllocationsApi() [1/4]

Lusid.Sdk.Api.AllocationsApi.AllocationsApi ( )

inline

Initializes a new instance of the AllocationsApi class.

Returns

◆ AllocationsApi() [2/4]

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

inline

Initializes a new instance of the AllocationsApi class.

Returns

◆ AllocationsApi() [3/4]

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

inline

Initializes a new instance of the AllocationsApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ AllocationsApi() [4/4]

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

inline

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

◆ DeleteAllocation()

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

inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The allocation scope.
code	The allocation's code. This, together with the scope uniquely identifies the allocation to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ DeleteAllocationAsync()

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

inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The allocation scope.
code	The allocation's code. This, together with the scope uniquely identifies the allocation to delete.
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.IAllocationsApiAsync.

◆ DeleteAllocationWithHttpInfo()

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

inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The allocation scope.
code	The allocation's code. This, together with the scope uniquely identifies the allocation to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ DeleteAllocationWithHttpInfoAsync()

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

inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The allocation scope.
code	The allocation's code. This, together with the scope uniquely identifies the allocation to delete.
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.IAllocationsApiAsync.

◆ GetAllocation()

Allocation Lusid.Sdk.Api.AllocationsApi.GetAllocation	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier

Exceptions

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

Parameters

scope	The scope to which the allocation belongs.
code	The allocation's unique identifier.
asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Allocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ GetAllocationAsync()

async System.Threading.Tasks.Task<Allocation> Lusid.Sdk.Api.AllocationsApi.GetAllocationAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier

Exceptions

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

Parameters

scope	The scope to which the allocation belongs.
code	The allocation's unique identifier.
asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of Allocation

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ GetAllocationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Allocation> Lusid.Sdk.Api.AllocationsApi.GetAllocationWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier

Exceptions

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

Parameters

scope	The scope to which the allocation belongs.
code	The allocation's unique identifier.
asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Allocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ GetAllocationWithHttpInfoAsync()

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

inline

[EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier

Exceptions

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

Parameters

scope	The scope to which the allocation belongs.
code	The allocation's unique identifier.
asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (Allocation)

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

◆ ListAllocations()

PagedResourceListOfAllocation Lusid.Sdk.Api.AllocationsApi.ListAllocations	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List<string>?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
page	The pagination token to use to continue listing allocations from a previous call to list allocations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ ListAllocationsAsync()

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

inline

ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
page	The pagination token to use to continue listing allocations from a previous call to list allocations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of PagedResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ ListAllocationsWithHttpInfo()

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

inline

ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
page	The pagination token to use to continue listing allocations from a previous call to list allocations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ ListAllocationsWithHttpInfoAsync()

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

inline

ListAllocations: List Allocations Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
page	The pagination token to use to continue listing allocations from a previous call to list allocations. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties 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. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Allocations" domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. "Allocations/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfAllocation)

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ UpsertAllocations()

ResourceListOfAllocation Lusid.Sdk.Api.AllocationsApi.UpsertAllocations	(	AllocationSetRequest	allocationSetRequest,
		DateTimeOffset?	verificationAsAt = `default(DateTimeOffset?)`,
		bool?	retryWithoutChangedEntities = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions

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

Parameters

allocationSetRequest	The collection of allocation requests.
verificationAsAt	An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert. (optional)
retryWithoutChangedEntities	Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted. (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ UpsertAllocationsAsync()

async System.Threading.Tasks.Task<ResourceListOfAllocation> Lusid.Sdk.Api.AllocationsApi.UpsertAllocationsAsync	(	AllocationSetRequest	allocationSetRequest,
		DateTimeOffset?	verificationAsAt = `default(DateTimeOffset?)`,
		bool?	retryWithoutChangedEntities = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions

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

Parameters

allocationSetRequest	The collection of allocation requests.
verificationAsAt	An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert. (optional)
retryWithoutChangedEntities	Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ UpsertAllocationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAllocation> Lusid.Sdk.Api.AllocationsApi.UpsertAllocationsWithHttpInfo	(	AllocationSetRequest	allocationSetRequest,
		DateTimeOffset?	verificationAsAt = `default(DateTimeOffset?)`,
		bool?	retryWithoutChangedEntities = `default(bool?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions

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

Parameters

allocationSetRequest	The collection of allocation requests.
verificationAsAt	An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert. (optional)
retryWithoutChangedEntities	Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted. (optional, default to false)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ UpsertAllocationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAllocation> > Lusid.Sdk.Api.AllocationsApi.UpsertAllocationsWithHttpInfoAsync	(	AllocationSetRequest	allocationSetRequest,
		DateTimeOffset?	verificationAsAt = `default(DateTimeOffset?)`,
		bool?	retryWithoutChangedEntities = `default(bool?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise.

Exceptions

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

Parameters

allocationSetRequest	The collection of allocation requests.
verificationAsAt	An optional verification asAt; individual upserts will fail if an existing entity has been updated between the verification asAt and time of upsert. (optional)
retryWithoutChangedEntities	Optionally choose to keep retrying upsert for remaining entities if some are being updated concurrently. If set to true, any entities that have changed since the verificationAsAt will be dropped from the set of allocations to upsert and the upsert will be retried. The response will only contain the allocations in the original request that have been successfully upserted. (optional, default to false)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfAllocation)

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.AllocationsApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.AllocationsApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.AllocationsApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ AllocationsApi() [1/4]

◆ AllocationsApi() [2/4]

◆ AllocationsApi() [3/4]

◆ AllocationsApi() [4/4]

Member Function Documentation

◆ DeleteAllocation()

◆ DeleteAllocationAsync()

◆ DeleteAllocationWithHttpInfo()

◆ DeleteAllocationWithHttpInfoAsync()

◆ GetAllocation()

◆ GetAllocationAsync()

◆ GetAllocationWithHttpInfo()

◆ GetAllocationWithHttpInfoAsync()

◆ GetBasePath()

◆ ListAllocations()

◆ ListAllocationsAsync()

◆ ListAllocationsWithHttpInfo()

◆ ListAllocationsWithHttpInfoAsync()

◆ UpsertAllocations()

◆ UpsertAllocationsAsync()

◆ UpsertAllocationsWithHttpInfo()

◆ UpsertAllocationsWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory