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

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

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

Public Member Functions

DeletedEntityResponse DeleteExecution (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteExecution: Delete execution More...
 
ApiResponse< DeletedEntityResponseDeleteExecutionWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteExecution: Delete execution More...
 
Execution GetExecution (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetExecution: Get Execution More...
 
ApiResponse< ExecutionGetExecutionWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] GetExecution: Get Execution More...
 
PagedResourceListOfExecution ListExecutions (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)
 ListExecutions: List Executions More...
 
ApiResponse< PagedResourceListOfExecutionListExecutionsWithHttpInfo (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)
 ListExecutions: List Executions More...
 
ResourceListOfExecution UpsertExecutions (ExecutionSetRequest? executionSetRequest=default(ExecutionSetRequest?), int operationIndex=0)
 UpsertExecutions: Upsert Execution More...
 
ApiResponse< ResourceListOfExecutionUpsertExecutionsWithHttpInfo (ExecutionSetRequest? executionSetRequest=default(ExecutionSetRequest?), int operationIndex=0)
 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

◆ DeleteExecution()

DeletedEntityResponse Lusid.Sdk.Api.IExecutionsApiSync.DeleteExecution ( string  scope,
string  code,
int  operationIndex = 0 
)

[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.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ DeleteExecutionWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IExecutionsApiSync.DeleteExecutionWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)

[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.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ GetExecution()

Execution Lusid.Sdk.Api.IExecutionsApiSync.GetExecution ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[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.
Returns
Execution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ GetExecutionWithHttpInfo()

ApiResponse<Execution> Lusid.Sdk.Api.IExecutionsApiSync.GetExecutionWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0 
)

[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.
Returns
ApiResponse of Execution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ ListExecutions()

PagedResourceListOfExecution Lusid.Sdk.Api.IExecutionsApiSync.ListExecutions ( 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 
)

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.
Returns
PagedResourceListOfExecution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ ListExecutionsWithHttpInfo()

ApiResponse<PagedResourceListOfExecution> Lusid.Sdk.Api.IExecutionsApiSync.ListExecutionsWithHttpInfo ( 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 
)

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.
Returns
ApiResponse of PagedResourceListOfExecution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ UpsertExecutions()

ResourceListOfExecution Lusid.Sdk.Api.IExecutionsApiSync.UpsertExecutions ( ExecutionSetRequest executionSetRequest = default(ExecutionSetRequest?),
int  operationIndex = 0 
)

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.
Returns
ResourceListOfExecution

Implemented in Lusid.Sdk.Api.ExecutionsApi.

◆ UpsertExecutionsWithHttpInfo()

ApiResponse<ResourceListOfExecution> Lusid.Sdk.Api.IExecutionsApiSync.UpsertExecutionsWithHttpInfo ( ExecutionSetRequest executionSetRequest = default(ExecutionSetRequest?),
int  operationIndex = 0 
)

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.
Returns
ApiResponse of ResourceListOfExecution

Implemented in Lusid.Sdk.Api.ExecutionsApi.


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