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

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

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

Public Member Functions

 PortfoliosApi ()
 Initializes a new instance of the PortfoliosApi class. More...
 
 PortfoliosApi (string basePath)
 Initializes a new instance of the PortfoliosApi class. More...
 
 PortfoliosApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the PortfoliosApi class using Configuration object More...
 
 PortfoliosApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the PortfoliosApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
DeletedEntityResponse DeleteInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteInstrumentEventInstructionAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Delete a particular instruction for a particular portfolio More...
 
DeletedEntityResponse DeleteKeyFromPortfolioAccessMetadata (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeleteKeyFromPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeleteKeyFromPortfolioAccessMetadataAsync (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))
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts More...
 
DeletedEntityResponse DeletePortfolio (string scope, string code, int operationIndex=0)
 DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePortfolioWithHttpInfo (string scope, string code, int operationIndex=0)
 DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePortfolioAsync (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&#39;s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > 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&#39;s creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion. More...
 
DeletedEntityResponse DeletePortfolioProperties (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 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. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePortfolioPropertiesWithHttpInfo (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 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. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePortfolioPropertiesAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
DeletedEntityResponse DeletePortfolioReturns (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponseDeletePortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio. More...
 
async System.Threading.Tasks.Task< DeletedEntityResponseDeletePortfolioReturnsAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Cancel one or more Returns which exist into the specified portfolio. More...
 
CompositeDispersionResponse GetAggregatedReturnsDispersionMetrics (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< CompositeDispersionResponseGetAggregatedReturnsDispersionMetricsWithHttpInfo (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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. More...
 
async System.Threading.Tasks.Task< CompositeDispersionResponseGetAggregatedReturnsDispersionMetricsAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
CompositeBreakdownResponse GetCompositeBreakdown (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
Lusid.Sdk.Client.ApiResponse< CompositeBreakdownResponseGetCompositeBreakdownWithHttpInfo (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
async System.Threading.Tasks.Task< CompositeBreakdownResponseGetCompositeBreakdownAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Calculate the Composite Returns and return this with the constituents which are included in this calculation More...
 
InstrumentEventInstruction GetInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio More...
 
Lusid.Sdk.Client.ApiResponse< InstrumentEventInstructionGetInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio More...
 
async System.Threading.Tasks.Task< InstrumentEventInstructionGetInstrumentEventInstructionAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Get a particular instruction for a particular portfolio More...
 
Portfolio GetPortfolio (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)
 GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioGetPortfolioWithHttpInfo (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)
 GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio. More...
 
async System.Threading.Tasks.Task< PortfolioGetPortfolioAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Retrieve the definition of a particular portfolio. More...
 
ResourceListOfAggregatedReturn GetPortfolioAggregateReturns (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)
 [DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfAggregatedReturnGetPortfolioAggregateReturnsWithHttpInfo (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)
 [DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfAggregatedReturnGetPortfolioAggregateReturnsAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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). Aggregate Returns which are on the specified portfolio. More...
 
AggregatedReturnsResponse GetPortfolioAggregatedReturns (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< AggregatedReturnsResponseGetPortfolioAggregatedReturnsWithHttpInfo (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio. More...
 
async System.Threading.Tasks.Task< AggregatedReturnsResponseGetPortfolioAggregatedReturnsAsync (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))
 GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio. More...
 
ResourceListOfProcessedCommand GetPortfolioCommands (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)
 GetPortfolioCommands: Get portfolio commands Get all the commands that modified a particular portfolio, including any input transactions. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfProcessedCommandGetPortfolioCommandsWithHttpInfo (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)
 GetPortfolioCommands: Get portfolio commands Get all the commands that modified a particular portfolio, including any input transactions. More...
 
async System.Threading.Tasks.Task< ResourceListOfProcessedCommandGetPortfolioCommandsAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Get all the commands that modified a particular portfolio, including any input transactions. More...
 
Dictionary< string, List< AccessMetadataValue > > GetPortfolioMetadata (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioMetadata: Get access metadata rules for a portfolio Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetPortfolioMetadataWithHttpInfo (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioMetadata: Get access metadata rules for a portfolio Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio More...
 
async 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))
 GetPortfolioMetadata: Get access metadata rules for a portfolio Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 GetPortfolioMetadata: Get access metadata rules for a portfolio Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio More...
 
PortfolioProperties GetPortfolioProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioPropertiesGetPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio. More...
 
async System.Threading.Tasks.Task< PortfolioPropertiesGetPortfolioPropertiesAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the properties of a particular portfolio. More...
 
ResourceListOfPropertyInterval GetPortfolioPropertyTimeSeries (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)
 GetPortfolioPropertyTimeSeries: Get portfolio property time series Show the complete time series (history) for a particular portfolio property. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyIntervalGetPortfolioPropertyTimeSeriesWithHttpInfo (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)
 GetPortfolioPropertyTimeSeries: Get portfolio property time series Show the complete time series (history) for a particular portfolio property. More...
 
async System.Threading.Tasks.Task< ResourceListOfPropertyIntervalGetPortfolioPropertyTimeSeriesAsync (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))
 GetPortfolioPropertyTimeSeries: Get portfolio property time series Show the complete time series (history) for a particular portfolio property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 GetPortfolioPropertyTimeSeries: Get portfolio property time series Show the complete time series (history) for a particular portfolio property. More...
 
ResourceListOfRelation GetPortfolioRelations (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)
 [EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationGetPortfolioRelationsWithHttpInfo (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)
 [EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationGetPortfolioRelationsAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Get relations for a particular portfolio. More...
 
ResourceListOfRelationship GetPortfolioRelationships (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)
 GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationshipGetPortfolioRelationshipsWithHttpInfo (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)
 GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfRelationshipGetPortfolioRelationshipsAsync (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))
 GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio. More...
 
ResourceListOfPerformanceReturn GetPortfolioReturns (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)
 GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPerformanceReturnGetPortfolioReturnsWithHttpInfo (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)
 GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfPerformanceReturnGetPortfolioReturnsAsync (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))
 GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio. More...
 
List< AccessMetadataValueGetPortfoliosAccessMetadataByKey (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > GetPortfoliosAccessMetadataByKeyWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
async 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 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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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 More...
 
PagedResourceListOfInstrumentEventInstruction ListInstrumentEventInstructions (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)
 [EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrumentEventInstructionListInstrumentEventInstructionsWithHttpInfo (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)
 [EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio More...
 
async System.Threading.Tasks.Task< PagedResourceListOfInstrumentEventInstructionListInstrumentEventInstructionsAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Lists all instructions for a particular portfolio More...
 
ResourceListOfProperty ListPortfolioProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyListPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio. More...
 
async System.Threading.Tasks.Task< ResourceListOfPropertyListPortfolioPropertiesAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the properties of a particular portfolio. More...
 
ResourceListOfPortfolio ListPortfolios (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)
 ListPortfolios: List portfolios List all the portfolios matching particular criteria. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolioListPortfoliosWithHttpInfo (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)
 ListPortfolios: List portfolios List all the portfolios matching particular criteria. More...
 
async System.Threading.Tasks.Task< ResourceListOfPortfolioListPortfoliosAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the portfolios matching particular criteria. More...
 
ResourceListOfPortfolio ListPortfoliosForScope (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)
 ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolioListPortfoliosForScopeWithHttpInfo (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)
 ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope. More...
 
async System.Threading.Tasks.Task< ResourceListOfPortfolioListPortfoliosForScopeAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the portfolios in a particular scope. More...
 
Portfolio PatchPortfolio (string scope, string code, List< Operation > operation, int operationIndex=0)
 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. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioPatchPortfolioWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0)
 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. More...
 
async System.Threading.Tasks.Task< PortfolioPatchPortfolioAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Portfolio > > PatchPortfolioWithHttpInfoAsync (string scope, string code, List< Operation > operation, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 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. More...
 
Dictionary< string, List< AccessMetadataValue > > PatchPortfolioAccessMetadata (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [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 &#39;add&#39; 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. More...
 
Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchPortfolioAccessMetadataWithHttpInfo (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [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 &#39;add&#39; 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. More...
 
async 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. Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only &#39;add&#39; 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. More...
 
Portfolio UpdatePortfolio (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 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. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioUpdatePortfolioWithHttpInfo (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 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. More...
 
async System.Threading.Tasks.Task< PortfolioUpdatePortfolioAsync (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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
InstrumentEventInstructionsResponse UpsertInstrumentEventInstructions (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings More...
 
Lusid.Sdk.Client.ApiResponse< InstrumentEventInstructionsResponseUpsertInstrumentEventInstructionsWithHttpInfo (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings More...
 
async System.Threading.Tasks.Task< InstrumentEventInstructionsResponseUpsertInstrumentEventInstructionsAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Batch upsert for instrument event instructions, for the portfolio or individual holdings More...
 
ResourceListOfAccessMetadataValueOf UpsertPortfolioAccessMetadata (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOfUpsertPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
async System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOfUpsertPortfolioAccessMetadataAsync (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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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 More...
 
PortfolioProperties UpsertPortfolioProperties (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0)
 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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...
 
Lusid.Sdk.Client.ApiResponse< PortfolioPropertiesUpsertPortfolioPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0)
 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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...
 
async System.Threading.Tasks.Task< PortfolioPropertiesUpsertPortfolioPropertiesAsync (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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More...
 
UpsertReturnsResponse UpsertPortfolioReturns (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0)
 UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio. More...
 
Lusid.Sdk.Client.ApiResponse< UpsertReturnsResponseUpsertPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0)
 UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio. More...
 
async System.Threading.Tasks.Task< UpsertReturnsResponseUpsertPortfolioReturnsAsync (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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))
 UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio. More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- 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

Constructor & Destructor Documentation

◆ PortfoliosApi() [1/4]

Lusid.Sdk.Api.PortfoliosApi.PortfoliosApi ( )
inline

Initializes a new instance of the PortfoliosApi class.

Returns

◆ PortfoliosApi() [2/4]

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

Initializes a new instance of the PortfoliosApi class.

Returns

◆ PortfoliosApi() [3/4]

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

Initializes a new instance of the PortfoliosApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ PortfoliosApi() [4/4]

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

Initializes a new instance of the PortfoliosApi class using a Configuration object and client instance.

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ DeleteInstrumentEventInstruction()

DeletedEntityResponse Lusid.Sdk.Api.PortfoliosApi.DeleteInstrumentEventInstruction ( string  scope,
string  code,
string  instrumentEventInstructionId,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be deleted.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeleteInstrumentEventInstructionAsync()

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

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be deleted.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeleteInstrumentEventInstructionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.DeleteInstrumentEventInstructionWithHttpInfo ( string  scope,
string  code,
string  instrumentEventInstructionId,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be deleted.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeleteInstrumentEventInstructionWithHttpInfoAsync()

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

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction Delete a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be deleted.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeleteKeyFromPortfolioAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.PortfoliosApi.DeleteKeyFromPortfolioAccessMetadata ( string  scope,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
codePortfolio code
metadataKeyThe metadataKey identifying the access metadata entry to delete
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeleteKeyFromPortfolioAccessMetadataAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
codePortfolio code
metadataKeyThe metadataKey identifying the access metadata entry to delete
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeleteKeyFromPortfolioAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.DeleteKeyFromPortfolioAccessMetadataWithHttpInfo ( string  scope,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
codePortfolio code
metadataKeyThe metadataKey identifying the access metadata entry to delete
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeleteKeyFromPortfolioAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Quote Access Metadata Rule to retrieve.
codePortfolio code
metadataKeyThe metadataKey identifying the access metadata entry to delete
effectiveAtThe effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntilThe effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolio()

DeletedEntityResponse Lusid.Sdk.Api.PortfoliosApi.DeletePortfolio ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioAsync()

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

DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolioProperties()

DeletedEntityResponse Lusid.Sdk.Api.PortfoliosApi.DeletePortfolioProperties ( string  scope,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioPropertiesAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolioPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.DeletePortfolioPropertiesWithHttpInfo ( string  scope,
string  code,
List< string >  propertyKeys,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioPropertiesWithHttpInfoAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolioReturns()

DeletedEntityResponse Lusid.Sdk.Api.PortfoliosApi.DeletePortfolioReturns ( string  scope,
string  code,
string  returnScope,
string  returnCode,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
string?  period = default(string?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to delete the Returns.
toEffectiveAtThe end date from which to delete the Returns.
periodThe Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioReturnsAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to delete the Returns.
toEffectiveAtThe end date from which to delete the Returns.
periodThe Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolioReturnsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.DeletePortfolioReturnsWithHttpInfo ( string  scope,
string  code,
string  returnScope,
string  returnCode,
DateTimeOrCutLabel  fromEffectiveAt,
DateTimeOrCutLabel  toEffectiveAt,
string?  period = default(string?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to delete the Returns.
toEffectiveAtThe end date from which to delete the Returns.
periodThe Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioReturnsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns Cancel one or more Returns which exist into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to delete the Returns.
toEffectiveAtThe end date from which to delete the Returns.
periodThe Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ DeletePortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PortfoliosApi.DeletePortfolioWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ DeletePortfolioWithHttpInfoAsync()

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

DeletePortfolio: Delete portfolio Delete a particular portfolio. The deletion will take effect from the portfolio&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetAggregatedReturnsDispersionMetrics()

CompositeDispersionResponse Lusid.Sdk.Api.PortfoliosApi.GetAggregatedReturnsDispersionMetrics ( string  scope,
string  code,
AggregatedReturnsDispersionRequest  aggregatedReturnsDispersionRequest,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
CompositeDispersionResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetAggregatedReturnsDispersionMetricsAsync()

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

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CompositeDispersionResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetAggregatedReturnsDispersionMetricsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CompositeDispersionResponse> Lusid.Sdk.Api.PortfoliosApi.GetAggregatedReturnsDispersionMetricsWithHttpInfo ( string  scope,
string  code,
AggregatedReturnsDispersionRequest  aggregatedReturnsDispersionRequest,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of CompositeDispersionResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetAggregatedReturnsDispersionMetricsWithHttpInfoAsync()

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

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CompositeDispersionResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetBasePath()

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

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetCompositeBreakdown()

CompositeBreakdownResponse Lusid.Sdk.Api.PortfoliosApi.GetCompositeBreakdown ( string  scope,
string  code,
CompositeBreakdownRequest  compositeBreakdownRequest,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
compositeBreakdownRequestThe request used in the GetCompositeBreakdown.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
CompositeBreakdownResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetCompositeBreakdownAsync()

async System.Threading.Tasks.Task<CompositeBreakdownResponse> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
compositeBreakdownRequestThe request used in the GetCompositeBreakdown.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CompositeBreakdownResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetCompositeBreakdownWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CompositeBreakdownResponse> Lusid.Sdk.Api.PortfoliosApi.GetCompositeBreakdownWithHttpInfo ( string  scope,
string  code,
CompositeBreakdownRequest  compositeBreakdownRequest,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
compositeBreakdownRequestThe request used in the GetCompositeBreakdown.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of CompositeBreakdownResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetCompositeBreakdownWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<CompositeBreakdownResponse> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
compositeBreakdownRequestThe request used in the GetCompositeBreakdown.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CompositeBreakdownResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetInstrumentEventInstruction()

InstrumentEventInstruction Lusid.Sdk.Api.PortfoliosApi.GetInstrumentEventInstruction ( string  scope,
string  code,
string  instrumentEventInstructionId,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be retrieved.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
InstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetInstrumentEventInstructionAsync()

async System.Threading.Tasks.Task<InstrumentEventInstruction> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be retrieved.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of InstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetInstrumentEventInstructionWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<InstrumentEventInstruction> Lusid.Sdk.Api.PortfoliosApi.GetInstrumentEventInstructionWithHttpInfo ( string  scope,
string  code,
string  instrumentEventInstructionId,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be retrieved.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of InstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetInstrumentEventInstructionWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InstrumentEventInstruction> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction Get a particular instruction for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
instrumentEventInstructionIdThe id of the instruction to be retrieved.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (InstrumentEventInstruction)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolio()

Portfolio Lusid.Sdk.Api.PortfoliosApi.GetPortfolio ( 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 
)
inline

GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioAggregatedReturns()

AggregatedReturnsResponse Lusid.Sdk.Api.PortfoliosApi.GetPortfolioAggregatedReturns ( string  scope,
string  code,
AggregatedReturnsRequest  aggregatedReturnsRequest,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsRequestThe request used in the AggregatedReturns.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
AggregatedReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioAggregatedReturnsAsync()

async System.Threading.Tasks.Task<AggregatedReturnsResponse> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsRequestThe request used in the AggregatedReturns.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AggregatedReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioAggregatedReturnsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AggregatedReturnsResponse> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioAggregatedReturnsWithHttpInfo ( string  scope,
string  code,
AggregatedReturnsRequest  aggregatedReturnsRequest,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsRequestThe request used in the AggregatedReturns.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of AggregatedReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioAggregatedReturnsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AggregatedReturnsResponse> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioAggregatedReturns: Aggregated Returns Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsRequestThe request used in the AggregatedReturns.
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AggregatedReturnsResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioAggregateReturns()

ResourceListOfAggregatedReturn Lusid.Sdk.Api.PortfoliosApi.GetPortfolioAggregateReturns ( 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 
)
inline

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines 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)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe 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)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAggregatedReturn

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioAggregateReturnsAsync()

async System.Threading.Tasks.Task<ResourceListOfAggregatedReturn> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines 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)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAggregatedReturn

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioAggregateReturnsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAggregatedReturn> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioAggregateReturnsWithHttpInfo ( 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 
)
inline

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines 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)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAggregatedReturn

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioAggregateReturnsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAggregatedReturn> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines 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)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAggregatedReturn)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioAsync()

async System.Threading.Tasks.Task<Portfolio> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioCommands()

ResourceListOfProcessedCommand Lusid.Sdk.Api.PortfoliosApi.GetPortfolioCommands ( 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the results. For example, to filter on the User ID, specify &quot;userId.id eq &#39;string&#39;&quot;. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfProcessedCommand

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioCommandsAsync()

async System.Threading.Tasks.Task<ResourceListOfProcessedCommand> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the results. For example, to filter on the User ID, specify &quot;userId.id eq &#39;string&#39;&quot;. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfProcessedCommand

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioCommandsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfProcessedCommand> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioCommandsWithHttpInfo ( 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the results. For example, to filter on the User ID, specify &quot;userId.id eq &#39;string&#39;&quot;. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfProcessedCommand

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioCommandsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfProcessedCommand> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the results. For example, to filter on the User ID, specify &quot;userId.id eq &#39;string&#39;&quot;. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results to this number. Defaults to 500 if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfProcessedCommand)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.PortfoliosApi.GetPortfolioMetadata ( string  scope,
string  code,
string?  effectiveAt = default(string?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codePortfolio code
effectiveAtThe effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioMetadataAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codePortfolio code
effectiveAtThe effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PortfoliosApi.GetPortfolioMetadataWithHttpInfo ( string  scope,
string  code,
string?  effectiveAt = default(string?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codePortfolio code
effectiveAtThe effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioMetadataWithHttpInfoAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codePortfolio code
effectiveAtThe effectiveAt datetime at which to retrieve the access metadata rule. (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioProperties()

PortfolioProperties Lusid.Sdk.Api.PortfoliosApi.GetPortfolioProperties ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioPropertiesAsync()

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

GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioProperties> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioPropertiesWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioPropertiesWithHttpInfoAsync()

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

GetPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioProperties)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.PortfoliosApi.GetPortfolioPropertyTimeSeries ( 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioPropertyTimeSeriesAsync()

async System.Threading.Tasks.Task<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioPropertyTimeSeriesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioPropertyTimeSeriesWithHttpInfo ( 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 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioPropertyTimeSeriesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPropertyInterval)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioRelations()

ResourceListOfRelation Lusid.Sdk.Api.PortfoliosApi.GetPortfolioRelations ( 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 
)
inline

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelation

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioRelationsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelation> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelation

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.PortfoliosApi.GetPortfolioRelationships ( 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 
)
inline

GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioRelationshipsAsync()

async System.Threading.Tasks.Task<ResourceListOfRelationship> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioRelationshipsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioRelationshipsWithHttpInfo ( 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 
)
inline

GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelationship

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioRelationshipsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioRelationships: Get portfolio relationships Get relationships for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relationships. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. An Empty array may be used to return all related Entities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelationship)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioRelationsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioRelationsWithHttpInfo ( 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 
)
inline

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfRelation

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioRelationsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations Get relations for a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional)
filterExpression to filter the relations. Provide a null or empty string for this field until further notice. (optional)
identifierTypesIdentifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the &#39;Person&#39; or &#39;LegalEntity&#39; domains and have the format {domain}/{scope}/{code}, for example &#39;Person/CompanyDetails/Role&#39;. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfRelation)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioReturns()

ResourceListOfPerformanceReturn Lusid.Sdk.Api.PortfoliosApi.GetPortfolioReturns ( 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 
)
inline

GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to get the Returns. (optional)
toEffectiveAtThe end date from which to get the Returns. (optional)
periodShow the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPerformanceReturn

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioReturnsAsync()

async System.Threading.Tasks.Task<ResourceListOfPerformanceReturn> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to get the Returns. (optional)
toEffectiveAtThe end date from which to get the Returns. (optional)
periodShow the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPerformanceReturn

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioReturnsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPerformanceReturn> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioReturnsWithHttpInfo ( 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 
)
inline

GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to get the Returns. (optional)
toEffectiveAtThe end date from which to get the Returns. (optional)
periodShow the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPerformanceReturn

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioReturnsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPerformanceReturn> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolioReturns: Get Returns Get Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
fromEffectiveAtThe start date from which to get the Returns. (optional)
toEffectiveAtThe end date from which to get the Returns. (optional)
periodShow the Returns on a Daily or Monthly period. Defaults to Daily. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPerformanceReturn)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfoliosAccessMetadataByKey()

List<AccessMetadataValue> Lusid.Sdk.Api.PortfoliosApi.GetPortfoliosAccessMetadataByKey ( string  scope,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codeThe code of the portfolio
metadataKeyKey of the metadata to retrieve
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
Returns
List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfoliosAccessMetadataByKeyAsync()

async System.Threading.Tasks.Task<List<AccessMetadataValue> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codeThe code of the portfolio
metadataKeyKey of the metadata to retrieve
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfoliosAccessMetadataByKeyWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.PortfoliosApi.GetPortfoliosAccessMetadataByKeyWithHttpInfo ( string  scope,
string  code,
string  metadataKey,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codeThe code of the portfolio
metadataKeyKey of the metadata to retrieve
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of List<AccessMetadataValue>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfoliosAccessMetadataByKeyWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule to retrieve.
codeThe code of the portfolio
metadataKeyKey of the metadata to retrieve
effectiveAtThe effective date of the rule (optional)
asAtThe asAt datetime at which to retrieve the portfolio access metadata. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (List<AccessMetadataValue>)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ GetPortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.PortfoliosApi.GetPortfolioWithHttpInfo ( 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 
)
inline

GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ GetPortfolioWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Portfolio> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

GetPortfolio: Get portfolio Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Portfolio)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListInstrumentEventInstructions()

PagedResourceListOfInstrumentEventInstruction Lusid.Sdk.Api.PortfoliosApi.ListInstrumentEventInstructions ( 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 
)
inline

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfInstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListInstrumentEventInstructionsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfInstrumentEventInstruction> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfInstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListInstrumentEventInstructionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventInstruction> Lusid.Sdk.Api.PortfoliosApi.ListInstrumentEventInstructionsWithHttpInfo ( 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 
)
inline

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfInstrumentEventInstruction

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListInstrumentEventInstructionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventInstruction> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfInstrumentEventInstruction)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfolioProperties()

ResourceListOfProperty Lusid.Sdk.Api.PortfoliosApi.ListPortfolioProperties ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results per page to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfProperty

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfolioPropertiesAsync()

async System.Threading.Tasks.Task<ResourceListOfProperty> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results per page to this number. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfProperty

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfolioPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfProperty> Lusid.Sdk.Api.PortfoliosApi.ListPortfolioPropertiesWithHttpInfo ( string  scope,
string  code,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results per page to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfProperty

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfolioPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfProperty> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties List all the properties of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to list the portfolio&#39;s properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio&#39;s properties. Defaults to returning the latest version of each property if not specified. (optional)
pageThe pagination token to use to continue listing commands; this value is returned from the previous call. (optional)
limitWhen paginating, limit the results per page to this number. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfProperty)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfolios()

ResourceListOfPortfolio Lusid.Sdk.Api.PortfoliosApi.ListPortfolios ( 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 
)
inline

ListPortfolios: List portfolios List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfoliosAsync()

async System.Threading.Tasks.Task<ResourceListOfPortfolio> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

ListPortfolios: List portfolios List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfoliosForScope()

ResourceListOfPortfolio Lusid.Sdk.Api.PortfoliosApi.ListPortfoliosForScope ( 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 
)
inline

ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfoliosForScopeAsync()

async System.Threading.Tasks.Task<ResourceListOfPortfolio> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfoliosForScopeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.PortfoliosApi.ListPortfoliosForScopeWithHttpInfo ( 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 
)
inline

ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfoliosForScopeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

ListPortfoliosForScope: List portfolios for scope List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPortfolio)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ ListPortfoliosWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.PortfoliosApi.ListPortfoliosWithHttpInfo ( 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 
)
inline

ListPortfolios: List portfolios List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPortfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ ListPortfoliosWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

ListPortfolios: List portfolios List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfPortfolio)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ PatchPortfolio()

Portfolio Lusid.Sdk.Api.PortfoliosApi.PatchPortfolio ( string  scope,
string  code,
List< Operation operation,
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ PatchPortfolioAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.PortfoliosApi.PatchPortfolioAccessMetadata ( string  scope,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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 &#39;add&#39; 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule.
codePortfolio code
accessMetadataOperationThe Json Patch document
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ PatchPortfolioAccessMetadataAsync()

async System.Threading.Tasks.Task<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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 &#39;add&#39; 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule.
codePortfolio code
accessMetadataOperationThe Json Patch document
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ PatchPortfolioAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.PortfoliosApi.PatchPortfolioAccessMetadataWithHttpInfo ( string  scope,
string  code,
List< AccessMetadataOperation accessMetadataOperation,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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 &#39;add&#39; 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule.
codePortfolio code
accessMetadataOperationThe Json Patch document
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ PatchPortfolioAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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 &#39;add&#39; 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Access Metadata Rule.
codePortfolio code
accessMetadataOperationThe Json Patch document
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ PatchPortfolioAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ PatchPortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.PortfoliosApi.PatchPortfolioWithHttpInfo ( string  scope,
string  code,
List< Operation operation,
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
ApiResponse of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ PatchPortfolioWithHttpInfoAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Portfolio)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpdatePortfolio()

Portfolio Lusid.Sdk.Api.PortfoliosApi.UpdatePortfolio ( string  scope,
string  code,
UpdatePortfolioRequest  updatePortfolioRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequestThe updated portfolio definition.
effectiveAtThe effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpdatePortfolioAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequestThe updated portfolio definition.
effectiveAtThe effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpdatePortfolioWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.PortfoliosApi.UpdatePortfolioWithHttpInfo ( string  scope,
string  code,
UpdatePortfolioRequest  updatePortfolioRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequestThe updated portfolio definition.
effectiveAtThe effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Portfolio

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpdatePortfolioWithHttpInfoAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
updatePortfolioRequestThe updated portfolio definition.
effectiveAtThe effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Portfolio)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertInstrumentEventInstructions()

InstrumentEventInstructionsResponse Lusid.Sdk.Api.PortfoliosApi.UpsertInstrumentEventInstructions ( string  scope,
string  code,
string  successMode,
Dictionary< string, InstrumentEventInstructionRequest requestBody,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successModeWhether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBodyThe instructions to be upserted to the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
InstrumentEventInstructionsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertInstrumentEventInstructionsAsync()

async System.Threading.Tasks.Task<InstrumentEventInstructionsResponse> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successModeWhether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBodyThe instructions to be upserted to the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of InstrumentEventInstructionsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertInstrumentEventInstructionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<InstrumentEventInstructionsResponse> Lusid.Sdk.Api.PortfoliosApi.UpsertInstrumentEventInstructionsWithHttpInfo ( string  scope,
string  code,
string  successMode,
Dictionary< string, InstrumentEventInstructionRequest requestBody,
DateTimeOrCutLabel portfolioEffectiveAt = default(DateTimeOrCutLabel?),
int  operationIndex = 0 
)
inline

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successModeWhether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBodyThe instructions to be upserted to the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of InstrumentEventInstructionsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertInstrumentEventInstructionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<InstrumentEventInstructionsResponse> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions Batch upsert for instrument event instructions, for the portfolio or individual holdings

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
successModeWhether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default)
requestBodyThe instructions to be upserted to the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (InstrumentEventInstructionsResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioAccessMetadata()

ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioAccessMetadata ( string  scope,
string  code,
string  metadataKey,
UpsertPortfolioAccessMetadataRequest  upsertPortfolioAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Portfolio Access Metadata Rule.
codePortfolio code
metadataKeyKey of the access metadata to upsert
upsertPortfolioAccessMetadataRequestThe Portfolio Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioAccessMetadataAsync()

async System.Threading.Tasks.Task<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Portfolio Access Metadata Rule.
codePortfolio code
metadataKeyKey of the access metadata to upsert
upsertPortfolioAccessMetadataRequestThe Portfolio Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioAccessMetadataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioAccessMetadataWithHttpInfo ( string  scope,
string  code,
string  metadataKey,
UpsertPortfolioAccessMetadataRequest  upsertPortfolioAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Portfolio Access Metadata Rule.
codePortfolio code
metadataKeyKey of the access metadata to upsert
upsertPortfolioAccessMetadataRequestThe Portfolio Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAccessMetadataValueOf

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioAccessMetadataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> > Lusid.Sdk.Api.PortfoliosApi.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) 
)
inline

[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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the Portfolio Access Metadata Rule.
codePortfolio code
metadataKeyKey of the access metadata to upsert
upsertPortfolioAccessMetadataRequestThe Portfolio Access Metadata Rule to update or insert
effectiveAtThe date this rule will effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAccessMetadataValueOf)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioProperties()

PortfolioProperties Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioProperties ( string  scope,
string  code,
Dictionary< string, Property requestBody,
int  operationIndex = 0 
)
inline

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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe 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 &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
Returns
PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioPropertiesAsync()

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

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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe 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 &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PortfolioProperties> Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioPropertiesWithHttpInfo ( string  scope,
string  code,
Dictionary< string, Property requestBody,
int  operationIndex = 0 
)
inline

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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe 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 &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioProperties

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioPropertiesWithHttpInfoAsync()

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

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 &#39;Portfolio&#39; domain. Properties have an <i>effectiveFrom</i> datetime from which the property is valid, and an <i>effectiveUntil</i> datetime until which it is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe 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 &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PortfolioProperties)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioReturns()

UpsertReturnsResponse Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioReturns ( string  scope,
string  code,
string  returnScope,
string  returnCode,
List< PerformanceReturn performanceReturn,
int  operationIndex = 0 
)
inline

UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
performanceReturnThis contains the Returns which need to be upsert.
operationIndexIndex associated with the operation.
Returns
UpsertReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioReturnsAsync()

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

UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
performanceReturnThis contains the Returns which need to be upsert.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

◆ UpsertPortfolioReturnsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertReturnsResponse> Lusid.Sdk.Api.PortfoliosApi.UpsertPortfolioReturnsWithHttpInfo ( string  scope,
string  code,
string  returnScope,
string  returnCode,
List< PerformanceReturn performanceReturn,
int  operationIndex = 0 
)
inline

UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
performanceReturnThis contains the Returns which need to be upsert.
operationIndexIndex associated with the operation.
Returns
ApiResponse of UpsertReturnsResponse

Implements Lusid.Sdk.Api.IPortfoliosApiSync.

◆ UpsertPortfolioReturnsWithHttpInfoAsync()

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

UpsertPortfolioReturns: Upsert Returns Update or insert returns into the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
performanceReturnThis contains the Returns which need to be upsert.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertReturnsResponse)

Implements Lusid.Sdk.Api.IPortfoliosApiAsync.

Property Documentation

◆ AsynchronousClient

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

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PortfoliosApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

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

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PortfoliosApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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