LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteAllocationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] DeleteAllocation: Delete allocation More... | |
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > | DeleteAllocationWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[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)) |
[EARLY ACCESS] GetAllocation: Get Allocation More... | |
System.Threading.Tasks.Task< 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 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)) |
[EARLY ACCESS] ListAllocations: 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? 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 More... | |
System.Threading.Tasks.Task< ResourceListOfAllocation > | UpsertAllocationsAsync (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations More... | |
System.Threading.Tasks.Task< ApiResponse< ResourceListOfAllocation > > | UpsertAllocationsWithHttpInfoAsync (AllocationSetRequest? allocationSetRequest=default(AllocationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] UpsertAllocations: 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... | |
Represents a collection of functions to interact with the API endpoints
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) |
||
) |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IAllocationsApiAsync.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's creation datetime. This means that the allocation will no longer exist at any effective datetime from the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
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) |
||
) |
[EARLY ACCESS] GetAllocation: Get Allocation
Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
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 >?) , |
||
int | operationIndex = 0 , |
||
System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
) |
[EARLY ACCESS] GetAllocation: Get Allocation
Fetch an Allocation matching the provided identifier
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
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) |
||
) |
[EARLY ACCESS] ListAllocations: List Allocations
Fetch the last pre-AsAt date version of each allocation in scope (does not fetch the entire history).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
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? | 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).
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
System.Threading.Tasks.Task<ResourceListOfAllocation> Lusid.Sdk.Api.IAllocationsApiAsync.UpsertAllocationsAsync | ( | AllocationSetRequest? | allocationSetRequest = default(AllocationSetRequest?) , |
int | operationIndex = 0 , |
||
System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations
Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implemented in Lusid.Sdk.Api.AllocationsApi.
System.Threading.Tasks.Task<ApiResponse<ResourceListOfAllocation> > Lusid.Sdk.Api.IAllocationsApiAsync.UpsertAllocationsWithHttpInfoAsync | ( | AllocationSetRequest? | allocationSetRequest = default(AllocationSetRequest?) , |
int | operationIndex = 0 , |
||
System.Threading.CancellationToken | cancellationToken = default(System.Threading.CancellationToken) |
||
) |
[EARLY ACCESS] UpsertAllocations: Upsert Allocations
Upsert; update existing allocations with given ids, or create new allocations otherwise.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
allocationSetRequest | The collection of allocation requests. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implemented in Lusid.Sdk.Api.AllocationsApi.