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

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

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

Public Member Functions

 ParticipationsApi ()
 Initializes a new instance of the ParticipationsApi class. More...
 
 ParticipationsApi (string basePath)
 Initializes a new instance of the ParticipationsApi class. More...
 
 ParticipationsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the ParticipationsApi class using Configuration object More...
 
 ParticipationsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the ParticipationsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
DeletedEntityResponse DeleteParticipation (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation's creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteParticipationWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation&#39;s creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteParticipationAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation&#39;s creation datetime. This means that the participation 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 > > DeleteParticipationWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation&#39;s creation datetime. This means that the participation will no longer exist at any effective datetime from the asAt datetime of deletion. More...
 
Participation GetParticipation (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier More...
 
Lusid.Sdk.Client.ApiResponse< ParticipationGetParticipationWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier More...
 
async System.Threading.Tasks.Task< ParticipationGetParticipationAsync (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), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Participation > > GetParticipationWithHttpInfoAsync (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), ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier More...
 
PagedResourceListOfParticipation ListParticipations (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, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfParticipationListParticipationsWithHttpInfo (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, ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). More...
 
async System.Threading.Tasks.Task< PagedResourceListOfParticipationListParticipationsAsync (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), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfParticipation > > ListParticipationsWithHttpInfoAsync (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), ConfigurationOptions? opts=null)
 [EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation in scope (does not fetch the entire history). More...
 
ResourceListOfParticipation UpsertParticipations (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfParticipationUpsertParticipationsWithHttpInfo (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise. More...
 
async System.Threading.Tasks.Task< ResourceListOfParticipationUpsertParticipationsAsync (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfParticipation > > UpsertParticipationsWithHttpInfoAsync (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations 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...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ ParticipationsApi() [1/4]

Lusid.Sdk.Api.ParticipationsApi.ParticipationsApi ( )
inline

Initializes a new instance of the ParticipationsApi class.

Returns

◆ ParticipationsApi() [2/4]

Lusid.Sdk.Api.ParticipationsApi.ParticipationsApi ( string  basePath)
inline

Initializes a new instance of the ParticipationsApi class.

Returns

◆ ParticipationsApi() [3/4]

Lusid.Sdk.Api.ParticipationsApi.ParticipationsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the ParticipationsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ ParticipationsApi() [4/4]

Lusid.Sdk.Api.ParticipationsApi.ParticipationsApi ( Lusid.Sdk.Client.ISynchronousClient  client,
Lusid.Sdk.Client.IAsynchronousClient  asyncClient,
Lusid.Sdk.Client.IReadableConfiguration  configuration 
)
inline

Initializes a new instance of the ParticipationsApi 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

◆ DeleteParticipation()

DeletedEntityResponse Lusid.Sdk.Api.ParticipationsApi.DeleteParticipation ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation&#39;s creation datetime. This means that the participation 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 participation scope.
codeThe participation&#39;s code. This, together with the scope uniquely identifies the participation to delete.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ DeleteParticipationAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ParticipationsApi.DeleteParticipationAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

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

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ DeleteParticipationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.ParticipationsApi.DeleteParticipationWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] DeleteParticipation: Delete participation Delete an participation. Deletion will be valid from the participation&#39;s creation datetime. This means that the participation 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 participation scope.
codeThe participation&#39;s code. This, together with the scope uniquely identifies the participation to delete.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ DeleteParticipationWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.ParticipationsApi.DeleteParticipationWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

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

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.ParticipationsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

◆ GetParticipation()

Participation Lusid.Sdk.Api.ParticipationsApi.GetParticipation ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier

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

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ GetParticipationAsync()

async System.Threading.Tasks.Task<Participation> Lusid.Sdk.Api.ParticipationsApi.GetParticipationAsync ( 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),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier

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

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ GetParticipationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Participation> Lusid.Sdk.Api.ParticipationsApi.GetParticipationWithHttpInfo ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  propertyKeys = default(List<string>?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier

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

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ GetParticipationWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Participation> > Lusid.Sdk.Api.ParticipationsApi.GetParticipationWithHttpInfoAsync ( 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),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] GetParticipation: Get Participation Fetch a Participation that matches the specified identifier

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

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ ListParticipations()

PagedResourceListOfParticipation Lusid.Sdk.Api.ParticipationsApi.ListParticipations ( 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,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation 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 participation. Defaults to return the latest version of the participation if not specified. (optional)
pageThe pagination token to use to continue listing participations from a previous call to list participations. 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 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;Participation&quot; domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. &quot;Participation/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
PagedResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ ListParticipationsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfParticipation> Lusid.Sdk.Api.ParticipationsApi.ListParticipationsAsync ( 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),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation 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 participation. Defaults to return the latest version of the participation if not specified. (optional)
pageThe pagination token to use to continue listing participations from a previous call to list participations. 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 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;Participation&quot; domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. &quot;Participation/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ ListParticipationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfParticipation> Lusid.Sdk.Api.ParticipationsApi.ListParticipationsWithHttpInfo ( 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,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation 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 participation. Defaults to return the latest version of the participation if not specified. (optional)
pageThe pagination token to use to continue listing participations from a previous call to list participations. 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 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;Participation&quot; domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. &quot;Participation/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of PagedResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ ListParticipationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfParticipation> > Lusid.Sdk.Api.ParticipationsApi.ListParticipationsWithHttpInfoAsync ( 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),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] ListParticipations: List Participations Fetch the last pre-AsAt date version of each Participation 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 participation. Defaults to return the latest version of the participation if not specified. (optional)
pageThe pagination token to use to continue listing participations from a previous call to list participations. 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 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;Participation&quot; domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. &quot;Participation/system/Name&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfParticipation)

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ UpsertParticipations()

ResourceListOfParticipation Lusid.Sdk.Api.ParticipationsApi.UpsertParticipations ( ParticipationSetRequest participationSetRequest = default(ParticipationSetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
participationSetRequestThe collection of participation requests. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ UpsertParticipationsAsync()

async System.Threading.Tasks.Task<ResourceListOfParticipation> Lusid.Sdk.Api.ParticipationsApi.UpsertParticipationsAsync ( ParticipationSetRequest participationSetRequest = default(ParticipationSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
participationSetRequestThe collection of participation requests. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

◆ UpsertParticipationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfParticipation> Lusid.Sdk.Api.ParticipationsApi.UpsertParticipationsWithHttpInfo ( ParticipationSetRequest participationSetRequest = default(ParticipationSetRequest?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
participationSetRequestThe collection of participation requests. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of ResourceListOfParticipation

Implements Lusid.Sdk.Api.IParticipationsApiSync.

◆ UpsertParticipationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfParticipation> > Lusid.Sdk.Api.ParticipationsApi.UpsertParticipationsWithHttpInfoAsync ( ParticipationSetRequest participationSetRequest = default(ParticipationSetRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)
inline

[EARLY ACCESS] UpsertParticipations: Upsert Participation Upsert; update existing participations with given ids, or create new participations otherwise.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
participationSetRequestThe collection of participation requests. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ResourceListOfParticipation)

Implements Lusid.Sdk.Api.IParticipationsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ParticipationsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ParticipationsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ParticipationsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.ParticipationsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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