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

Inheritance diagram for Lusid.Sdk.Api.IParticipationsApiSync:

[legend]

Public Member Functions
DeletedEntityResponse	DeleteParticipation (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteParticipation: Delete participation More...

ApiResponse< DeletedEntityResponse >	DeleteParticipationWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] DeleteParticipation: Delete participation 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 More...

ApiResponse< Participation >	GetParticipationWithHttpInfo (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 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 More...

ApiResponse< PagedResourceListOfParticipation >	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)
	[EARLY ACCESS] ListParticipations: List Participations More...

ResourceListOfParticipation	UpsertParticipations (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertParticipations: Upsert Participation More...

ApiResponse< ResourceListOfParticipation >	UpsertParticipationsWithHttpInfo (ParticipationSetRequest? participationSetRequest=default(ParticipationSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EARLY ACCESS] UpsertParticipations: Upsert Participation 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

◆ DeleteParticipation()

DeletedEntityResponse Lusid.Sdk.Api.IParticipationsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The participation scope.
code	The participation's code. This, together with the scope uniquely identifies the participation to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ DeleteParticipationWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IParticipationsApiSync.DeleteParticipationWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The participation scope.
code	The participation's code. This, together with the scope uniquely identifies the participation to delete.
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ GetParticipation()

Participation Lusid.Sdk.Api.IParticipationsApiSync.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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to which the participation belongs.
code	The participation's unique identifier.
asAt	The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. (optional)
propertyKeys	A list of property keys from the "Participation" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. "Participation/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: Participation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ GetParticipationWithHttpInfo()

ApiResponse<Participation> Lusid.Sdk.Api.IParticipationsApiSync.GetParticipationWithHttpInfo	(	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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to which the participation belongs.
code	The participation's unique identifier.
asAt	The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. (optional)
propertyKeys	A list of property keys from the "Participation" domain to decorate onto the participation. These take the format {domain}/{scope}/{code} e.g. "Participation/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of Participation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ ListParticipations()

PagedResourceListOfParticipation Lusid.Sdk.Api.IParticipationsApiSync.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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. (optional)
page	The 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)
sortBy	A list of field names 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 "Participation" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. "Participation/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: PagedResourceListOfParticipation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ ListParticipationsWithHttpInfo()

ApiResponse<PagedResourceListOfParticipation> Lusid.Sdk.Api.IParticipationsApiSync.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`
	)

[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.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to retrieve the participation. Defaults to return the latest version of the participation if not specified. (optional)
page	The 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)
sortBy	A list of field names 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 "Participation" domain to decorate onto each participation. These take the format {domain}/{scope}/{code} e.g. "Participation/system/Name". (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfParticipation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ UpsertParticipations()

ResourceListOfParticipation Lusid.Sdk.Api.IParticipationsApiSync.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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

participationSetRequest	The collection of participation requests. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfParticipation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

◆ UpsertParticipationsWithHttpInfo()

ApiResponse<ResourceListOfParticipation> Lusid.Sdk.Api.IParticipationsApiSync.UpsertParticipationsWithHttpInfo	(	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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

participationSetRequest	The collection of participation requests. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfParticipation

Implemented in Lusid.Sdk.Api.ParticipationsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/ParticipationsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteParticipation()

◆ DeleteParticipationWithHttpInfo()

◆ GetParticipation()

◆ GetParticipationWithHttpInfo()

◆ ListParticipations()

◆ ListParticipationsWithHttpInfo()

◆ UpsertParticipations()

◆ UpsertParticipationsWithHttpInfo()