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

Inheritance diagram for Lusid.Sdk.Api.IEntitiesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< PortfolioEntity >	GetPortfolioByEntityUniqueIdAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId More...

System.Threading.Tasks.Task< ApiResponse< PortfolioEntity > >	GetPortfolioByEntityUniqueIdWithHttpInfoAsync (string entityUniqueId, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId More...

System.Threading.Tasks.Task< ResourceListOfChange >	GetPortfolioChangesAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfChange > >	GetPortfolioChangesWithHttpInfoAsync (string scope, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope. 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

◆ GetPortfolioByEntityUniqueIdAsync()

System.Threading.Tasks.Task<PortfolioEntity> Lusid.Sdk.Api.IEntitiesApiAsync.GetPortfolioByEntityUniqueIdAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId

Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioEntity

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioEntity> > Lusid.Sdk.Api.IEntitiesApiAsync.GetPortfolioByEntityUniqueIdWithHttpInfoAsync	(	string	entityUniqueId,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId

Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to deletion.

Exceptions

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

Parameters

entityUniqueId	The universally unique identifier of the portfolio definition.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioEntity)

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioChangesAsync()

System.Threading.Tasks.Task<ResourceListOfChange> Lusid.Sdk.Api.IEntitiesApiAsync.GetPortfolioChangesAsync	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope.

Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfChange

Implemented in Lusid.Sdk.Api.EntitiesApi.

◆ GetPortfolioChangesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfChange> > Lusid.Sdk.Api.IEntitiesApiAsync.GetPortfolioChangesWithHttpInfoAsync	(	string	scope,
		DateTimeOrCutLabel	effectiveAt,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioChanges: Get the next change to each portfolio in a scope.

Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions).

Exceptions

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

Parameters

scope	The scope
effectiveAt	The effective date of the origin.
asAt	The as-at date of the origin. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfChange)

Implemented in Lusid.Sdk.Api.EntitiesApi.

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/EntitiesApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetPortfolioByEntityUniqueIdAsync()

◆ GetPortfolioByEntityUniqueIdWithHttpInfoAsync()

◆ GetPortfolioChangesAsync()

◆ GetPortfolioChangesWithHttpInfoAsync()