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

Inheritance diagram for Lusid.Sdk.Api.IAllocationsApiAsync:

[legend]

Public Member Functions
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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteAllocationAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IAllocationsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ DeleteAllocationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IAllocationsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ GetAllocationAsync()

System.Threading.Tasks.Task<Allocation> Lusid.Sdk.Api.IAllocationsApiAsync.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

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

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ GetAllocationWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Allocation> > Lusid.Sdk.Api.IAllocationsApiAsync.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

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)

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ ListAllocationsAsync()

System.Threading.Tasks.Task<PagedResourceListOfAllocation> Lusid.Sdk.Api.IAllocationsApiAsync.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).

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

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ ListAllocationsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAllocation> > Lusid.Sdk.Api.IAllocationsApiAsync.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).

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)

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ UpsertAllocationsAsync()

System.Threading.Tasks.Task<ResourceListOfAllocation> Lusid.Sdk.Api.IAllocationsApiAsync.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.

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

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ UpsertAllocationsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAllocation> > Lusid.Sdk.Api.IAllocationsApiAsync.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.

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)

Implemented in Lusid.Sdk.Api.AllocationsApi.

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ DeleteAllocationAsync()

◆ DeleteAllocationWithHttpInfoAsync()

◆ GetAllocationAsync()

◆ GetAllocationWithHttpInfoAsync()

◆ ListAllocationsAsync()

◆ ListAllocationsWithHttpInfoAsync()

◆ UpsertAllocationsAsync()

◆ UpsertAllocationsWithHttpInfoAsync()