LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IExecutionsApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.IExecutionsApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< DeletedEntityResponseDeleteExecutionAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteExecution: Delete execution More...
 
System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > > DeleteExecutionWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteExecution: Delete execution More...
 
System.Threading.Tasks.Task< ExecutionGetExecutionAsync (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] GetExecution: Get Execution More...
 
System.Threading.Tasks.Task< ApiResponse< Execution > > GetExecutionWithHttpInfoAsync (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] GetExecution: Get Execution More...
 
System.Threading.Tasks.Task< PagedResourceListOfExecutionListExecutionsAsync (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))
 ListExecutions: List Executions More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfExecution > > ListExecutionsWithHttpInfoAsync (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))
 ListExecutions: List Executions More...
 
System.Threading.Tasks.Task< ResourceListOfExecutionUpsertExecutionsAsync (ExecutionSetRequest? executionSetRequest=default(ExecutionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertExecutions: Upsert Execution More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfExecution > > UpsertExecutionsWithHttpInfoAsync (ExecutionSetRequest? executionSetRequest=default(ExecutionSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertExecutions: Upsert Execution 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

◆ DeleteExecutionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IExecutionsApiAsync.DeleteExecutionAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteExecution: Delete execution

Delete an execution. Deletion will be valid from the execution&#39;s creation datetime. This means that the execution 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 execution scope.
codeThe execution&#39;s code. This, together with the scope uniquely identifies the execution to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ DeleteExecutionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IExecutionsApiAsync.DeleteExecutionWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteExecution: Delete execution

Delete an execution. Deletion will be valid from the execution&#39;s creation datetime. This means that the execution 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 execution scope.
codeThe execution&#39;s code. This, together with the scope uniquely identifies the execution to delete.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ GetExecutionAsync()

System.Threading.Tasks.Task<Execution> Lusid.Sdk.Api.IExecutionsApiAsync.GetExecutionAsync ( 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] GetExecution: Get Execution

Fetch a Execution that matches the specified identifier

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

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ GetExecutionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Execution> > Lusid.Sdk.Api.IExecutionsApiAsync.GetExecutionWithHttpInfoAsync ( 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] GetExecution: Get Execution

Fetch a Execution that matches the specified identifier

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

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ ListExecutionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfExecution> Lusid.Sdk.Api.IExecutionsApiAsync.ListExecutionsAsync ( 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) 
)

ListExecutions: List Executions

Fetch the last pre-AsAt date version of each execution 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 execution. Defaults to return the latest version of the execution if not specified. (optional)
pageThe pagination token to use to continue listing execution from a previous call to list executions. 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;Execution&quot; domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. &quot;Execution/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfExecution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ ListExecutionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfExecution> > Lusid.Sdk.Api.IExecutionsApiAsync.ListExecutionsWithHttpInfoAsync ( 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) 
)

ListExecutions: List Executions

Fetch the last pre-AsAt date version of each execution 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 execution. Defaults to return the latest version of the execution if not specified. (optional)
pageThe pagination token to use to continue listing execution from a previous call to list executions. 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;Execution&quot; domain to decorate onto each execution. These take the format {domain}/{scope}/{code} e.g. &quot;Execution/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfExecution)

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ UpsertExecutionsAsync()

System.Threading.Tasks.Task<ResourceListOfExecution> Lusid.Sdk.Api.IExecutionsApiAsync.UpsertExecutionsAsync ( ExecutionSetRequest executionSetRequest = default(ExecutionSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertExecutions: Upsert Execution

Upsert; update existing executions with given ids, or create new executions otherwise.

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

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ UpsertExecutionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfExecution> > Lusid.Sdk.Api.IExecutionsApiAsync.UpsertExecutionsWithHttpInfoAsync ( ExecutionSetRequest executionSetRequest = default(ExecutionSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

UpsertExecutions: Upsert Execution

Upsert; update existing executions with given ids, or create new executions otherwise.

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

Implemented in Lusid.Sdk.Api.ExecutionsApi.


The documentation for this interface was generated from the following file: