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

Inheritance diagram for Lusid.Sdk.Api.IAllocationsApiAsync:

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteAllocationAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete allocation More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteAllocationWithHttpInfoAsync (string scope, string code, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Delete allocation More...

System.Threading.Tasks.Task< Allocation >	GetAllocationAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Allocation More...

System.Threading.Tasks.Task< ApiResponse< Allocation > >	GetAllocationWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Get Allocation More...

System.Threading.Tasks.Task< PagedResourceListOfAllocation >	ListAllocationsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Allocations More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfAllocation > >	ListAllocationsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string page=default(string), List< string > sortBy=default(List< string >), int? start=default(int?), int? limit=default(int?), string filter=default(string), List< string > propertyKeys=default(List< string >), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] List Allocations More...

System.Threading.Tasks.Task< ResourceListOfAllocation >	UpsertAllocationsAsync (AllocationSetRequest allocationSetRequest=default(AllocationSetRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Allocations More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfAllocation > >	UpsertAllocationsWithHttpInfoAsync (AllocationSetRequest allocationSetRequest=default(AllocationSetRequest), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Upsert Allocations 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

◆ DeleteAllocationAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IAllocationsApiAsync.DeleteAllocationAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ DeleteAllocationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IAllocationsApiAsync.DeleteAllocationWithHttpInfoAsync	(	string	scope,
		string	code,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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.
cancellationToken	Cancellation Token to cancel the 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 >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Allocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ GetAllocationWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Allocation> > Lusid.Sdk.Api.IAllocationsApiAsync.GetAllocationWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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)
cancellationToken	Cancellation Token to cancel the 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?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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. Also, if set, a start value cannot be provided. (optional)
sortBy	Allocation the results by these fields. Use use the '-' sign to denote descending allocation e.g. -MyFieldName. (optional)
start	When paginating, skip this number of results. (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, default to "")
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)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ ListAllocationsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfAllocation> > Lusid.Sdk.Api.IAllocationsApiAsync.ListAllocationsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string	page = `default(string)`,
		List< string >	sortBy = `default(List< string >)`,
		int?	start = `default(int?)`,
		int?	limit = `default(int?)`,
		string	filter = `default(string)`,
		List< string >	propertyKeys = `default(List< string >)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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. Also, if set, a start value cannot be provided. (optional)
sortBy	Allocation the results by these fields. Use use the '-' sign to denote descending allocation e.g. -MyFieldName. (optional)
start	When paginating, skip this number of results. (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, default to "")
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)
cancellationToken	Cancellation Token to cancel the 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 = `default(AllocationSetRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfAllocation

Implemented in Lusid.Sdk.Api.AllocationsApi.

◆ UpsertAllocationsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAllocation> > Lusid.Sdk.Api.IAllocationsApiAsync.UpsertAllocationsWithHttpInfoAsync	(	AllocationSetRequest	allocationSetRequest = `default(AllocationSetRequest)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] 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. (optional)
cancellationToken	Cancellation Token to cancel the 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/stable/sdk/Lusid.Sdk/Api/AllocationsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteAllocationAsync()

◆ DeleteAllocationWithHttpInfoAsync()

◆ GetAllocationAsync()

◆ GetAllocationWithHttpInfoAsync()

◆ ListAllocationsAsync()

◆ ListAllocationsWithHttpInfoAsync()

◆ UpsertAllocationsAsync()

◆ UpsertAllocationsWithHttpInfoAsync()