LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IPortfoliosApiSync Interface Reference

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

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

Public Member Functions

DeletedEntityResponse DeleteInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction More...
 
ApiResponse< DeletedEntityResponseDeleteInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [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)
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More...
 
ApiResponse< DeletedEntityResponseDeleteKeyFromPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule More...
 
DeletedEntityResponse DeletePortfolio (string scope, string code, int operationIndex=0)
 DeletePortfolio: Delete portfolio More...
 
ApiResponse< DeletedEntityResponseDeletePortfolioWithHttpInfo (string scope, string code, int operationIndex=0)
 DeletePortfolio: Delete portfolio More...
 
DeletedEntityResponse DeletePortfolioProperties (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 DeletePortfolioProperties: Delete portfolio properties More...
 
ApiResponse< DeletedEntityResponseDeletePortfolioPropertiesWithHttpInfo (string scope, string code, List< string > propertyKeys, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 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)
 [EARLY ACCESS] DeletePortfolioReturns: Delete Returns More...
 
ApiResponse< DeletedEntityResponseDeletePortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, string? period=default(string?), int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioReturns: Delete Returns More...
 
CompositeDispersionResponse GetAggregatedReturnsDispersionMetrics (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetAggregatedReturnsDispersionMetrics: Get the Aggregated Returns Dispersion metric More...
 
ApiResponse< CompositeDispersionResponseGetAggregatedReturnsDispersionMetricsWithHttpInfo (string scope, string code, AggregatedReturnsDispersionRequest aggregatedReturnsDispersionRequest, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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)
 [EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More...
 
ApiResponse< CompositeBreakdownResponseGetCompositeBreakdownWithHttpInfo (string scope, string code, CompositeBreakdownRequest compositeBreakdownRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetCompositeBreakdown: Get the Composite Breakdown on how the composite Returns are calculated More...
 
InstrumentEventInstruction GetInstrumentEventInstruction (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction More...
 
ApiResponse< InstrumentEventInstructionGetInstrumentEventInstructionWithHttpInfo (string scope, string code, string instrumentEventInstructionId, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction More...
 
Portfolio GetPortfolio (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetPortfolio: Get portfolio More...
 
ApiResponse< PortfolioGetPortfolioWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 GetPortfolio: Get portfolio More...
 
ResourceListOfAggregatedReturn GetPortfolioAggregateReturns (string scope, string code, string returnScope, string returnCode, string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? compositeMethod=default(string?), string? period=default(string?), string? outputFrequency=default(string?), List< string >? metrics=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? alternativeIncDate=default(DateTimeOrCutLabel?), int operationIndex=0)
 [DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More...
 
ApiResponse< ResourceListOfAggregatedReturnGetPortfolioAggregateReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? compositeMethod=default(string?), string? period=default(string?), string? outputFrequency=default(string?), List< string >? metrics=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? alternativeIncDate=default(DateTimeOrCutLabel?), int operationIndex=0)
 [DEPRECATED] GetPortfolioAggregateReturns: Aggregate Returns (This is a deprecated endpoint). More...
 
AggregatedReturnsResponse GetPortfolioAggregatedReturns (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioAggregatedReturns: Aggregated Returns More...
 
ApiResponse< AggregatedReturnsResponseGetPortfolioAggregatedReturnsWithHttpInfo (string scope, string code, AggregatedReturnsRequest aggregatedReturnsRequest, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioAggregatedReturns: Aggregated Returns More...
 
ResourceListOfProcessedCommand GetPortfolioCommands (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 GetPortfolioCommands: Get portfolio commands More...
 
ApiResponse< ResourceListOfProcessedCommandGetPortfolioCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 GetPortfolioCommands: Get portfolio commands More...
 
Dictionary< string, List< AccessMetadataValue > > GetPortfolioMetadata (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioMetadata: Get access metadata rules for a portfolio More...
 
ApiResponse< Dictionary< string, List< AccessMetadataValue > > > GetPortfolioMetadataWithHttpInfo (string scope, string code, string? effectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioMetadata: Get access metadata rules for a portfolio More...
 
PortfolioProperties GetPortfolioProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioProperties: Get portfolio properties More...
 
ApiResponse< PortfolioPropertiesGetPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 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)
 GetPortfolioPropertyTimeSeries: Get portfolio property time series More...
 
ApiResponse< ResourceListOfPropertyIntervalGetPortfolioPropertyTimeSeriesWithHttpInfo (string scope, string code, string propertyKey, string? portfolioEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 GetPortfolioPropertyTimeSeries: Get portfolio property time series More...
 
ResourceListOfRelation GetPortfolioRelations (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations More...
 
ApiResponse< ResourceListOfRelationGetPortfolioRelationsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 [EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations More...
 
ResourceListOfRelationship GetPortfolioRelationships (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetPortfolioRelationships: Get portfolio relationships More...
 
ApiResponse< ResourceListOfRelationshipGetPortfolioRelationshipsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
 GetPortfolioRelationships: Get portfolio relationships More...
 
ResourceListOfPerformanceReturn GetPortfolioReturns (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? period=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioReturns: Get Returns More...
 
ApiResponse< ResourceListOfPerformanceReturnGetPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), string? period=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetPortfolioReturns: Get Returns More...
 
List< AccessMetadataValueGetPortfoliosAccessMetadataByKey (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object More...
 
ApiResponse< List< AccessMetadataValue > > GetPortfoliosAccessMetadataByKeyWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetPortfoliosAccessMetadataByKey: Get an entry identified by a metadataKey in the access metadata object More...
 
PagedResourceListOfInstrumentEventInstruction ListInstrumentEventInstructions (string scope, string code, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions More...
 
ApiResponse< PagedResourceListOfInstrumentEventInstructionListInstrumentEventInstructionsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
 [EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions More...
 
ResourceListOfProperty ListPortfolioProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] ListPortfolioProperties: Get portfolio properties More...
 
ApiResponse< ResourceListOfPropertyListPortfolioPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
 [EARLY ACCESS] ListPortfolioProperties: Get portfolio properties More...
 
ResourceListOfPortfolio ListPortfolios (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? query=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListPortfolios: List portfolios More...
 
ApiResponse< ResourceListOfPortfolioListPortfoliosWithHttpInfo (DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), string? query=default(string?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListPortfolios: List portfolios More...
 
ResourceListOfPortfolio ListPortfoliosForScope (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListPortfoliosForScope: List portfolios for scope More...
 
ApiResponse< ResourceListOfPortfolioListPortfoliosForScopeWithHttpInfo (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
 ListPortfoliosForScope: List portfolios for scope More...
 
Portfolio PatchPortfolio (string scope, string code, List< Operation > operation, int operationIndex=0)
 PatchPortfolio: Patch portfolio. More...
 
ApiResponse< PortfolioPatchPortfolioWithHttpInfo (string scope, string code, List< Operation > operation, int operationIndex=0)
 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)
 [EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. More...
 
ApiResponse< Dictionary< string, List< AccessMetadataValue > > > PatchPortfolioAccessMetadataWithHttpInfo (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] PatchPortfolioAccessMetadata: Patch Access Metadata rules for a Portfolio. More...
 
Portfolio UpdatePortfolio (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 UpdatePortfolio: Update portfolio More...
 
ApiResponse< PortfolioUpdatePortfolioWithHttpInfo (string scope, string code, UpdatePortfolioRequest updatePortfolioRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 UpdatePortfolio: Update portfolio More...
 
InstrumentEventInstructionsResponse UpsertInstrumentEventInstructions (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More...
 
ApiResponse< InstrumentEventInstructionsResponseUpsertInstrumentEventInstructionsWithHttpInfo (string scope, string code, string successMode, Dictionary< string, InstrumentEventInstructionRequest > requestBody, DateTimeOrCutLabel? portfolioEffectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions More...
 
ResourceListOfAccessMetadataValueOf UpsertPortfolioAccessMetadata (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More...
 
ApiResponse< ResourceListOfAccessMetadataValueOfUpsertPortfolioAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioAccessMetadataRequest upsertPortfolioAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] UpsertPortfolioAccessMetadata: Upsert a Portfolio Access Metadata Rule associated with specific metadataKey. This creates or updates the data in LUSID. More...
 
PortfolioProperties UpsertPortfolioProperties (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0)
 UpsertPortfolioProperties: Upsert portfolio properties More...
 
ApiResponse< PortfolioPropertiesUpsertPortfolioPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property > requestBody, int operationIndex=0)
 UpsertPortfolioProperties: Upsert portfolio properties More...
 
UpsertReturnsResponse UpsertPortfolioReturns (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0)
 UpsertPortfolioReturns: Upsert Returns More...
 
ApiResponse< UpsertReturnsResponseUpsertPortfolioReturnsWithHttpInfo (string scope, string code, string returnScope, string returnCode, List< PerformanceReturn > performanceReturn, int operationIndex=0)
 UpsertPortfolioReturns: Upsert Returns More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteInstrumentEventInstruction()

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

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction

Delete a particular instruction for a particular portfolio

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteInstrumentEventInstructionWithHttpInfo()

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

[EARLY ACCESS] DeleteInstrumentEventInstruction: Delete Instrument Event Instruction

Delete a particular instruction for a particular portfolio

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteKeyFromPortfolioAccessMetadata()

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

DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeleteKeyFromPortfolioAccessMetadataWithHttpInfo()

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

DeleteKeyFromPortfolioAccessMetadata: Delete a Portfolio Access Metadata Rule

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolio()

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

DeletePortfolio: Delete portfolio

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioProperties()

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

DeletePortfolioProperties: Delete portfolio properties

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioPropertiesWithHttpInfo()

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

DeletePortfolioProperties: Delete portfolio properties

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeysThe property keys of the properties to delete. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. Each property must be from the &#39;Portfolio&#39; domain.
effectiveAtThe effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified &#39;effectiveAt&#39; datetime. If the &#39;effectiveAt&#39; is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioReturns()

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 
)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioReturnsWithHttpInfo()

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 
)

[EARLY ACCESS] DeletePortfolioReturns: Delete Returns

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ DeletePortfolioWithHttpInfo()

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

DeletePortfolio: Delete portfolio

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetAggregatedReturnsDispersionMetrics()

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

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

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
CompositeDispersionResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetAggregatedReturnsDispersionMetricsWithHttpInfo()

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

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

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
aggregatedReturnsDispersionRequestThe request used in the AggregatedReturnsDispersionMetric.
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of CompositeDispersionResponse

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetCompositeBreakdown()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetCompositeBreakdownWithHttpInfo()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetInstrumentEventInstruction()

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

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction

Get a particular instruction for a particular portfolio

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetInstrumentEventInstructionWithHttpInfo()

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

[EARLY ACCESS] GetInstrumentEventInstruction: Get Instrument Event Instruction

Get a particular instruction for a particular portfolio

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolio()

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 
)

GetPortfolio: Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregatedReturns()

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 
)

GetPortfolioAggregatedReturns: Aggregated Returns

Aggregate Returns which are on the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregatedReturnsWithHttpInfo()

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 
)

GetPortfolioAggregatedReturns: Aggregated Returns

Aggregate Returns which are on the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregateReturns()

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 
)

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

Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfAggregatedReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioAggregateReturnsWithHttpInfo()

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 
)

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

Aggregate Returns which are on the specified portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio.
codeThe code of the Portfolio.
returnScopeThe scope of the Returns.
returnCodeThe code of the Returns.
recipeIdScopeThe Recipe Scope for getting the fx rates (optional)
recipeIdCodeThe Recipe Code for getting the fx rates (optional)
fromEffectiveAtThe start date from which to calculate the Returns. (optional)
toEffectiveAtThe end date for which to calculate the Returns. (optional)
compositeMethodThe method used to calculate the Portfolio performance: Equal/Asset. (optional)
periodThe type of the returns used to calculate the aggregation result: Daily/Monthly. (optional)
outputFrequencyThe type of calculated output: Daily/Weekly/Monthly/Quarterly/Half-Yearly/Yearly. (optional)
metricsDetermines what type of returns should be calculated, see https://support.lusid.com/knowledgebase/article/KA-01675/en-us for a list of available metrics. (optional)
asAtThe asAt datetime at which to retrieve the Returns. Defaults to the latest. (optional)
alternativeIncDateThe date from which to consider the Returns on the Portfolio, if this is different from the date when Returns begin. Can be a date string or Portfolio property. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfAggregatedReturn

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommands()

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 
)

GetPortfolioCommands: Get portfolio commands

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioCommandsWithHttpInfo()

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 
)

GetPortfolioCommands: Get portfolio commands

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioMetadata()

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

GetPortfolioMetadata: Get access metadata rules for a portfolio

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioMetadataWithHttpInfo()

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 
)

GetPortfolioMetadata: Get access metadata rules for a portfolio

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioProperties()

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

GetPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertiesWithHttpInfo()

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

GetPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertyTimeSeries()

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 
)

GetPortfolioPropertyTimeSeries: Get portfolio property time series

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioPropertyTimeSeriesWithHttpInfo()

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 
)

GetPortfolioPropertyTimeSeries: Get portfolio property time series

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
propertyKeyThe property key of the property whose history to show. This must be from the &#39;Portfolio&#39; domain and in the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
portfolioEffectiveAtThe effective datetime used to resolve the portfolio. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to show the history. Defaults to returning the current datetime if not supplied. (optional)
filterExpression to filter the results. For more information about filtering, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
pageThe pagination token to use to continue listing properties; this value is returned from the previous call. If a pagination token is provided, the filter, portfolioEffectiveAt, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelations()

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 
)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations

Get relations for a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationships()

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 
)

GetPortfolioRelationships: Get portfolio relationships

Get relationships for a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationshipsWithHttpInfo()

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 
)

GetPortfolioRelationships: Get portfolio relationships

Get relationships for a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioRelationsWithHttpInfo()

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 
)

[EXPERIMENTAL] GetPortfolioRelations: Get portfolio relations

Get relations for a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturns()

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 
)

GetPortfolioReturns: Get Returns

Get Returns which are on the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioReturnsWithHttpInfo()

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 
)

GetPortfolioReturns: Get Returns

Get Returns which are on the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfoliosAccessMetadataByKey()

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

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfoliosAccessMetadataByKeyWithHttpInfo()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ GetPortfolioWithHttpInfo()

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 
)

GetPortfolio: Get portfolio

Retrieve the definition of a particular portfolio.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
effectiveAtThe effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto the portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolio in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListInstrumentEventInstructions()

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 
)

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions

Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfInstrumentEventInstruction

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListInstrumentEventInstructionsWithHttpInfo()

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 
)

[EARLY ACCESS] ListInstrumentEventInstructions: List Instrument Event Instructions

Lists all instructions for a particular portfolio

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
portfolioEffectiveAtThe effective date at which the portfolio will be resolved. Defaults to current time if not specified. (optional)
asAtThe asAt datetime at which to retrieve the instructions. Defaults to latest if not specified. (optional)
pageThe pagination token to use to continue listing instructions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfInstrumentEventInstruction

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolioProperties()

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 
)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolioPropertiesWithHttpInfo()

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 
)

[EARLY ACCESS] ListPortfolioProperties: Get portfolio properties

List all the properties of a particular portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfolios()

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 
)

