LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
BatchUpsertPortfolioAccessMetadataResponse | BatchUpsertPortfolioAccessMetadata (Dictionary< string, BatchUpsertPortfolioAccessMetadataRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? effectiveUntil=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios More... | |
Lusid.Sdk.Client.ApiResponse< BatchUpsertPortfolioAccessMetadataResponse > | BatchUpsertPortfolioAccessMetadataWithHttpInfo (Dictionary< string, BatchUpsertPortfolioAccessMetadataRequest > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? effectiveUntil=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios More... | |
DeletedEntityResponse | DeleteInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction More... | |
DeletedEntityResponse | DeleteKeyFromPortfolioAccessMetadata (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteKeyFromPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More... | |
DeletedEntityResponse | DeletePortfolio (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
DeletePortfolio: Delete portfolio More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeletePortfolioWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null) |
DeletePortfolio: Delete portfolio More... | |
DeletedEntityResponse | DeletePortfolioProperties (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeletePortfolioProperties: Delete portfolio properties More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeletePortfolioPropertiesWithHttpInfo (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
DeletePortfolioProperties: Delete portfolio properties More... | |
DeletedEntityResponse | DeletePortfolioReturns (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePortfolioReturns: Delete Returns More... | |
Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeletePortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] DeletePortfolioReturns: Delete Returns More... | |
CompositeDispersionResponse | GetAggregatedReturnsDispersionMetrics (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric More... | |
Lusid.Sdk.Client.ApiResponse< CompositeDispersionResponse > | GetAggregatedReturnsDispersionMetricsWithHttpInfo (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric More... | |
CompositeBreakdownResponse | GetCompositeBreakdown (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More... | |
Lusid.Sdk.Client.ApiResponse< CompositeBreakdownResponse > | GetCompositeBreakdownWithHttpInfo (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More... | |
InstrumentEventInstruction | GetInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentEventInstruction > | GetInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction 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, ConfigurationOptions? opts=null) |
GetPortfolio: Get portfolio More... | |
Lusid.Sdk.Client.ApiResponse< Portfolio > | 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, ConfigurationOptions? opts=null) |
GetPortfolio: Get 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, ConfigurationOptions? opts=null) |
[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfAggregatedReturn > | 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, ConfigurationOptions? opts=null) |
[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More... | |
AggregatedReturnsResponse | GetPortfolioAggregatedReturns (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetPortfolioAggregatedReturns: Aggregated Returns More... | |
Lusid.Sdk.Client.ApiResponse< AggregatedReturnsResponse > | GetPortfolioAggregatedReturnsWithHttpInfo (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetPortfolioAggregatedReturns: Aggregated Returns 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, ConfigurationOptions? opts=null) |
GetPortfolioCommands: Get portfolio commands More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfProcessedCommand > | 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, ConfigurationOptions? opts=null) |
GetPortfolioCommands: Get portfolio commands More... | |
Dictionary< string, List< AccessMetadataValue > > | GetPortfolioMetadata (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetPortfolioMetadata: Get access metadata rules for 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, ConfigurationOptions? opts=null) |
GetPortfolioMetadata: Get access metadata rules for a portfolio More... | |
PortfolioProperties | GetPortfolioProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetPortfolioProperties: Get portfolio properties More... | |
Lusid.Sdk.Client.ApiResponse< PortfolioProperties > | GetPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
GetPortfolioProperties: Get portfolio properties 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, ConfigurationOptions? opts=null) |
GetPortfolioPropertyTimeSeries: Get portfolio property time series More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > | 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, ConfigurationOptions? opts=null) |
GetPortfolioPropertyTimeSeries: Get portfolio property time series 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, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > | 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, ConfigurationOptions? opts=null) |
[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations 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, ConfigurationOptions? opts=null) |
GetPortfolioRelationships: Get portfolio relationships More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > | 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, ConfigurationOptions? opts=null) |
GetPortfolioRelationships: Get portfolio relationships 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, ConfigurationOptions? opts=null) |
GetPortfolioReturns: Get Returns More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPerformanceReturn > | 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, ConfigurationOptions? opts=null) |
GetPortfolioReturns: Get Returns More... | |
List< AccessMetadataValue > | GetPortfoliosAccessMetadataByKey (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfInstrumentEventInstruction > | 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfProperty > | ListPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties 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, ConfigurationOptions? opts=null) |
ListPortfolios: List portfolios More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolio > | 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, ConfigurationOptions? opts=null) |
ListPortfolios: List portfolios 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, ConfigurationOptions? opts=null) |
ListPortfoliosForScope: List portfolios for scope More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfPortfolio > | 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, ConfigurationOptions? opts=null) |
ListPortfoliosForScope: List portfolios for scope More... | |
Portfolio | PatchPortfolio (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null) |
PatchPortfolio: Patch portfolio. More... | |
Lusid.Sdk.Client.ApiResponse< Portfolio > | PatchPortfolioWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0, ConfigurationOptions? opts=null) |
PatchPortfolio: Patch portfolio. More... | |
Dictionary< string, List< AccessMetadataValue > > | PatchPortfolioAccessMetadata (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. 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, ConfigurationOptions? opts=null) |
[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. More... | |
Portfolio | UpdatePortfolio (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpdatePortfolio: Update portfolio More... | |
Lusid.Sdk.Client.ApiResponse< Portfolio > | UpdatePortfolioWithHttpInfo (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpdatePortfolio: Update portfolio More... | |
InstrumentEventInstructionsResponse | UpsertInstrumentEventInstructions (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More... | |
Lusid.Sdk.Client.ApiResponse< InstrumentEventInstructionsResponse > | UpsertInstrumentEventInstructionsWithHttpInfo (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, ConfigurationOptions? opts=null) |
[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More... | |
ResourceListOfAccessMetadataValueOf | UpsertPortfolioAccessMetadata (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOf > | UpsertPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More... | |
PortfolioProperties | UpsertPortfolioProperties (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioProperties: Upsert portfolio properties More... | |
Lusid.Sdk.Client.ApiResponse< PortfolioProperties > | UpsertPortfolioPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioProperties: Upsert portfolio properties More... | |
UpsertReturnsResponse | UpsertPortfolioReturns (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioReturns: Upsert Returns More... | |
Lusid.Sdk.Client.ApiResponse< UpsertReturnsResponse > | UpsertPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0, ConfigurationOptions? opts=null) |
UpsertPortfolioReturns: Upsert Returns More... | |
Represents a collection of functions to interact with the API endpoints
BatchUpsertPortfolioAccessMetadataResponse Lusid.Sdk.Api.IPortfoliosApiSync.BatchUpsertPortfolioAccessMetadata | ( | Dictionary< string, BatchUpsertPortfolioAccessMetadataRequest > | requestBody, |
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | effectiveUntil = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist and inserted if they do not. No other items will be affected The response will return the successfully updated or inserted Portfolio Access Metadata Rules or a failure message if unsuccessful 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The Access Metadata Rules to upsert and the Portfolio identifiers to upsert for |
effectiveAt | The date these rules will be effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied, this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<BatchUpsertPortfolioAccessMetadataResponse> Lusid.Sdk.Api.IPortfoliosApiSync.BatchUpsertPortfolioAccessMetadataWithHttpInfo | ( | Dictionary< string, BatchUpsertPortfolioAccessMetadataRequest > | requestBody, |
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | effectiveUntil = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] BatchUpsertPortfolioAccessMetadata: Upsert multiple Portfolio Access Metadata Rules to multiple Portfolios
Update or insert multiple Access Metadata rules for multiple Portfolios. Items will be updated if they already exist and inserted if they do not. No other items will be affected The response will return the successfully updated or inserted Portfolio Access Metadata Rules or a failure message if unsuccessful 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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
requestBody | The Access Metadata Rules to upsert and the Portfolio identifiers to upsert for |
effectiveAt | The date these rules will be effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied, this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeleteInstrumentEventInstruction | ( | string | scope, |
string | code, | ||
string | instrumentEventInstructionId, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction
Delete a particular instruction for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
instrumentEventInstructionId | The id of the instruction to be deleted. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeleteInstrumentEventInstructionWithHttpInfo | ( | string | scope, |
string | code, | ||
string | instrumentEventInstructionId, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction
Delete a particular instruction for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
instrumentEventInstructionId | The id of the instruction to be deleted. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeleteKeyFromPortfolioAccessMetadata | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Quote Access Metadata Rule to retrieve. |
code | Portfolio code |
metadataKey | The metadataKey identifying the access metadata entry to delete |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeleteKeyFromPortfolioAccessMetadataWithHttpInfo | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule
Delete the Portfolio Access Metadata Rule that exactly matches the provided identifier parts
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Quote Access Metadata Rule to retrieve. |
code | Portfolio code |
metadataKey | The metadataKey identifying the access metadata entry to delete |
effectiveAt | The effective date to delete at, if this is not supplied, it will delete all data found (optional) |
effectiveUntil | The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolio | ( | string | scope, |
string | code, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeletePortfolio: Delete portfolio
Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioProperties | ( | string | scope, |
string | code, | ||
List< string > | propertyKeys, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
propertyKeys | The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioPropertiesWithHttpInfo | ( | string | scope, |
string | code, | ||
List< string > | propertyKeys, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
propertyKeys | The property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. Each property must be from the 'Portfolio' domain. |
effectiveAt | The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
DeletedEntityResponse Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioReturns | ( | string | scope, |
string | code, | ||
string | returnScope, | ||
string | returnCode, | ||
DateTimeOrCutLabel | fromEffectiveAt, | ||
DateTimeOrCutLabel | toEffectiveAt, | ||
string? | period = default(string?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] DeletePortfolioReturns: Delete Returns
Cancel one or more Returns which exist into the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
fromEffectiveAt | The start date from which to delete the Returns. |
toEffectiveAt | The end date from which to delete the Returns. |
period | The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioReturnsWithHttpInfo | ( | string | scope, |
string | code, | ||
string | returnScope, | ||
string | returnCode, | ||
DateTimeOrCutLabel | fromEffectiveAt, | ||
DateTimeOrCutLabel | toEffectiveAt, | ||
string? | period = default(string?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] DeletePortfolioReturns: Delete Returns
Cancel one or more Returns which exist into the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
fromEffectiveAt | The start date from which to delete the Returns. |
toEffectiveAt | The end date from which to delete the Returns. |
period | The Period (Daily or Monthly) of the Returns to be deleted. Defaults to Daily. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfoliosApiSync.DeletePortfolioWithHttpInfo | ( | string | scope, |
string | code, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
DeletePortfolio: Delete portfolio
Delete a particular portfolio. The deletion will take effect from the portfolio's creation datetime. This means that the portfolio will no longer exist at any effective datetime, as per the asAt datetime of deletion.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
CompositeDispersionResponse Lusid.Sdk.Api.IPortfoliosApiSync.GetAggregatedReturnsDispersionMetrics | ( | string | scope, |
string | code, | ||
AggregatedReturnsDispersionRequest | aggregatedReturnsDispersionRequest, | ||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
aggregatedReturnsDispersionRequest | The request used in the AggregatedReturnsDispersionMetric. |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<CompositeDispersionResponse> Lusid.Sdk.Api.IPortfoliosApiSync.GetAggregatedReturnsDispersionMetricsWithHttpInfo | ( | string | scope, |
string | code, | ||
AggregatedReturnsDispersionRequest | aggregatedReturnsDispersionRequest, | ||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
aggregatedReturnsDispersionRequest | The request used in the AggregatedReturnsDispersionMetric. |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
CompositeBreakdownResponse Lusid.Sdk.Api.IPortfoliosApiSync.GetCompositeBreakdown | ( | string | scope, |
string | code, | ||
CompositeBreakdownRequest | compositeBreakdownRequest, | ||
DateTimeOrCutLabel? | fromEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | toEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
compositeBreakdownRequest | The request used in the GetCompositeBreakdown. |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<CompositeBreakdownResponse> Lusid.Sdk.Api.IPortfoliosApiSync.GetCompositeBreakdownWithHttpInfo | ( | string | scope, |
string | code, | ||
CompositeBreakdownRequest | compositeBreakdownRequest, | ||
DateTimeOrCutLabel? | fromEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | toEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
compositeBreakdownRequest | The request used in the GetCompositeBreakdown. |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
InstrumentEventInstruction Lusid.Sdk.Api.IPortfoliosApiSync.GetInstrumentEventInstruction | ( | string | scope, |
string | code, | ||
string | instrumentEventInstructionId, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction
Get a particular instruction for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
instrumentEventInstructionId | The id of the instruction to be retrieved. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<InstrumentEventInstruction> Lusid.Sdk.Api.IPortfoliosApiSync.GetInstrumentEventInstructionWithHttpInfo | ( | string | scope, |
string | code, | ||
string | instrumentEventInstructionId, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction
Get a particular instruction for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
instrumentEventInstructionId | The id of the instruction to be retrieved. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instruction. Defaults to return the latest version of the instruction if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Portfolio Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolio: Get portfolio
Retrieve the definition of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
AggregatedReturnsResponse Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioAggregatedReturns | ( | string | scope, |
string | code, | ||
AggregatedReturnsRequest | aggregatedReturnsRequest, | ||
DateTimeOrCutLabel? | fromEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | toEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioAggregatedReturns: Aggregated Returns
Aggregate Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
aggregatedReturnsRequest | The request used in the AggregatedReturns. |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<AggregatedReturnsResponse> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioAggregatedReturnsWithHttpInfo | ( | string | scope, |
string | code, | ||
AggregatedReturnsRequest | aggregatedReturnsRequest, | ||
DateTimeOrCutLabel? | fromEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOrCutLabel? | toEffectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioAggregatedReturns: Aggregated Returns
Aggregate Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
aggregatedReturnsRequest | The request used in the AggregatedReturns. |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfAggregatedReturn Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).
Aggregate Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
recipeIdScope | The Recipe Scope for getting the fx rates (optional) |
recipeIdCode | The Recipe Code for getting the fx rates (optional) |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
compositeMethod | The method used to calculate the Portfolio performance: Equal/Asset. (optional) |
period | The type of the returns used to calculate the aggregation result: Daily/Monthly. (optional) |
outputFrequency | The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional) |
metrics | Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
alternativeIncDate | The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfAggregatedReturn> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint).
Aggregate Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
recipeIdScope | The Recipe Scope for getting the fx rates (optional) |
recipeIdCode | The Recipe Code for getting the fx rates (optional) |
fromEffectiveAt | The start date from which to calculate the Returns. (optional) |
toEffectiveAt | The end date for which to calculate the Returns. (optional) |
compositeMethod | The method used to calculate the Portfolio performance: Equal/Asset. (optional) |
period | The type of the returns used to calculate the aggregation result: Daily/Monthly. (optional) |
outputFrequency | The type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional) |
metrics | Determines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
alternativeIncDate | The date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfProcessedCommand Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioCommands: Get portfolio commands
Get all the commands that modified a particular portfolio, including any input transactions.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
fromAsAt | The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) |
toAsAt | The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) |
filter | Expression to filter the results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results to this number. Defaults to 500 if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfProcessedCommand> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioCommands: Get portfolio commands
Get all the commands that modified a particular portfolio, including any input transactions.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
fromAsAt | The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) |
toAsAt | The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) |
filter | Expression to filter the results. For example, to filter on the User ID, specify "userId.id eq 'string'". For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results to this number. Defaults to 500 if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioMetadata | ( | string | scope, |
string | code, | ||
string? | effectiveAt = default(string?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioMetadata: Get access metadata rules for a portfolio
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule to retrieve. |
code | Portfolio code |
effectiveAt | The effectiveAt datetime at which to retrieve the access metadata rule. (optional) |
asAt | The asAt datetime at which to retrieve the portfolio access metadata. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioMetadataWithHttpInfo | ( | string | scope, |
string | code, | ||
string? | effectiveAt = default(string?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioMetadata: Get access metadata rules for a portfolio
Pass the scope and portfolio code parameters to retrieve the AccessMetadata associated with a portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule to retrieve. |
code | Portfolio code |
effectiveAt | The effectiveAt datetime at which to retrieve the access metadata rule. (optional) |
asAt | The asAt datetime at which to retrieve the portfolio access metadata. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
PortfolioProperties Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioProperties | ( | string | scope, |
string | code, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioProperties: Get portfolio properties
List all the properties of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<PortfolioProperties> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfolioPropertiesWithHttpInfo | ( | string | scope, |
string | code, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioProperties: Get portfolio properties
List all the properties of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfPropertyInterval Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioPropertyTimeSeries: Get portfolio property time series
Show the complete time series (history) for a particular portfolio property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
propertyKey | The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. |
portfolioEffectiveAt | The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioPropertyTimeSeries: Get portfolio property time series
Show the complete time series (history) for a particular portfolio property.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
propertyKey | The property key of the property whose history to show. This must be from the 'Portfolio' domain and in the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. |
portfolioEffectiveAt | The effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional) |
filter | Expression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
page | The pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfRelation Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations
Get relations for a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Provide a null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfRelationship Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioRelationships: Get portfolio relationships
Get relationships for a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relationships. Provide a null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioRelationships: Get portfolio relationships
Get relationships for a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve relationships. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relationships. Defaults to returning the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relationships. Provide a null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations
Get relations for a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve relations. Defaults to returning the latest LUSID AsAt time if not specified. (optional) |
filter | Expression to filter the relations. Provide a null or empty string for this field until further notice. (optional) |
identifierTypes | Identifier types (as property keys) used for referencing Persons or Legal Entities. These must be from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. Only identifier types provided will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfPerformanceReturn Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioReturns: Get Returns
Get Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
fromEffectiveAt | The start date from which to get the Returns. (optional) |
toEffectiveAt | The end date from which to get the Returns. (optional) |
period | Show the Returns on a Daily or Monthly period. Defaults to Daily. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfPerformanceReturn> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolioReturns: Get Returns
Get Returns which are on the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
fromEffectiveAt | The start date from which to get the Returns. (optional) |
toEffectiveAt | The end date from which to get the Returns. (optional) |
period | Show the Returns on a Daily or Monthly period. Defaults to Daily. (optional) |
asAt | The asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
List<AccessMetadataValue> Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfoliosAccessMetadataByKey | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule to retrieve. |
code | The code of the portfolio |
metadataKey | Key of the metadata to retrieve |
effectiveAt | The effective date of the rule (optional) |
asAt | The asAt datetime at which to retrieve the portfolio access metadata. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfoliosApiSync.GetPortfoliosAccessMetadataByKeyWithHttpInfo | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule to retrieve. |
code | The code of the portfolio |
metadataKey | Key of the metadata to retrieve |
effectiveAt | The effective date of the rule (optional) |
asAt | The asAt datetime at which to retrieve the portfolio access metadata. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
GetPortfolio: Get portfolio
Retrieve the definition of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
PagedResourceListOfInstrumentEventInstruction Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions
Lists all instructions for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional) |
page | The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<PagedResourceListOfInstrumentEventInstruction> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions
Lists all instructions for a particular portfolio
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
asAt | The asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional) |
page | The pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfProperty Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfolioProperties | ( | string | scope, |
string | code, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
string? | page = default(string?) , |
||
int? | limit = default(int?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties
List all the properties of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfProperty> Lusid.Sdk.Api.IPortfoliosApiSync.ListPortfolioPropertiesWithHttpInfo | ( | string | scope, |
string | code, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | asAt = default(DateTimeOffset?) , |
||
string? | page = default(string?) , |
||
int? | limit = default(int?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties
List all the properties of a particular portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
effectiveAt | The effective datetime or cut label at which to list the portfolio's properties. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolio's properties. Defaults to returning the latest version of each property if not specified. (optional) |
page | The pagination token to use to continue listing commands; this value is returned from the previous call. (optional) |
limit | When paginating, limit the results per page to this number. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfPortfolio Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListPortfolios: List portfolios
List all the portfolios matching particular criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional) |
page | The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
query | Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfPortfolio Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListPortfoliosForScope: List portfolios for scope
List all the portfolios in a particular scope.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope whose portfolios to list. |
effectiveAt | The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional) |
page | The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListPortfoliosForScope: List portfolios for scope
List all the portfolios in a particular scope.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope whose portfolios to list. |
effectiveAt | The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional) |
page | The pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For example, to return only transactions with a transaction type of 'Buy', specify "type eq 'Buy'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfPortfolio> Lusid.Sdk.Api.IPortfoliosApiSync.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 , |
||
ConfigurationOptions? | opts = null |
||
) |
ListPortfolios: List portfolios
List all the portfolios matching particular criteria.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
effectiveAt | The effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional) |
asAt | The asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional) |
page | The pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the results to this number. Defaults to 100 if not specified. (optional) |
filter | Expression to filter the results. For example, to filter on the transaction type, specify "type eq 'Transaction'". For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional) |
sortBy | A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) |
query | Expression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of 'LUID_PPA8HI6M' or a Figi of 'BBG000BLNNH6', specify "instrument.identifiers in (('LusidInstrumentId', 'LUID_PPA8HI6M'), ('Figi', 'BBG000BLNNH6'))". (optional) |
propertyKeys | A list of property keys from the 'Portfolio' domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) |
relationshipDefinitionIds | A list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Portfolio Lusid.Sdk.Api.IPortfoliosApiSync.PatchPortfolio | ( | string | scope, |
string | code, | ||
List< Operation > | operation, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
PatchPortfolio: Patch portfolio.
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: Created, InstrumentScopes, Type.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
operation | The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfoliosApiSync.PatchPortfolioAccessMetadata | ( | string | scope, |
string | code, | ||
List< AccessMetadataOperation > | accessMetadataOperation, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.
Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule. |
code | Portfolio code |
accessMetadataOperation | The Json Patch document |
effectiveAt | The date this rule will effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfoliosApiSync.PatchPortfolioAccessMetadataWithHttpInfo | ( | string | scope, |
string | code, | ||
List< AccessMetadataOperation > | accessMetadataOperation, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio.
Patch Portfolio Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio Access Metadata Rule. |
code | Portfolio code |
accessMetadataOperation | The Json Patch document |
effectiveAt | The date this rule will effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.IPortfoliosApiSync.PatchPortfolioWithHttpInfo | ( | string | scope, |
string | code, | ||
List< Operation > | operation, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
PatchPortfolio: Patch portfolio.
Create or update certain fields for a particular portfolio. The behaviour is defined by the JSON Patch specification. Currently supported are: Created, InstrumentScopes, Type.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
operation | The json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Portfolio Lusid.Sdk.Api.IPortfoliosApiSync.UpdatePortfolio | ( | string | scope, |
string | code, | ||
UpdatePortfolioRequest | updatePortfolioRequest, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
updatePortfolioRequest | The updated portfolio definition. |
effectiveAt | The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<Portfolio> Lusid.Sdk.Api.IPortfoliosApiSync.UpdatePortfolioWithHttpInfo | ( | string | scope, |
string | code, | ||
UpdatePortfolioRequest | updatePortfolioRequest, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
updatePortfolioRequest | The updated portfolio definition. |
effectiveAt | The effective datetime or cut label at which to update the definition. Defaults to the current LUSID system datetime if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
InstrumentEventInstructionsResponse Lusid.Sdk.Api.IPortfoliosApiSync.UpsertInstrumentEventInstructions | ( | string | scope, |
string | code, | ||
string | successMode, | ||
Dictionary< string, InstrumentEventInstructionRequest > | requestBody, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions
Batch upsert for instrument event instructions, for the portfolio or individual holdings
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
successMode | Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default) |
requestBody | The instructions to be upserted to the portfolio. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<InstrumentEventInstructionsResponse> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertInstrumentEventInstructionsWithHttpInfo | ( | string | scope, |
string | code, | ||
string | successMode, | ||
Dictionary< string, InstrumentEventInstructionRequest > | requestBody, | ||
DateTimeOrCutLabel? | portfolioEffectiveAt = default(DateTimeOrCutLabel?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions
Batch upsert for instrument event instructions, for the portfolio or individual holdings
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
successMode | Whether the batch request should fail atomically or in a partial fashion - allowed values: Atomic, Partial (default) |
requestBody | The instructions to be upserted to the portfolio. |
portfolioEffectiveAt | The effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioAccessMetadata | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
UpsertPortfolioAccessMetadataRequest | upsertPortfolioAccessMetadataRequest, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to use when updating or inserting the Portfolio Access Metadata Rule. |
code | Portfolio code |
metadataKey | Key of the access metadata to upsert |
upsertPortfolioAccessMetadataRequest | The Portfolio Access Metadata Rule to update or insert |
effectiveAt | The date this rule will effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioAccessMetadataWithHttpInfo | ( | string | scope, |
string | code, | ||
string | metadataKey, | ||
UpsertPortfolioAccessMetadataRequest | upsertPortfolioAccessMetadataRequest, | ||
DateTimeOrCutLabel? | effectiveAt = default(DateTimeOrCutLabel?) , |
||
DateTimeOffset? | effectiveUntil = default(DateTimeOffset?) , |
||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
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
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope to use when updating or inserting the Portfolio Access Metadata Rule. |
code | Portfolio code |
metadataKey | Key of the access metadata to upsert |
upsertPortfolioAccessMetadataRequest | The Portfolio Access Metadata Rule to update or insert |
effectiveAt | The date this rule will effective from (optional) |
effectiveUntil | The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
PortfolioProperties Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioProperties | ( | string | scope, |
string | code, | ||
Dictionary< string, Property > | requestBody, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
UpsertPortfolioProperties: Upsert portfolio properties
Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
requestBody | The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<PortfolioProperties> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioPropertiesWithHttpInfo | ( | string | scope, |
string | code, | ||
Dictionary< string, Property > | requestBody, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
UpsertPortfolioProperties: Upsert portfolio properties
Create or update one or more properties for a particular portfolio. A property is updated if it already exists and created if it does not. All properties must be from the 'Portfolio' domain. Properties have an <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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the portfolio. |
code | The code of the portfolio. Together with the scope this uniquely identifies the portfolio. |
requestBody | The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
UpsertReturnsResponse Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioReturns | ( | string | scope, |
string | code, | ||
string | returnScope, | ||
string | returnCode, | ||
List< PerformanceReturn > | performanceReturn, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
UpsertPortfolioReturns: Upsert Returns
Update or insert returns into the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
performanceReturn | This contains the Returns which need to be upsert. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.
Lusid.Sdk.Client.ApiResponse<UpsertReturnsResponse> Lusid.Sdk.Api.IPortfoliosApiSync.UpsertPortfolioReturnsWithHttpInfo | ( | string | scope, |
string | code, | ||
string | returnScope, | ||
string | returnCode, | ||
List< PerformanceReturn > | performanceReturn, | ||
int | operationIndex = 0 , |
||
ConfigurationOptions? | opts = null |
||
) |
UpsertPortfolioReturns: Upsert Returns
Update or insert returns into the specified portfolio.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the Portfolio. |
code | The code of the Portfolio. |
returnScope | The scope of the Returns. |
returnCode | The code of the Returns. |
performanceReturn | This contains the Returns which need to be upsert. |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implemented in Lusid.Sdk.Api.PortfoliosApi.