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

Inheritance diagram for Lusid.Sdk.Api.IPortfoliosApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteInstrumentEventInstructionAsync (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteInstrumentEventInstructionWithHttpInfoAsync (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteKeyFromPortfolioAccessMetadataAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteKeyFromPortfolioAccessMetadataWithHttpInfoAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePortfolioAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeletePortfolio: Delete portfolio More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePortfolioWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeletePortfolio: Delete portfolio More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePortfolioPropertiesAsync (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeletePortfolioProperties: Delete portfolio properties More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePortfolioPropertiesWithHttpInfoAsync (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	DeletePortfolioProperties: Delete portfolio properties More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePortfolioReturnsAsync (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeletePortfolioReturns: Delete Returns More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePortfolioReturnsWithHttpInfoAsync (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeletePortfolioReturns: Delete Returns More...

System.Threading.Tasks.Task< CompositeDispersionResponse >	GetAggregatedReturnsDispersionMetricsAsync (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric More...

System.Threading.Tasks.Task< ApiResponse< CompositeDispersionResponse > >	GetAggregatedReturnsDispersionMetricsWithHttpInfoAsync (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric More...

System.Threading.Tasks.Task< CompositeBreakdownResponse >	GetCompositeBreakdownAsync (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More...

System.Threading.Tasks.Task< ApiResponse< CompositeBreakdownResponse > >	GetCompositeBreakdownWithHttpInfoAsync (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More...

System.Threading.Tasks.Task< InstrumentEventInstruction >	GetInstrumentEventInstructionAsync (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction More...

System.Threading.Tasks.Task< ApiResponse< InstrumentEventInstruction > >	GetInstrumentEventInstructionWithHttpInfoAsync (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction More...

System.Threading.Tasks.Task< Portfolio >	GetPortfolioAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolio: Get portfolio More...

System.Threading.Tasks.Task< ApiResponse< Portfolio > >	GetPortfolioWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolio: Get portfolio More...

System.Threading.Tasks.Task< ResourceListOfAggregatedReturn >	GetPortfolioAggregateReturnsAsync (string scope, string code, string returnScope, string returnCode, string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? compositeMethod=default(string?), string? period=default(string?), string? outputFrequency=default(string?), List< string >? metrics=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? alternativeIncDate=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfAggregatedReturn > >	GetPortfolioAggregateReturnsWithHttpInfoAsync (string scope, string code, string returnScope, string returnCode, string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? compositeMethod=default(string?), string? period=default(string?), string? outputFrequency=default(string?), List< string >? metrics=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? alternativeIncDate=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More...

System.Threading.Tasks.Task< AggregatedReturnsResponse >	GetPortfolioAggregatedReturnsAsync (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns More...

System.Threading.Tasks.Task< ApiResponse< AggregatedReturnsResponse > >	GetPortfolioAggregatedReturnsWithHttpInfoAsync (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns More...

System.Threading.Tasks.Task< ResourceListOfProcessedCommand >	GetPortfolioCommandsAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolioCommands: Get portfolio commands More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfProcessedCommand > >	GetPortfolioCommandsWithHttpInfoAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolioCommands: Get portfolio commands More...

System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	GetPortfolioMetadataAsync (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio More...

System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	GetPortfolioMetadataWithHttpInfoAsync (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio More...

System.Threading.Tasks.Task< PortfolioProperties >	GetPortfolioPropertiesAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolioProperties: Get portfolio properties More...

System.Threading.Tasks.Task< ApiResponse< PortfolioProperties > >	GetPortfolioPropertiesWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	GetPortfolioProperties: Get portfolio properties More...

System.Threading.Tasks.Task< ResourceListOfPropertyInterval >	GetPortfolioPropertyTimeSeriesAsync (string scope, string code, string propertyKey, string? portfolioEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPropertyInterval > >	GetPortfolioPropertyTimeSeriesWithHttpInfoAsync (string scope, string code, string propertyKey, string? portfolioEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series More...

System.Threading.Tasks.Task< ResourceListOfRelation >	GetPortfolioRelationsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelation > >	GetPortfolioRelationsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations More...

System.Threading.Tasks.Task< ResourceListOfRelationship >	GetPortfolioRelationshipsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfRelationship > >	GetPortfolioRelationshipsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships More...

System.Threading.Tasks.Task< ResourceListOfPerformanceReturn >	GetPortfolioReturnsAsync (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? period=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioReturns: Get Returns More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPerformanceReturn > >	GetPortfolioReturnsWithHttpInfoAsync (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? period=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfolioReturns: Get Returns More...

System.Threading.Tasks.Task< List< AccessMetadataValue > >	GetPortfoliosAccessMetadataByKeyAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object More...

System.Threading.Tasks.Task< ApiResponse< List< AccessMetadataValue > > >	GetPortfoliosAccessMetadataByKeyWithHttpInfoAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object More...

System.Threading.Tasks.Task< PagedResourceListOfInstrumentEventInstruction >	ListInstrumentEventInstructionsAsync (string scope, string code, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfInstrumentEventInstruction > >	ListInstrumentEventInstructionsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions More...

System.Threading.Tasks.Task< ResourceListOfProperty >	ListPortfolioPropertiesAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfProperty > >	ListPortfolioPropertiesWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties More...

System.Threading.Tasks.Task< ResourceListOfPortfolio >	ListPortfoliosAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? query=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListPortfolios: List portfolios More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolio > >	ListPortfoliosWithHttpInfoAsync (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? query=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListPortfolios: List portfolios More...

System.Threading.Tasks.Task< ResourceListOfPortfolio >	ListPortfoliosForScopeAsync (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListPortfoliosForScope: List portfolios for scope More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPortfolio > >	ListPortfoliosForScopeWithHttpInfoAsync (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	ListPortfoliosForScope: List portfolios for scope More...

System.Threading.Tasks.Task< Portfolio >	PatchPortfolioAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] PatchPortfolio: Patch portfolio. More...

System.Threading.Tasks.Task< ApiResponse< Portfolio > >	PatchPortfolioWithHttpInfoAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] PatchPortfolio: Patch portfolio. More...

System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > >	PatchPortfolioAccessMetadataAsync (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. More...

System.Threading.Tasks.Task< ApiResponse< Dictionary< string, List< AccessMetadataValue > > > >	PatchPortfolioAccessMetadataWithHttpInfoAsync (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. More...

System.Threading.Tasks.Task< Portfolio >	UpdatePortfolioAsync (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpdatePortfolio: Update portfolio More...

System.Threading.Tasks.Task< ApiResponse< Portfolio > >	UpdatePortfolioWithHttpInfoAsync (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpdatePortfolio: Update portfolio More...

System.Threading.Tasks.Task< InstrumentEventInstructionsResponse >	UpsertInstrumentEventInstructionsAsync (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More...

System.Threading.Tasks.Task< ApiResponse< InstrumentEventInstructionsResponse > >	UpsertInstrumentEventInstructionsWithHttpInfoAsync (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More...

System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOf >	UpsertPortfolioAccessMetadataAsync (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfAccessMetadataValueOf > >	UpsertPortfolioAccessMetadataWithHttpInfoAsync (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More...

System.Threading.Tasks.Task< PortfolioProperties >	UpsertPortfolioPropertiesAsync (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertPortfolioProperties: Upsert portfolio properties More...

System.Threading.Tasks.Task< ApiResponse< PortfolioProperties > >	UpsertPortfolioPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	UpsertPortfolioProperties: Upsert portfolio properties More...

System.Threading.Tasks.Task< UpsertReturnsResponse >	UpsertPortfolioReturnsAsync (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns More...

System.Threading.Tasks.Task< ApiResponse< UpsertReturnsResponse > >	UpsertPortfolioReturnsWithHttpInfoAsync (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns 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

◆ DeleteInstrumentEventInstructionAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.DeleteInstrumentEventInstructionAsync	(	string	scope,
		string	code,
		string	instrumentEventInstructionId,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction

Delete a particular instruction for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionId	The id of the instruction to be deleted.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteInstrumentEventInstructionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.DeleteInstrumentEventInstructionWithHttpInfoAsync	(	string	scope,
		string	code,
		string	instrumentEventInstructionId,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction

Delete a particular instruction for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionId	The id of the instruction to be deleted.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteKeyFromPortfolioAccessMetadataAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.DeleteKeyFromPortfolioAccessMetadataAsync	(	string	scope,
		string	code,
		string	metadataKey,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule

Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts

Exceptions

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

Parameters

scope	The scope of the Quote Access Metadata Rule to retrieve.
code	Portfolio code
metadataKey	The metadataKey identifying the access metadata entry to delete
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteKeyFromPortfolioAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.DeleteKeyFromPortfolioAccessMetadataWithHttpInfoAsync	(	string	scope,
		string	code,
		string	metadataKey,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule

Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts

Exceptions

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

Parameters

scope	The scope of the Quote Access Metadata Rule to retrieve.
code	Portfolio code
metadataKey	The metadataKey identifying the access metadata entry to delete
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioAsync()

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

DeletePortfolio: Delete portfolio

Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioPropertiesAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.DeletePortfolioPropertiesAsync	(	string	scope,
		string	code,
		List< string >	propertyKeys,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeletePortfolioProperties: Delete portfolio properties

Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeys	The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.DeletePortfolioPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		List< string >	propertyKeys,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

DeletePortfolioProperties: Delete portfolio properties

Delete one or more properties from a particular portfolio. If the properties are time-variant then an effective datetime from which to delete properties must be specified. If the properties are perpetual then it is invalid to specify an effective datetime for deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeys	The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioReturnsAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.DeletePortfolioReturnsAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel	fromEffectiveAt,
		DateTimeOrCutLabel	toEffectiveAt,
		string?	period = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns

Cancel one or more Returns which exist into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to delete the Returns.
toEffectiveAt	The end date from which to delete the Returns.
period	The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioReturnsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.DeletePortfolioReturnsWithHttpInfoAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel	fromEffectiveAt,
		DateTimeOrCutLabel	toEffectiveAt,
		string?	period = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns

Cancel one or more Returns which exist into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to delete the Returns.
toEffectiveAt	The end date from which to delete the Returns.
period	The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioWithHttpInfoAsync()

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

DeletePortfolio: Delete portfolio

Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetAggregatedReturnsDispersionMetricsAsync()

System.Threading.Tasks.Task<CompositeDispersionResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.GetAggregatedReturnsDispersionMetricsAsync	(	string	scope,
		string	code,
		AggregatedReturnsDispersionRequest	aggregatedReturnsDispersionRequest,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric

Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
aggregatedReturnsDispersionRequest	The request used in the AggregatedReturnsDispersionMetric.
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CompositeDispersionResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetAggregatedReturnsDispersionMetricsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CompositeDispersionResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetAggregatedReturnsDispersionMetricsWithHttpInfoAsync	(	string	scope,
		string	code,
		AggregatedReturnsDispersionRequest	aggregatedReturnsDispersionRequest,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric

Calculate the dispersion metric with the Aggregate Returns which are on the specified portfolio. This works only for composites which have at least 6 constituents for a full year in.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
aggregatedReturnsDispersionRequest	The request used in the AggregatedReturnsDispersionMetric.
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CompositeDispersionResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetCompositeBreakdownAsync()

System.Threading.Tasks.Task<CompositeBreakdownResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.GetCompositeBreakdownAsync	(	string	scope,
		string	code,
		CompositeBreakdownRequest	compositeBreakdownRequest,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated

Calculate the Composite Returns and return this with the constituents which are included in this calculation

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
compositeBreakdownRequest	The request used in the GetCompositeBreakdown.
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of CompositeBreakdownResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetCompositeBreakdownWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CompositeBreakdownResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetCompositeBreakdownWithHttpInfoAsync	(	string	scope,
		string	code,
		CompositeBreakdownRequest	compositeBreakdownRequest,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated

Calculate the Composite Returns and return this with the constituents which are included in this calculation

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
compositeBreakdownRequest	The request used in the GetCompositeBreakdown.
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (CompositeBreakdownResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetInstrumentEventInstructionAsync()

System.Threading.Tasks.Task<InstrumentEventInstruction> Lusid.Sdk.Api.IPortfoliosApiAsync.GetInstrumentEventInstructionAsync	(	string	scope,
		string	code,
		string	instrumentEventInstructionId,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction

Get a particular instruction for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionId	The id of the instruction to be retrieved.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentEventInstruction

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetInstrumentEventInstructionWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentEventInstruction> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetInstrumentEventInstructionWithHttpInfoAsync	(	string	scope,
		string	code,
		string	instrumentEventInstructionId,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction

Get a particular instruction for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionId	The id of the instruction to be retrieved.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentEventInstruction)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregatedReturnsAsync()

System.Threading.Tasks.Task<AggregatedReturnsResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioAggregatedReturnsAsync	(	string	scope,
		string	code,
		AggregatedReturnsRequest	aggregatedReturnsRequest,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns

Aggregate Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
aggregatedReturnsRequest	The request used in the AggregatedReturns.
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AggregatedReturnsResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregatedReturnsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AggregatedReturnsResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioAggregatedReturnsWithHttpInfoAsync	(	string	scope,
		string	code,
		AggregatedReturnsRequest	aggregatedReturnsRequest,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioAggregatedReturns: Aggregated Returns

Aggregate Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
aggregatedReturnsRequest	The request used in the AggregatedReturns.
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AggregatedReturnsResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregateReturnsAsync()

System.Threading.Tasks.Task<ResourceListOfAggregatedReturn> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioAggregateReturnsAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		string?	recipeIdScope = `default(string?)`,
		string?	recipeIdCode = `default(string?)`,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	compositeMethod = `default(string?)`,
		string?	period = `default(string?)`,
		string?	outputFrequency = `default(string?)`,
		List< string >?	metrics = `default(List< string >?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	alternativeIncDate = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).

Aggregate Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
recipeIdScope	The Recipe Scope for getting the fx rates (optional)
recipeIdCode	The Recipe Code for getting the fx rates (optional)
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
compositeMethod	The method used to calculate the Portfolio performance: Equal/Asset. (optional)
period	The type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequency	The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metrics	Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDate	The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfAggregatedReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregateReturnsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAggregatedReturn> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioAggregateReturnsWithHttpInfoAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		string?	recipeIdScope = `default(string?)`,
		string?	recipeIdCode = `default(string?)`,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	compositeMethod = `default(string?)`,
		string?	period = `default(string?)`,
		string?	outputFrequency = `default(string?)`,
		List< string >?	metrics = `default(List< string >?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		DateTimeOrCutLabel?	alternativeIncDate = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).

Aggregate Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
recipeIdScope	The Recipe Scope for getting the fx rates (optional)
recipeIdCode	The Recipe Code for getting the fx rates (optional)
fromEffectiveAt	The start date from which to calculate the Returns. (optional)
toEffectiveAt	The end date for which to calculate the Returns. (optional)
compositeMethod	The method used to calculate the Portfolio performance: Equal/Asset. (optional)
period	The type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequency	The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metrics	Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDate	The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfAggregatedReturn)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAsync()

System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetPortfolio: Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
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)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommandsAsync()

System.Threading.Tasks.Task<ResourceListOfProcessedCommand> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioCommandsAsync	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetPortfolioCommands: Get portfolio commands

Get all the commands that modified a particular portfolio, including any input transactions.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommandsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfProcessedCommand> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioCommandsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	fromAsAt = `default(DateTimeOffset?)`,
		DateTimeOffset?	toAsAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetPortfolioCommands: Get portfolio commands

Get all the commands that modified a particular portfolio, including any input transactions.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfProcessedCommand)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioMetadataAsync	(	string	scope,
		string	code,
		string?	effectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio

Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule to retrieve.
code	Portfolio code
effectiveAt	The effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAt	The asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioMetadataWithHttpInfoAsync	(	string	scope,
		string	code,
		string?	effectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioMetadata: Get access metadata rules for a portfolio

Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule to retrieve.
code	Portfolio code
effectiveAt	The effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAt	The asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertiesAsync()

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

GetPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertiesWithHttpInfoAsync()

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

GetPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioProperties)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertyTimeSeriesAsync()

System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioPropertyTimeSeriesAsync	(	string	scope,
		string	code,
		string	propertyKey,
		string?	portfolioEffectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series

Show the complete time series (history) for a particular portfolio property.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKey	The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
portfolioEffectiveAt	The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filter	Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertyTimeSeriesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioPropertyTimeSeriesWithHttpInfoAsync	(	string	scope,
		string	code,
		string	propertyKey,
		string?	portfolioEffectiveAt = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioPropertyTimeSeries: Get portfolio property time series

Show the complete time series (history) for a particular portfolio property.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKey	The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
portfolioEffectiveAt	The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filter	Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
page	The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPropertyInterval)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationsAsync()

System.Threading.Tasks.Task<ResourceListOfRelation> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioRelationsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations

Get relations for a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfRelation

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationshipsAsync()

System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioRelationshipsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships

Get relationships for a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfRelationship

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationshipsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioRelationshipsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioRelationships: Get portfolio relationships

Get relationships for a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfRelationship)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfRelation> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioRelationsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	filter = `default(string?)`,
		List< string >?	identifierTypes = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations

Get relations for a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfRelation)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturnsAsync()

System.Threading.Tasks.Task<ResourceListOfPerformanceReturn> Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioReturnsAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	period = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioReturns: Get Returns

Get Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to get the Returns. (optional)
toEffectiveAt	The end date from which to get the Returns. (optional)
period	Show the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPerformanceReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturnsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPerformanceReturn> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioReturnsWithHttpInfoAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		DateTimeOrCutLabel?	fromEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOrCutLabel?	toEffectiveAt = `default(DateTimeOrCutLabel?)`,
		string?	period = `default(string?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfolioReturns: Get Returns

Get Returns which are on the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
fromEffectiveAt	The start date from which to get the Returns. (optional)
toEffectiveAt	The end date from which to get the Returns. (optional)
period	Show the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAt	The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPerformanceReturn)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfoliosAccessMetadataByKeyAsync()

System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfoliosAccessMetadataByKeyAsync	(	string	scope,
		string	code,
		string	metadataKey,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object

Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule to retrieve.
code	The code of the portfolio
metadataKey	Key of the metadata to retrieve
effectiveAt	The effective date of the rule (optional)
asAt	The asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of List<AccessMetadataValue>

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfoliosAccessMetadataByKeyWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfoliosAccessMetadataByKeyWithHttpInfoAsync	(	string	scope,
		string	code,
		string	metadataKey,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object

Get a specific portfolio access metadata rule by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule to retrieve.
code	The code of the portfolio
metadataKey	Key of the metadata to retrieve
effectiveAt	The effective date of the rule (optional)
asAt	The asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (List<AccessMetadataValue>)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Portfolio> > Lusid.Sdk.Api.IPortfoliosApiAsync.GetPortfolioWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

GetPortfolio: Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
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)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListInstrumentEventInstructionsAsync()

System.Threading.Tasks.Task<PagedResourceListOfInstrumentEventInstruction> Lusid.Sdk.Api.IPortfoliosApiAsync.ListInstrumentEventInstructionsAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions

Lists all instructions for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
page	The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfInstrumentEventInstruction

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListInstrumentEventInstructionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfInstrumentEventInstruction> > Lusid.Sdk.Api.IPortfoliosApiAsync.ListInstrumentEventInstructionsWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions

Lists all instructions for a particular portfolio

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAt	The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
page	The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfInstrumentEventInstruction)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolioPropertiesAsync()

System.Threading.Tasks.Task<ResourceListOfProperty> Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfolioPropertiesAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results per page to this number. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfProperty

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolioPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfProperty> > Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfolioPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAt	The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional)
page	The pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limit	When paginating, limit the results per page to this number. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfProperty)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfoliosAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	query = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListPortfolios: List portfolios

List all the portfolios matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
query	Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScopeAsync()

System.Threading.Tasks.Task<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfoliosForScopeAsync	(	string	scope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListPortfoliosForScope: List portfolios for scope

List all the portfolios in a particular scope.

Exceptions

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

Parameters

scope	The scope whose portfolios to list.
effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScopeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolio> > Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfoliosForScopeWithHttpInfoAsync	(	string	scope,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListPortfoliosForScope: List portfolios for scope

List all the portfolios in a particular scope.

Exceptions

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

Parameters

scope	The scope whose portfolios to list.
effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPortfolio)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPortfolio> > Lusid.Sdk.Api.IPortfoliosApiAsync.ListPortfoliosWithHttpInfoAsync	(	DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		string?	query = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		List< string >?	relationshipDefinitionIds = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

ListPortfolios: List portfolios

List all the portfolios matching particular criteria.

Exceptions

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

Parameters

effectiveAt	The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
page	The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filter	Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
query	Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional)
propertyKeys	A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPortfolio)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioAccessMetadataAsync()

System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfoliosApiAsync.PatchPortfolioAccessMetadataAsync	(	string	scope,
		string	code,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.

Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule.
code	Portfolio code
accessMetadataOperation	The Json Patch document
effectiveAt	The date this rule will effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.IPortfoliosApiAsync.PatchPortfolioAccessMetadataWithHttpInfoAsync	(	string	scope,
		string	code,
		List< AccessMetadataOperation >	accessMetadataOperation,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.

Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

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

Parameters

scope	The scope of the Portfolio Access Metadata Rule.
code	Portfolio code
accessMetadataOperation	The Json Patch document
effectiveAt	The date this rule will effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioAsync()

System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.IPortfoliosApiAsync.PatchPortfolioAsync	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] PatchPortfolio: Patch portfolio.

Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operation	The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Portfolio> > Lusid.Sdk.Api.IPortfoliosApiAsync.PatchPortfolioWithHttpInfoAsync	(	string	scope,
		string	code,
		List< Operation >	operation,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] PatchPortfolio: Patch portfolio.

Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: CreationDate, InstrumentScopes.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operation	The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolioAsync()

System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.IPortfoliosApiAsync.UpdatePortfolioAsync	(	string	scope,
		string	code,
		UpdatePortfolioRequest	updatePortfolioRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpdatePortfolio: Update portfolio

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequest	The updated portfolio definition.
effectiveAt	The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolioWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Portfolio> > Lusid.Sdk.Api.IPortfoliosApiAsync.UpdatePortfolioWithHttpInfoAsync	(	string	scope,
		string	code,
		UpdatePortfolioRequest	updatePortfolioRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpdatePortfolio: Update portfolio

Update the definition of a particular portfolio. Note that not all elements of a portfolio definition are modifiable due to the potential implications for data already stored.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequest	The updated portfolio definition.
effectiveAt	The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Portfolio)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertInstrumentEventInstructionsAsync()

System.Threading.Tasks.Task<InstrumentEventInstructionsResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertInstrumentEventInstructionsAsync	(	string	scope,
		string	code,
		string	successMode,
		Dictionary< string, InstrumentEventInstructionRequest >	requestBody,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions

Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successMode	Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBody	The instructions to be upserted to the portfolio.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of InstrumentEventInstructionsResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertInstrumentEventInstructionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<InstrumentEventInstructionsResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertInstrumentEventInstructionsWithHttpInfoAsync	(	string	scope,
		string	code,
		string	successMode,
		Dictionary< string, InstrumentEventInstructionRequest >	requestBody,
		DateTimeOrCutLabel?	portfolioEffectiveAt = `default(DateTimeOrCutLabel?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions

Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successMode	Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBody	The instructions to be upserted to the portfolio.
portfolioEffectiveAt	The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (InstrumentEventInstructionsResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioAccessMetadataAsync()

System.Threading.Tasks.Task<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioAccessMetadataAsync	(	string	scope,
		string	code,
		string	metadataKey,
		UpsertPortfolioAccessMetadataRequest	upsertPortfolioAccessMetadataRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID.

Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched

Exceptions

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

Parameters

scope	The scope to use when updating or inserting the Portfolio Access Metadata Rule.
code	Portfolio code
metadataKey	Key of the access metadata to upsert
upsertPortfolioAccessMetadataRequest	The Portfolio Access Metadata Rule to update or insert
effectiveAt	The date this rule will effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfAccessMetadataValueOf

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioAccessMetadataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAccessMetadataValueOf> > Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioAccessMetadataWithHttpInfoAsync	(	string	scope,
		string	code,
		string	metadataKey,
		UpsertPortfolioAccessMetadataRequest	upsertPortfolioAccessMetadataRequest,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	effectiveUntil = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID.

Update or insert one Portfolio Access Metadata Rule in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Portfolio Access Metadata Rule or failure message if unsuccessful It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exists with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched

Exceptions

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

Parameters

scope	The scope to use when updating or inserting the Portfolio Access Metadata Rule.
code	Portfolio code
metadataKey	Key of the access metadata to upsert
upsertPortfolioAccessMetadataRequest	The Portfolio Access Metadata Rule to update or insert
effectiveAt	The date this rule will effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfAccessMetadataValueOf)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioPropertiesAsync()

System.Threading.Tasks.Task<PortfolioProperties> Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioPropertiesAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertPortfolioProperties: Upsert portfolio properties

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which it is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBody	The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioPropertiesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PortfolioProperties> > Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioPropertiesWithHttpInfoAsync	(	string	scope,
		string	code,
		Dictionary< string, Property >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

UpsertPortfolioProperties: Upsert portfolio properties

Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an effectiveFrom datetime from which the property is valid, and an effectiveUntil datetime until which it is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

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

Parameters

scope	The scope of the portfolio.
code	The code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBody	The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PortfolioProperties)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturnsAsync()

System.Threading.Tasks.Task<UpsertReturnsResponse> Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioReturnsAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		List< PerformanceReturn >	performanceReturn,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns

Update or insert returns into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
performanceReturn	This contains the Returns which need to be upsert.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertReturnsResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturnsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<UpsertReturnsResponse> > Lusid.Sdk.Api.IPortfoliosApiAsync.UpsertPortfolioReturnsWithHttpInfoAsync	(	string	scope,
		string	code,
		string	returnScope,
		string	returnCode,
		List< PerformanceReturn >	performanceReturn,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EARLY ACCESS] UpsertPortfolioReturns: Upsert Returns

Update or insert returns into the specified portfolio.

Exceptions

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

Parameters

scope	The scope of the Portfolio.
code	The code of the Portfolio.
returnScope	The scope of the Returns.
returnCode	The code of the Returns.
performanceReturn	This contains the Returns which need to be upsert.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertReturnsResponse)

Implemented in Lusid.Sdk.Api.PortfoliosApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteInstrumentEventInstructionAsync()

◆ DeleteInstrumentEventInstructionWithHttpInfoAsync()

◆ DeleteKeyFromPortfolioAccessMetadataAsync()

◆ DeleteKeyFromPortfolioAccessMetadataWithHttpInfoAsync()

◆ DeletePortfolioAsync()

◆ DeletePortfolioPropertiesAsync()

◆ DeletePortfolioPropertiesWithHttpInfoAsync()

◆ DeletePortfolioReturnsAsync()

◆ DeletePortfolioReturnsWithHttpInfoAsync()

◆ DeletePortfolioWithHttpInfoAsync()

◆ GetAggregatedReturnsDispersionMetricsAsync()

◆ GetAggregatedReturnsDispersionMetricsWithHttpInfoAsync()

◆ GetCompositeBreakdownAsync()

◆ GetCompositeBreakdownWithHttpInfoAsync()

◆ GetInstrumentEventInstructionAsync()

◆ GetInstrumentEventInstructionWithHttpInfoAsync()

◆ GetPortfolioAggregatedReturnsAsync()

◆ GetPortfolioAggregatedReturnsWithHttpInfoAsync()

◆ GetPortfolioAggregateReturnsAsync()

◆ GetPortfolioAggregateReturnsWithHttpInfoAsync()

◆ GetPortfolioAsync()

◆ GetPortfolioCommandsAsync()

◆ GetPortfolioCommandsWithHttpInfoAsync()

◆ GetPortfolioMetadataAsync()

◆ GetPortfolioMetadataWithHttpInfoAsync()

◆ GetPortfolioPropertiesAsync()

◆ GetPortfolioPropertiesWithHttpInfoAsync()

◆ GetPortfolioPropertyTimeSeriesAsync()

◆ GetPortfolioPropertyTimeSeriesWithHttpInfoAsync()

◆ GetPortfolioRelationsAsync()

◆ GetPortfolioRelationshipsAsync()

◆ GetPortfolioRelationshipsWithHttpInfoAsync()

◆ GetPortfolioRelationsWithHttpInfoAsync()

◆ GetPortfolioReturnsAsync()

◆ GetPortfolioReturnsWithHttpInfoAsync()

◆ GetPortfoliosAccessMetadataByKeyAsync()

◆ GetPortfoliosAccessMetadataByKeyWithHttpInfoAsync()

◆ GetPortfolioWithHttpInfoAsync()

◆ ListInstrumentEventInstructionsAsync()

◆ ListInstrumentEventInstructionsWithHttpInfoAsync()

◆ ListPortfolioPropertiesAsync()

◆ ListPortfolioPropertiesWithHttpInfoAsync()

◆ ListPortfoliosAsync()

◆ ListPortfoliosForScopeAsync()

◆ ListPortfoliosForScopeWithHttpInfoAsync()

◆ ListPortfoliosWithHttpInfoAsync()

◆ PatchPortfolioAccessMetadataAsync()

◆ PatchPortfolioAccessMetadataWithHttpInfoAsync()

◆ PatchPortfolioAsync()

◆ PatchPortfolioWithHttpInfoAsync()

◆ UpdatePortfolioAsync()

◆ UpdatePortfolioWithHttpInfoAsync()

◆ UpsertInstrumentEventInstructionsAsync()

◆ UpsertInstrumentEventInstructionsWithHttpInfoAsync()

◆ UpsertPortfolioAccessMetadataAsync()

◆ UpsertPortfolioAccessMetadataWithHttpInfoAsync()

◆ UpsertPortfolioPropertiesAsync()

◆ UpsertPortfolioPropertiesWithHttpInfoAsync()

◆ UpsertPortfolioReturnsAsync()

◆ UpsertPortfolioReturnsWithHttpInfoAsync()