ListPortfolios: List portfolios

List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScope()

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 
)

ListPortfoliosForScope: List portfolios for scope

List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosForScopeWithHttpInfo()

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 
)

ListPortfoliosForScope: List portfolios for scope

List all the portfolios in a particular scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope whose portfolios to list.
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe pagination token to use to continue listing portfolios. This value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to return only transactions with a transaction type of &#39;Buy&#39;, specify &quot;type eq &#39;Buy&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ ListPortfoliosWithHttpInfo()

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 
)

ListPortfolios: List portfolios

List all the portfolios matching particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
effectiveAtThe effective datetime or cut label at which to list the portfolios. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolios. Defaults to returning the latest version of each portfolio if not specified. (optional)
pageThe pagination token to use to continue listing portfolios; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the transaction type, specify &quot;type eq &#39;Transaction&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
queryExpression specifying the criteria that the returned portfolios must meet. For example, to see which portfolios have holdings in instruments with a LusidInstrumentId (LUID) of &#39;LUID_PPA8HI6M&#39; or a Figi of &#39;BBG000BLNNH6&#39;, specify &quot;instrument.identifiers in ((&#39;LusidInstrumentId&#39;, &#39;LUID_PPA8HI6M&#39;), (&#39;Figi&#39;, &#39;BBG000BLNNH6&#39;))&quot;. (optional)
propertyKeysA list of property keys from the &#39;Portfolio&#39; domain to decorate onto each portfolio, or from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA list of relationship definitions that are used to decorate related entities onto the portfolios in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPortfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolio()

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

