LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.AllocationsApi Class Reference

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

Inheritance diagram for Lusid.Sdk.Api.AllocationsApi:
Inheritance graph
[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)
 [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< DeletedEntityResponseDeleteAllocationWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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< DeletedEntityResponseDeleteAllocationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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))
 [EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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)
 [EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...
 
Lusid.Sdk.Client.ApiResponse< AllocationGetAllocationWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetAllocation: Get Allocation Fetch an Allocation matching the provided identifier More...
 
async System.Threading.Tasks.Task< AllocationGetAllocationAsync (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))
 [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))
 [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)
 [EARLY ACCESS] 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< PagedResourceListOfAllocationListAllocationsWithHttpInfo (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)
 [EARLY ACCESS] 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< PagedResourceListOfAllocationListAllocationsAsync (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))
 [EARLY ACCESS] 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))
 [EARLY ACCESS] 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=default(AllocationSetRequest?), int operationIndex=0)
 UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfAllocationUpsertAllocationsWithHttpInfo (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0)
 UpsertAllocations: Upsert Allocations Upsert; update existing allocations with given ids, or create new allocations otherwise. More...
 
async System.Threading.Tasks.Task< ResourceListOfAllocationUpsertAllocationsAsync (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 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=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 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...
 
- 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

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
configurationAn 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
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ DeleteAllocation()

DeletedEntityResponse Lusid.Sdk.Api.AllocationsApi.DeleteAllocation ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
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) 
)
inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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 
)
inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
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) 
)
inline

[EARLY ACCESS] DeleteAllocation: Delete allocation Delete an allocation. Deletion will be valid from the allocation&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe allocation scope.
codeThe allocation&#39;s code. This, together with the scope uniquely identifies the allocation to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to which the allocation belongs.
codeThe allocation&#39;s unique identifier.
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto the allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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

Implements Lusid.Sdk.Client.IApiAccessor.

◆ 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 
)
inline

[EARLY ACCESS] 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
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) 
)
inline

[EARLY ACCESS] 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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 
)
inline

[EARLY ACCESS] 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
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) 
)
inline

[EARLY ACCESS] 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.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to retrieve the allocation. Defaults to return the latest version of the allocation if not specified. (optional)
pageThe 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Allocations&quot; domain to decorate onto each allocation. These take the format {domain}/{scope}/{code} e.g. &quot;Allocations/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfAllocation)

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ UpsertAllocations()

ResourceListOfAllocation Lusid.Sdk.Api.AllocationsApi.UpsertAllocations ( AllocationSetRequest allocationSetRequest = default(AllocationSetRequest?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiSync.

◆ UpsertAllocationsAsync()

async System.Threading.Tasks.Task<ResourceListOfAllocation> Lusid.Sdk.Api.AllocationsApi.UpsertAllocationsAsync ( AllocationSetRequest allocationSetRequest = default(AllocationSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAllocation

Implements Lusid.Sdk.Api.IAllocationsApiAsync.

◆ UpsertAllocationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAllocation> Lusid.Sdk.Api.AllocationsApi.UpsertAllocationsWithHttpInfo ( AllocationSetRequest allocationSetRequest = default(AllocationSetRequest?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
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 = default(AllocationSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
allocationSetRequestThe collection of allocation requests. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the 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: