Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.PortfolioGroupsApi:
Public Member Functions | |
| PortfolioGroupsApi () | |
| Initializes a new instance of the PortfolioGroupsApi class. More... | |
| PortfolioGroupsApi (string basePath) | |
| Initializes a new instance of the PortfolioGroupsApi class. More... | |
| PortfolioGroupsApi (Lusid.Sdk.Client.Configuration configuration) | |
| Initializes a new instance of the PortfolioGroupsApi class using Configuration object More... | |
| PortfolioGroupsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
| Initializes a new instance of the PortfolioGroupsApi class using a Configuration object and client instance. More... | |
| string | GetBasePath () |
| Gets the base path of the API client. More... | |
| PortfolioGroup | AddPortfolioToGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0) |
| [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | AddPortfolioToGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0) |
| [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | AddPortfolioToGroupAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | AddPortfolioToGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group. More... | |
| PortfolioGroup | AddSubGroupToGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0) |
| [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | AddSubGroupToGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0) |
| [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | AddSubGroupToGroupAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | AddSubGroupToGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group. More... | |
| VersionedResourceListOfOutputTransaction | BuildTransactionsForPortfolioGroup (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0) |
| BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfOutputTransaction > | BuildTransactionsForPortfolioGroupWithHttpInfo (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0) |
| BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| async System.Threading.Tasks.Task< VersionedResourceListOfOutputTransaction > | BuildTransactionsForPortfolioGroupAsync (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfOutputTransaction > > | BuildTransactionsForPortfolioGroupWithHttpInfoAsync (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| PortfolioGroup | CreatePortfolioGroup (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0) |
| CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | CreatePortfolioGroupWithHttpInfo (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0) |
| CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | CreatePortfolioGroupAsync (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | CreatePortfolioGroupWithHttpInfoAsync (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope. More... | |
| DeletedEntityResponse | DeleteGroupProperties (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. More... | |
| Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteGroupPropertiesWithHttpInfo (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. More... | |
| async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteGroupPropertiesAsync (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeleteGroupPropertiesWithHttpInfoAsync (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. More... | |
| DeletedEntityResponse | DeleteKeyFromPortfolioGroupAccessMetadata (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More... | |
| Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More... | |
| async System.Threading.Tasks.Task< DeletedEntityResponse > | DeleteKeyFromPortfolioGroupAccessMetadataAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfoAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure). More... | |
| PortfolioGroup | DeletePortfolioFromGroup (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | DeletePortfolioFromGroupWithHttpInfo (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | DeletePortfolioFromGroupAsync (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | DeletePortfolioFromGroupWithHttpInfoAsync (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group. More... | |
| DeletedEntityResponse | DeletePortfolioGroup (string scope, string code, int operationIndex=0) |
| [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
| Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > | DeletePortfolioGroupWithHttpInfo (string scope, string code, int operationIndex=0) |
| [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
| async System.Threading.Tasks.Task< DeletedEntityResponse > | DeletePortfolioGroupAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > | DeletePortfolioGroupWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion. More... | |
| PortfolioGroup | DeleteSubGroupFromGroup (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | DeleteSubGroupFromGroupWithHttpInfo (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0) |
| [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | DeleteSubGroupFromGroupAsync (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | DeleteSubGroupFromGroupWithHttpInfoAsync (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group. More... | |
| VersionedResourceListOfA2BDataRecord | GetA2BDataForPortfolioGroup (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0) |
| [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfA2BDataRecord > | GetA2BDataForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0) |
| [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group. More... | |
| async System.Threading.Tasks.Task< VersionedResourceListOfA2BDataRecord > | GetA2BDataForPortfolioGroupAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfA2BDataRecord > > | GetA2BDataForPortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group. More... | |
| PortfolioGroupProperties | GetGroupProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties > | GetGroupPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroupProperties > | GetGroupPropertiesAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties > > | GetGroupPropertiesWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group. More... | |
| VersionedResourceListOfPortfolioHolding | GetHoldingsForPortfolioGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0) |
| GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfPortfolioHolding > | GetHoldingsForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0) |
| GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More... | |
| async System.Threading.Tasks.Task< VersionedResourceListOfPortfolioHolding > | GetHoldingsForPortfolioGroupAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfPortfolioHolding > > | GetHoldingsForPortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group. More... | |
| PortfolioGroup | GetPortfolioGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0) |
| GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | GetPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0) |
| GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | GetPortfolioGroupAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | GetPortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group. More... | |
| List< AccessMetadataValue > | GetPortfolioGroupAccessMetadataByKey (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule More... | |
| Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > | GetPortfolioGroupAccessMetadataByKeyWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule More... | |
| async System.Threading.Tasks.Task< List< AccessMetadataValue > > | GetPortfolioGroupAccessMetadataByKeyAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< List< AccessMetadataValue > > > | GetPortfolioGroupAccessMetadataByKeyWithHttpInfoAsync (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule More... | |
| ResourceListOfProcessedCommand | GetPortfolioGroupCommands (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0) |
| GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfProcessedCommand > | GetPortfolioGroupCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0) |
| GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group. More... | |
| async System.Threading.Tasks.Task< ResourceListOfProcessedCommand > | GetPortfolioGroupCommandsAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfProcessedCommand > > | GetPortfolioGroupCommandsWithHttpInfoAsync (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group. More... | |
| ExpandedGroup | GetPortfolioGroupExpansion (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyFilter=default(List< string >?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. More... | |
| Lusid.Sdk.Client.ApiResponse< ExpandedGroup > | GetPortfolioGroupExpansionWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyFilter=default(List< string >?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. More... | |
| async System.Threading.Tasks.Task< ExpandedGroup > | GetPortfolioGroupExpansionAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyFilter=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ExpandedGroup > > | GetPortfolioGroupExpansionWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyFilter=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified. More... | |
| Dictionary< string, List< AccessMetadataValue > > | GetPortfolioGroupMetadata (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata More... | |
| Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > | GetPortfolioGroupMetadataWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata More... | |
| async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > | GetPortfolioGroupMetadataAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > | GetPortfolioGroupMetadataWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata More... | |
| ResourceListOfPropertyInterval | GetPortfolioGroupPropertyTimeSeries (string scope, string code, string propertyKey, string? portfolioGroupEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property. More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > | GetPortfolioGroupPropertyTimeSeriesWithHttpInfo (string scope, string code, string propertyKey, string? portfolioGroupEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0) |
| [EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property. More... | |
| async System.Threading.Tasks.Task< ResourceListOfPropertyInterval > | GetPortfolioGroupPropertyTimeSeriesAsync (string scope, string code, string propertyKey, string? portfolioGroupEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPropertyInterval > > | GetPortfolioGroupPropertyTimeSeriesWithHttpInfoAsync (string scope, string code, string propertyKey, string? portfolioGroupEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property. More... | |
| ResourceListOfRelation | GetPortfolioGroupRelations (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] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > | GetPortfolioGroupRelationsWithHttpInfo (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] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group More... | |
| async System.Threading.Tasks.Task< ResourceListOfRelation > | GetPortfolioGroupRelationsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelation > > | GetPortfolioGroupRelationsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group More... | |
| ResourceListOfRelationship | GetPortfolioGroupRelationships (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) |
| [EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > | GetPortfolioGroupRelationshipsWithHttpInfo (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) |
| [EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group More... | |
| async System.Threading.Tasks.Task< ResourceListOfRelationship > | GetPortfolioGroupRelationshipsAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfRelationship > > | GetPortfolioGroupRelationshipsWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group More... | |
| VersionedResourceListOfTransaction | GetTransactionsForPortfolioGroup (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0) |
| GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfTransaction > | GetTransactionsForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0) |
| GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| async System.Threading.Tasks.Task< VersionedResourceListOfTransaction > | GetTransactionsForPortfolioGroupAsync (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< VersionedResourceListOfTransaction > > | GetTransactionsForPortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself. More... | |
| PagedResourceListOfPortfolioGroup | ListPortfolioGroups (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 >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0) |
| [EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope. More... | |
| Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioGroup > | ListPortfolioGroupsWithHttpInfo (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 >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0) |
| [EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope. More... | |
| async System.Threading.Tasks.Task< PagedResourceListOfPortfolioGroup > | ListPortfolioGroupsAsync (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 >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioGroup > > | ListPortfolioGroupsWithHttpInfoAsync (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 >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope. More... | |
| Dictionary< string, List< AccessMetadataValue > > | PatchPortfolioGroupAccessMetadata (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > | PatchPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| async System.Threading.Tasks.Task< Dictionary< string, List< AccessMetadataValue > > > | PatchPortfolioGroupAccessMetadataAsync (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Dictionary< string, List< AccessMetadataValue > > > > | PatchPortfolioGroupAccessMetadataWithHttpInfoAsync (string scope, string code, List< AccessMetadataOperation > accessMetadataOperation, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| PortfolioGroup | UpdatePortfolioGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0) |
| [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroup > | UpdatePortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0) |
| [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. More... | |
| async System.Threading.Tasks.Task< PortfolioGroup > | UpdatePortfolioGroupAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroup > > | UpdatePortfolioGroupWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group. More... | |
| PortfolioGroupProperties | UpsertGroupProperties (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0) |
| [EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More... | |
| Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties > | UpsertGroupPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0) |
| [EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More... | |
| async System.Threading.Tasks.Task< PortfolioGroupProperties > | UpsertGroupPropertiesAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PortfolioGroupProperties > > | UpsertGroupPropertiesWithHttpInfoAsync (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. More... | |
| ResourceListOfAccessMetadataValueOf | UpsertPortfolioGroupAccessMetadata (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOf > | UpsertPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| async System.Threading.Tasks.Task< ResourceListOfAccessMetadataValueOf > | UpsertPortfolioGroupAccessMetadataAsync (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
| async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessMetadataValueOf > > | UpsertPortfolioGroupAccessMetadataWithHttpInfoAsync (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched. More... | |
Properties | |
| Lusid.Sdk.Client.IAsynchronousClient | AsynchronousClient [get, set] |
| The client for accessing this underlying API asynchronously. More... | |
| Lusid.Sdk.Client.ISynchronousClient | Client [get, set] |
| The client for accessing this underlying API synchronously. More... | |
| Lusid.Sdk.Client.IReadableConfiguration | Configuration [get, set] |
| Gets or sets the configuration object More... | |
| Lusid.Sdk.Client.ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
 Properties inherited from Lusid.Sdk.Client.IApiAccessor | |
| IReadableConfiguration | Configuration [get, set] |
| Gets or sets the configuration object More... | |
| ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Constructor & Destructor Documentation
◆ PortfolioGroupsApi() [1/4]
|
inline |
Initializes a new instance of the PortfolioGroupsApi class.
- Returns
◆ PortfolioGroupsApi() [2/4]
|
inline |
Initializes a new instance of the PortfolioGroupsApi class.
- Returns
◆ PortfolioGroupsApi() [3/4]
|
inline |
Initializes a new instance of the PortfolioGroupsApi class using Configuration object
- Parameters
-
configuration An instance of Configuration
- Returns
◆ PortfolioGroupsApi() [4/4]
|
inline |
Initializes a new instance of the PortfolioGroupsApi class using a Configuration object and client instance.
- Parameters
-
client The client interface for synchronous API access. asyncClient The client interface for asynchronous API access. configuration The configuration object.
Member Function Documentation
◆ AddPortfolioToGroup()
|
inline |
[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio to. code The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the portfolio will be added to the group. (optional) resourceId The resource identifier of the portfolio to add to the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ AddPortfolioToGroupAsync()
|
inline |
[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio to. code The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the portfolio will be added to the group. (optional) resourceId The resource identifier of the portfolio to add to the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ AddPortfolioToGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio to. code The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the portfolio will be added to the group. (optional) resourceId The resource identifier of the portfolio to add to the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ AddPortfolioToGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group Add a single portfolio to a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio to. code The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the portfolio will be added to the group. (optional) resourceId The resource identifier of the portfolio to add to the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ AddSubGroupToGroup()
|
inline |
[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio group to. code The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the sub group will be added to the group. (optional) resourceId The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ AddSubGroupToGroupAsync()
|
inline |
[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio group to. code The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the sub group will be added to the group. (optional) resourceId The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ AddSubGroupToGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio group to. code The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the sub group will be added to the group. (optional) resourceId The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ AddSubGroupToGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group Add a portfolio group to a portfolio group as a sub group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to add a portfolio group to. code The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label from which the sub group will be added to the group. (optional) resourceId The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ BuildTransactionsForPortfolioGroup()
|
inline |
BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. transactionQueryParameters The query queryParameters which control how the output transactions are built. asAt The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional) operationIndex Index associated with the operation.
- Returns
- VersionedResourceListOfOutputTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ BuildTransactionsForPortfolioGroupAsync()
|
inline |
BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. transactionQueryParameters The query queryParameters which control how the output transactions are built. asAt The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of VersionedResourceListOfOutputTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ BuildTransactionsForPortfolioGroupWithHttpInfo()
|
inline |
BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. transactionQueryParameters The query queryParameters which control how the output transactions are built. asAt The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of VersionedResourceListOfOutputTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ BuildTransactionsForPortfolioGroupWithHttpInfoAsync()
|
inline |
BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group Build transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. transactionQueryParameters The query queryParameters which control how the output transactions are built. asAt The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (VersionedResourceListOfOutputTransaction)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ CreatePortfolioGroup()
|
inline |
CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope that the portfolio group will be created in. createPortfolioGroupRequest The definition and details of the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ CreatePortfolioGroupAsync()
|
inline |
CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope that the portfolio group will be created in. createPortfolioGroupRequest The definition and details of the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ CreatePortfolioGroupWithHttpInfo()
|
inline |
CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope that the portfolio group will be created in. createPortfolioGroupRequest The definition and details of the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ CreatePortfolioGroupWithHttpInfoAsync()
|
inline |
CreatePortfolioGroup: Create portfolio group Create a portfolio group in a specific scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope that the portfolio group will be created in. createPortfolioGroupRequest The definition and details of the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteGroupProperties()
|
inline |
[EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to delete properties from. code The code of the group to delete properties from. Together with the scope this uniquely identifies the group. requestBody The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteGroupPropertiesAsync()
|
inline |
[EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to delete properties from. code The code of the group to delete properties from. Together with the scope this uniquely identifies the group. requestBody The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteGroupPropertiesWithHttpInfo()
|
inline |
[EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to delete properties from. code The code of the group to delete properties from. Together with the scope this uniquely identifies the group. requestBody The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteGroupPropertiesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeleteGroupProperties: Delete group properties Delete one or more properties from a single portfolio group. If the properties are time variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to delete properties from. code The code of the group to delete properties from. Together with the scope this uniquely identifies the group. requestBody The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. effectiveAt The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (DeletedEntityResponse)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteKeyFromPortfolioGroupAccessMetadata()
|
inline |
[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the Access Metadata entry to delete effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found (optional) effectiveUntil The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteKeyFromPortfolioGroupAccessMetadataAsync()
|
inline |
[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the Access Metadata entry to delete effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found (optional) effectiveUntil The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo()
|
inline |
[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the Access Metadata entry to delete effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found (optional) effectiveUntil The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry Deletes the Portfolio Group Access Metadata entry that exactly matches the provided identifier parts. It is important to always check to verify success (or failure).
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the Access Metadata entry to delete effectiveAt The effective date to delete at, if this is not supplied, it will delete all data found (optional) effectiveUntil The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (DeletedEntityResponse)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeletePortfolioFromGroup()
|
inline |
[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the portfolio from. code The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. portfolioScope The scope of the portfolio being removed from the portfolio group. portfolioCode The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. effectiveAt The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeletePortfolioFromGroupAsync()
|
inline |
[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the portfolio from. code The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. portfolioScope The scope of the portfolio being removed from the portfolio group. portfolioCode The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. effectiveAt The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeletePortfolioFromGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the portfolio from. code The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. portfolioScope The scope of the portfolio being removed from the portfolio group. portfolioCode The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. effectiveAt The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeletePortfolioFromGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group Remove a single portfolio from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the portfolio from. code The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. portfolioScope The scope of the portfolio being removed from the portfolio group. portfolioCode The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. effectiveAt The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeletePortfolioGroup()
|
inline |
[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to delete. code The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. operationIndex Index associated with the operation.
- Returns
- DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeletePortfolioGroupAsync()
|
inline |
[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to delete. code The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeletePortfolioGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to delete. code The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. operationIndex Index associated with the operation.
- Returns
- ApiResponse of DeletedEntityResponse
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeletePortfolioGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group Delete a single portfolio group. A portfolio group can be deleted while it still contains portfolios or sub groups. In this case any portfolios or sub groups contained in this group will not be deleted, however they will no longer be grouped together by this portfolio group. The deletion will be valid from the portfolio group's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to delete. code The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (DeletedEntityResponse)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteSubGroupFromGroup()
|
inline |
[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the sub group from. code The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. subgroupScope The scope of the sub group to remove from the portfolio group. subgroupCode The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. effectiveAt The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteSubGroupFromGroupAsync()
|
inline |
[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the sub group from. code The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. subgroupScope The scope of the sub group to remove from the portfolio group. subgroupCode The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. effectiveAt The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ DeleteSubGroupFromGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the sub group from. code The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. subgroupScope The scope of the sub group to remove from the portfolio group. subgroupCode The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. effectiveAt The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ DeleteSubGroupFromGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group Remove a single portfolio group (sub group) from a portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to remove the sub group from. code The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. subgroupScope The scope of the sub group to remove from the portfolio group. subgroupCode The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. effectiveAt The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetA2BDataForPortfolioGroup()
|
inline |
[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to retrieve the A2B report for. code The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. fromEffectiveAt The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. toEffectiveAt The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. asAt The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional) recipeIdScope The scope of the given recipeId (optional) recipeIdCode The code of the given recipeId (optional) propertyKeys A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- VersionedResourceListOfA2BDataRecord
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetA2BDataForPortfolioGroupAsync()
|
inline |
[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to retrieve the A2B report for. code The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. fromEffectiveAt The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. toEffectiveAt The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. asAt The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional) recipeIdScope The scope of the given recipeId (optional) recipeIdCode The code of the given recipeId (optional) propertyKeys A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of VersionedResourceListOfA2BDataRecord
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetA2BDataForPortfolioGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to retrieve the A2B report for. code The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. fromEffectiveAt The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. toEffectiveAt The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. asAt The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional) recipeIdScope The scope of the given recipeId (optional) recipeIdCode The code of the given recipeId (optional) propertyKeys A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of VersionedResourceListOfA2BDataRecord
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetA2BDataForPortfolioGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group Get an A2B report for all Transaction Portfolios within the given portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to retrieve the A2B report for. code The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. fromEffectiveAt The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified. toEffectiveAt The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified. asAt The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional) recipeIdScope The scope of the given recipeId (optional) recipeIdCode The code of the given recipeId (optional) propertyKeys A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (VersionedResourceListOfA2BDataRecord)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetBasePath()
|
inline |
◆ GetGroupProperties()
|
inline |
[EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to list the properties for. code The code of the group to list the properties for. Together with the scope this uniquely identifies the group. effectiveAt The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetGroupPropertiesAsync()
|
inline |
[EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to list the properties for. code The code of the group to list the properties for. Together with the scope this uniquely identifies the group. effectiveAt The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetGroupPropertiesWithHttpInfo()
|
inline |
[EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to list the properties for. code The code of the group to list the properties for. Together with the scope this uniquely identifies the group. effectiveAt The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetGroupPropertiesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetGroupProperties: Get group properties List all the properties of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to list the properties for. code The code of the group to list the properties for. Together with the scope this uniquely identifies the group. effectiveAt The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroupProperties)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetHoldingsForPortfolioGroup()
|
inline |
GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional) byTaxlots Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional) operationIndex Index associated with the operation.
- Returns
- VersionedResourceListOfPortfolioHolding
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetHoldingsForPortfolioGroupAsync()
|
inline |
GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional) byTaxlots Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of VersionedResourceListOfPortfolioHolding
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetHoldingsForPortfolioGroupWithHttpInfo()
|
inline |
GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional) byTaxlots Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of VersionedResourceListOfPortfolioHolding
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetHoldingsForPortfolioGroupWithHttpInfoAsync()
|
inline |
GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group Get the holdings of transaction portfolios in specified portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional) byTaxlots Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (VersionedResourceListOfPortfolioHolding)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroup()
|
inline |
GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the definition for. code The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupAccessMetadataByKey()
|
inline |
[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the metadata entry to retrieve effectiveAt The effectiveAt datetime at which to retrieve the access metadata (optional) asAt The asAt datetime at which to retrieve the access metadata (optional) operationIndex Index associated with the operation.
- Returns
- List<AccessMetadataValue>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupAccessMetadataByKeyAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the metadata entry to retrieve effectiveAt The effectiveAt datetime at which to retrieve the access metadata (optional) asAt The asAt datetime at which to retrieve the access metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of List<AccessMetadataValue>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupAccessMetadataByKeyWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the metadata entry to retrieve effectiveAt The effectiveAt datetime at which to retrieve the access metadata (optional) asAt The asAt datetime at which to retrieve the access metadata (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of List<AccessMetadataValue>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupAccessMetadataByKeyWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group Get a specific Portfolio Group access metadata by specifying the corresponding identifier parts No matching will be performed through this endpoint. To retrieve a rule, it is necessary to specify, exactly, the identifier of the rule
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the metadata entry to retrieve effectiveAt The effectiveAt datetime at which to retrieve the access metadata (optional) asAt The asAt datetime at which to retrieve the access metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (List<AccessMetadataValue>)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupAsync()
|
inline |
GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the definition for. code The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupCommands()
|
inline |
GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the commands for. code The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. fromAsAt The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) toAsAt The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) filter Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfProcessedCommand
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupCommandsAsync()
|
inline |
GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the commands for. code The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. fromAsAt The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) toAsAt The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) filter Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfProcessedCommand
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupCommandsWithHttpInfo()
|
inline |
GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the commands for. code The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. fromAsAt The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) toAsAt The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) filter Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfProcessedCommand
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupCommandsWithHttpInfoAsync()
|
inline |
GetPortfolioGroupCommands: Get portfolio group commands Gets all the commands that modified a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the commands for. code The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. fromAsAt The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional) toAsAt The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional) filter Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfProcessedCommand)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupExpansion()
|
inline |
[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to expand. code The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. effectiveAt The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional) propertyFilter The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional) operationIndex Index associated with the operation.
- Returns
- ExpandedGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupExpansionAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to expand. code The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. effectiveAt The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional) propertyFilter The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ExpandedGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupExpansionWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to expand. code The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. effectiveAt The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional) propertyFilter The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ExpandedGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupExpansionWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion List all the portfolios in a group, including all portfolios within sub groups in the group. Each portfolio will be decorated with all of its properties unless a property filter is specified.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to expand. code The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. effectiveAt The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional) propertyFilter The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ExpandedGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupMetadata()
|
inline |
[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata (optional) asAt The asAt datetime at which to retrieve the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupMetadataAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata (optional) asAt The asAt datetime at which to retrieve the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupMetadataWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata (optional) asAt The asAt datetime at which to retrieve the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupMetadataWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code effectiveAt The effectiveAt datetime at which to retrieve the Access Metadata (optional) asAt The asAt datetime at which to retrieve the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupPropertyTimeSeries()
|
inline |
[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group. code The code of the group. Together with the scope this uniquely identifies the portfolio group. propertyKey The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. portfolioGroupEffectiveAt The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupPropertyTimeSeriesAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group. code The code of the group. Together with the scope this uniquely identifies the portfolio group. propertyKey The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. portfolioGroupEffectiveAt The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupPropertyTimeSeriesWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group. code The code of the group. Together with the scope this uniquely identifies the portfolio group. propertyKey The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. portfolioGroupEffectiveAt The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfPropertyInterval
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupPropertyTimeSeriesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property List the complete time series of a portfolio group property.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group. code The code of the group. Together with the scope this uniquely identifies the portfolio group. propertyKey The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain. portfolioGroupEffectiveAt The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) page The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfPropertyInterval)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupRelations()
|
inline |
[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfRelation
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupRelationsAsync()
|
inline |
[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfRelation
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupRelationships()
|
inline |
[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfRelationship
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupRelationshipsAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfRelationship
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupRelationshipsWithHttpInfo()
|
inline |
[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfRelationship
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupRelationshipsWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group Get relationships for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfRelationship)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupRelationsWithHttpInfo()
|
inline |
[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfRelation
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupRelationsWithHttpInfoAsync()
|
inline |
[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group Get relations for the specified Portfolio Group
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional) filter Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional) identifierTypes Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfRelation)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetPortfolioGroupWithHttpInfo()
|
inline |
GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the definition for. code The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetPortfolioGroupWithHttpInfoAsync()
|
inline |
GetPortfolioGroup: Get portfolio group Retrieve the definition of a single portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to retrieve the definition for. code The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetTransactionsForPortfolioGroup()
|
inline |
GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. fromTransactionDate The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional) toTransactionDate The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional) asAt The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional) showCancelledTransactions Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) operationIndex Index associated with the operation.
- Returns
- VersionedResourceListOfTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetTransactionsForPortfolioGroupAsync()
|
inline |
GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. fromTransactionDate The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional) toTransactionDate The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional) asAt The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional) showCancelledTransactions Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of VersionedResourceListOfTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ GetTransactionsForPortfolioGroupWithHttpInfo()
|
inline |
GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. fromTransactionDate The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional) toTransactionDate The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional) asAt The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional) showCancelledTransactions Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of VersionedResourceListOfTransaction
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ GetTransactionsForPortfolioGroupWithHttpInfoAsync()
|
inline |
GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group Get transactions for transaction portfolios in a portfolio group over a given interval of effective time. When the specified portfolio in a portfolio group is a derived transaction portfolio, the returned set of transactions is the union set of all transactions of the parent (and any grandparents etc.) and the specified derived transaction portfolio itself.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group. code The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. fromTransactionDate The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional) toTransactionDate The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional) asAt The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) propertyKeys A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional) limit When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional) page The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional) showCancelledTransactions Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional) sortBy A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (VersionedResourceListOfTransaction)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ ListPortfolioGroups()
|
inline |
[EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to list the portfolio groups in. effectiveAt The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional) page The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) sortBy A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation.
- Returns
- PagedResourceListOfPortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ ListPortfolioGroupsAsync()
|
inline |
[EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to list the portfolio groups in. effectiveAt The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional) page The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) sortBy A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfPortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ ListPortfolioGroupsWithHttpInfo()
|
inline |
[EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to list the portfolio groups in. effectiveAt The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional) page The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) sortBy A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PagedResourceListOfPortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ ListPortfolioGroupsWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] ListPortfolioGroups: List portfolio groups List all the portfolio groups in a single scope.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope to list the portfolio groups in. effectiveAt The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional) asAt The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional) page The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional) limit When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional) filter Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) sortBy A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional) relatedEntityPropertyKeys A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional) relationshipDefinitionIds A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfPortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ PatchPortfolioGroupAccessMetadata()
|
inline |
[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code accessMetadataOperation The Json patch document effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ PatchPortfolioGroupAccessMetadataAsync()
|
inline |
[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code accessMetadataOperation The Json patch document effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ PatchPortfolioGroupAccessMetadataWithHttpInfo()
|
inline |
[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code accessMetadataOperation The Json patch document effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of Dictionary<string, List<AccessMetadataValue>>
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ PatchPortfolioGroupAccessMetadataWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. Patch Portfolio Group Access Metadata Rules in a single scope. The behaviour is defined by the JSON Patch specification. Currently only 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code accessMetadataOperation The Json patch document effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Dictionary<string, List<AccessMetadataValue>>)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpdatePortfolioGroup()
|
inline |
[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to update the definition for. code The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to update the definition. (optional) updatePortfolioGroupRequest The updated portfolio group definition. (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpdatePortfolioGroupAsync()
|
inline |
[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to update the definition for. code The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to update the definition. (optional) updatePortfolioGroupRequest The updated portfolio group definition. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpdatePortfolioGroupWithHttpInfo()
|
inline |
[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to update the definition for. code The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to update the definition. (optional) updatePortfolioGroupRequest The updated portfolio group definition. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroup
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpdatePortfolioGroupWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group Update the definition of a single portfolio group. Not all elements within a portfolio group definition are modifiable due to the potential implications for data already stored against the portfolio group.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the portfolio group to update the definition for. code The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. effectiveAt The effective datetime or cut label at which to update the definition. (optional) updatePortfolioGroupRequest The updated portfolio group definition. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroup)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpsertGroupProperties()
|
inline |
[EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to update or insert the properties onto. code The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. requestBody The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional) operationIndex Index associated with the operation.
- Returns
- PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpsertGroupPropertiesAsync()
|
inline |
[EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to update or insert the properties onto. code The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. requestBody The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpsertGroupPropertiesWithHttpInfo()
|
inline |
[EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to update or insert the properties onto. code The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. requestBody The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PortfolioGroupProperties
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpsertGroupPropertiesWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] UpsertGroupProperties: Upsert group properties Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property 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.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the group to update or insert the properties onto. code The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. requestBody The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PortfolioGroupProperties)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpsertPortfolioGroupAccessMetadata()
|
inline |
[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the access metadata entry to upsert upsertPortfolioGroupAccessMetadataRequest The Portfolio Group Access Metadata rule to upsert effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfAccessMetadataValueOf
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpsertPortfolioGroupAccessMetadataAsync()
|
inline |
[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the access metadata entry to upsert upsertPortfolioGroupAccessMetadataRequest The Portfolio Group Access Metadata rule to upsert effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfAccessMetadataValueOf
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
◆ UpsertPortfolioGroupAccessMetadataWithHttpInfo()
|
inline |
[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the access metadata entry to upsert upsertPortfolioGroupAccessMetadataRequest The Portfolio Group Access Metadata rule to upsert effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfAccessMetadataValueOf
Implements Lusid.Sdk.Api.IPortfolioGroupsApiSync.
◆ UpsertPortfolioGroupAccessMetadataWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. Update or insert one Portfolio Group Access Metadata Entry 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 Group 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 exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope The scope of the Portfolio Group code The Portfolio Group code metadataKey Key of the access metadata entry to upsert upsertPortfolioGroupAccessMetadataRequest The Portfolio Group Access Metadata rule to upsert effectiveAt The date this rule will be effective from (optional) effectiveUntil The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfAccessMetadataValueOf)
Implements Lusid.Sdk.Api.IPortfolioGroupsApiAsync.
Property Documentation
◆ AsynchronousClient
|
getset |
The client for accessing this underlying API asynchronously.
◆ Client
|
getset |
The client for accessing this underlying API synchronously.
◆ Configuration
|
getset |
Gets or sets the configuration object
An instance of the Configuration
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PortfolioGroupsApi.cs