PatchPortfolio: Patch portfolio.

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioAccessMetadata()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioAccessMetadataWithHttpInfo()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ PatchPortfolioWithHttpInfo()

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

PatchPortfolio: Patch portfolio.

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
operationThe json patch document. For more check: https://datatracker.ietf.org/doc/html/rfc6902.
operationIndexIndex associated with the operation.
Returns
ApiResponse of Portfolio

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolio()

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

UpdatePortfolio: Update portfolio

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpdatePortfolioWithHttpInfo()

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

UpdatePortfolio: Update portfolio

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertInstrumentEventInstructions()

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

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertInstrumentEventInstructionsWithHttpInfo()

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

[EARLY ACCESS] UpsertInstrumentEventInstructions: Upsert Instrument Event Instructions

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioAccessMetadata()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioAccessMetadataWithHttpInfo()

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 
)

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

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

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioProperties()

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

UpsertPortfolioProperties: Upsert portfolio properties

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
Returns
PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioPropertiesWithHttpInfo()

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

UpsertPortfolioProperties: Upsert portfolio properties

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio.
codeThe code of the portfolio. Together with the scope this uniquely identifies the portfolio.
requestBodyThe properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example &#39;Portfolio/Manager/Id&#39;.
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioProperties

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturns()

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

UpsertPortfolioReturns: Upsert Returns

Update or insert returns into the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.

◆ UpsertPortfolioReturnsWithHttpInfo()

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

UpsertPortfolioReturns: Upsert Returns

Update or insert returns into the specified portfolio.

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

Implemented in Lusid.Sdk.Api.PortfoliosApi.


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