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

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

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

Public Member Functions

PortfolioGroup AddPortfolioToGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0)
 [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group More...
 
ApiResponse< PortfolioGroupAddPortfolioToGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0)
 [EARLY ACCESS] AddPortfolioToGroup: Add portfolio to 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 More...
 
ApiResponse< PortfolioGroupAddSubGroupToGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0)
 [EARLY ACCESS] AddSubGroupToGroup: Add sub group to 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 More...
 
ApiResponse< VersionedResourceListOfOutputTransactionBuildTransactionsForPortfolioGroupWithHttpInfo (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 More...
 
PortfolioGroup CreatePortfolioGroup (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0)
 CreatePortfolioGroup: Create portfolio group More...
 
ApiResponse< PortfolioGroupCreatePortfolioGroupWithHttpInfo (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0)
 CreatePortfolioGroup: Create portfolio group More...
 
DeletedEntityResponse DeleteGroupProperties (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteGroupProperties: Delete group properties More...
 
ApiResponse< DeletedEntityResponseDeleteGroupPropertiesWithHttpInfo (string scope, string code, List< string > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteGroupProperties: Delete group properties 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 More...
 
ApiResponse< DeletedEntityResponseDeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo (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 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 More...
 
ApiResponse< PortfolioGroupDeletePortfolioFromGroupWithHttpInfo (string scope, string code, string portfolioScope, string portfolioCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group More...
 
DeletedEntityResponse DeletePortfolioGroup (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group More...
 
ApiResponse< DeletedEntityResponseDeletePortfolioGroupWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group 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 More...
 
ApiResponse< PortfolioGroupDeleteSubGroupFromGroupWithHttpInfo (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
 [EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from 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 More...
 
ApiResponse< VersionedResourceListOfA2BDataRecordGetA2BDataForPortfolioGroupWithHttpInfo (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 More...
 
PortfolioGroupProperties GetGroupProperties (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetGroupProperties: Get group properties More...
 
ApiResponse< PortfolioGroupPropertiesGetGroupPropertiesWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [EARLY ACCESS] GetGroupProperties: Get group properties 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? includeSettlementEventsAfterDays=default(int?), int operationIndex=0)
 GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group More...
 
ApiResponse< VersionedResourceListOfPortfolioHoldingGetHoldingsForPortfolioGroupWithHttpInfo (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? includeSettlementEventsAfterDays=default(int?), int operationIndex=0)
 GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in 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 More...
 
ApiResponse< PortfolioGroupGetPortfolioGroupWithHttpInfo (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 More...
 
List< AccessMetadataValueGetPortfolioGroupAccessMetadataByKey (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 More...
 
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 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 More...
 
ApiResponse< ResourceListOfProcessedCommandGetPortfolioGroupCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
 GetPortfolioGroupCommands: Get portfolio group commands 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 More...
 
ApiResponse< ExpandedGroupGetPortfolioGroupExpansionWithHttpInfo (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 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 More...
 
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 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 More...
 
ApiResponse< ResourceListOfPropertyIntervalGetPortfolioGroupPropertyTimeSeriesWithHttpInfo (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 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 More...
 
ApiResponse< ResourceListOfRelationGetPortfolioGroupRelationsWithHttpInfo (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 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 More...
 
ApiResponse< ResourceListOfRelationshipGetPortfolioGroupRelationshipsWithHttpInfo (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 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 More...
 
ApiResponse< VersionedResourceListOfTransactionGetTransactionsForPortfolioGroupWithHttpInfo (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 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)
 ListPortfolioGroups: List portfolio groups More...
 
ApiResponse< PagedResourceListOfPortfolioGroupListPortfolioGroupsWithHttpInfo (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)
 ListPortfolioGroups: List portfolio groups 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. More...
 
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. More...
 
PortfolioGroup UpdatePortfolioGroup (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0)
 [EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group More...
 
ApiResponse< PortfolioGroupUpdatePortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), UpdatePortfolioGroupRequest? updatePortfolioGroupRequest=default(UpdatePortfolioGroupRequest?), int operationIndex=0)
 [EARLY ACCESS] UpdatePortfolioGroup: Update 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 More...
 
ApiResponse< PortfolioGroupPropertiesUpsertGroupPropertiesWithHttpInfo (string scope, string code, Dictionary< string, Property >? requestBody=default(Dictionary< string, Property >?), int operationIndex=0)
 [EARLY ACCESS] UpsertGroupProperties: Upsert group properties More...
 
ResourceListOfAccessMetadataValueOf UpsertPortfolioGroupAccessMetadata (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
ApiResponse< ResourceListOfAccessMetadataValueOfUpsertPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
 UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

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

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ AddPortfolioToGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to add a portfolio to.
codeThe code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label from which the portfolio will be added to the group. (optional)
resourceIdThe resource identifier of the portfolio to add to the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddPortfolioToGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to add a portfolio to.
codeThe code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label from which the portfolio will be added to the group. (optional)
resourceIdThe resource identifier of the portfolio to add to the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddSubGroupToGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to add a portfolio group to.
codeThe code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label from which the sub group will be added to the group. (optional)
resourceIdThe resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ AddSubGroupToGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to add a portfolio group to.
codeThe code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label from which the sub group will be added to the group. (optional)
resourceIdThe resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ BuildTransactionsForPortfolioGroup()

VersionedResourceListOfOutputTransaction Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Transaction Type, use &quot;type eq &#39;Buy&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndexIndex associated with the operation.
Returns
VersionedResourceListOfOutputTransaction

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ BuildTransactionsForPortfolioGroupWithHttpInfo()

ApiResponse<VersionedResourceListOfOutputTransaction> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
transactionQueryParametersThe query queryParameters which control how the output transactions are built.
asAtThe asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Transaction Type, use &quot;type eq &#39;Buy&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; or &quot;Transaction&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of VersionedResourceListOfOutputTransaction

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ CreatePortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.CreatePortfolioGroup ( string  scope,
CreatePortfolioGroupRequest createPortfolioGroupRequest = default(CreatePortfolioGroupRequest?),
int  operationIndex = 0 
)

CreatePortfolioGroup: Create portfolio group

Create a portfolio group in a specific scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope that the portfolio group will be created in.
createPortfolioGroupRequestThe definition and details of the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ CreatePortfolioGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.CreatePortfolioGroupWithHttpInfo ( string  scope,
CreatePortfolioGroupRequest createPortfolioGroupRequest = default(CreatePortfolioGroupRequest?),
int  operationIndex = 0 
)

CreatePortfolioGroup: Create portfolio group

Create a portfolio group in a specific scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope that the portfolio group will be created in.
createPortfolioGroupRequestThe definition and details of the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteGroupProperties()

DeletedEntityResponse Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteGroupPropertiesWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteKeyFromPortfolioGroupAccessMetadata()

DeletedEntityResponse Lusid.Sdk.Api.IPortfolioGroupsApiSync.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).

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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).

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioFromGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to remove the portfolio from.
codeThe code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScopeThe scope of the portfolio being removed from the portfolio group.
portfolioCodeThe code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAtThe effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioFromGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to remove the portfolio from.
codeThe code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScopeThe scope of the portfolio being removed from the portfolio group.
portfolioCodeThe code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAtThe effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioGroup()

DeletedEntityResponse Lusid.Sdk.Api.IPortfolioGroupsApiSync.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&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to delete.
codeThe code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
operationIndexIndex associated with the operation.
Returns
DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeletePortfolioGroupWithHttpInfo()

ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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&#39;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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to delete.
codeThe code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
operationIndexIndex associated with the operation.
Returns
ApiResponse of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteSubGroupFromGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to remove the sub group from.
codeThe code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScopeThe scope of the sub group to remove from the portfolio group.
subgroupCodeThe code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAtThe effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ DeleteSubGroupFromGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to remove the sub group from.
codeThe code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScopeThe scope of the sub group to remove from the portfolio group.
subgroupCodeThe code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAtThe effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetA2BDataForPortfolioGroup()

VersionedResourceListOfA2BDataRecord Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group to retrieve the A2B report for.
codeThe code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
VersionedResourceListOfA2BDataRecord

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetA2BDataForPortfolioGroupWithHttpInfo()

ApiResponse<VersionedResourceListOfA2BDataRecord> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group to retrieve the A2B report for.
codeThe code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.
fromEffectiveAtThe lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAtThe upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAtThe asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScopeThe scope of the given recipeId (optional)
recipeIdCodeThe code of the given recipeId (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot; domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of VersionedResourceListOfA2BDataRecord

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetGroupProperties()

PortfolioGroupProperties Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetGroupPropertiesWithHttpInfo()

ApiResponse<PortfolioGroupProperties> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetHoldingsForPortfolioGroup()

VersionedResourceListOfPortfolioHolding Lusid.Sdk.Api.IPortfolioGroupsApiSync.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?  includeSettlementEventsAfterDays = default(int?),
int  operationIndex = 0 
)

GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group

Get the holdings of transaction portfolios in specified portfolio group.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe 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)
asAtThe 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)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot; or &quot;Portfolio&quot; domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
includeSettlementEventsAfterDaysNumber of days ahead to bring back settlements from, in relation to the specified effectiveAt (optional)
operationIndexIndex associated with the operation.
Returns
VersionedResourceListOfPortfolioHolding

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetHoldingsForPortfolioGroupWithHttpInfo()

ApiResponse<VersionedResourceListOfPortfolioHolding> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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?  includeSettlementEventsAfterDays = default(int?),
int  operationIndex = 0 
)

GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group

Get the holdings of transaction portfolios in specified portfolio group.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe 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)
asAtThe 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)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Holding&quot; or &quot;Portfolio&quot; domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Holding/system/Cost&quot;. (optional)
byTaxlotsWhether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
includeSettlementEventsAfterDaysNumber of days ahead to bring back settlements from, in relation to the specified effectiveAt (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of VersionedResourceListOfPortfolioHolding

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupAccessMetadataByKey()

List<AccessMetadataValue> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupAccessMetadataByKeyWithHttpInfo()

ApiResponse<List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupCommands()

ResourceListOfProcessedCommand Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to retrieve the commands for.
codeThe code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the result set. For example, to filter on the User ID, use &quot;userId.id eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupCommandsWithHttpInfo()

ApiResponse<ResourceListOfProcessedCommand> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to retrieve the commands for.
codeThe code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAtThe lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAtThe upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filterExpression to filter the result set. For example, to filter on the User ID, use &quot;userId.id eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfProcessedCommand

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupExpansion()

ExpandedGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to expand.
codeThe code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAtThe effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe 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)
propertyFilterThe restricted list of property keys from the &quot;Portfolio&quot; domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. &quot;Portfolio/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ExpandedGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupExpansionWithHttpInfo()

ApiResponse<ExpandedGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to expand.
codeThe code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAtThe effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe 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)
propertyFilterThe restricted list of property keys from the &quot;Portfolio&quot; domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. &quot;Portfolio/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ExpandedGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupMetadataWithHttpInfo()

ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupPropertyTimeSeries()

ResourceListOfPropertyInterval Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group.
codeThe code of the group. Together with the scope this uniquely identifies the portfolio group.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;PortfolioGroup/Manager/Id&quot;. Each property must be from the &quot;PortfolioGroup&quot; domain.
portfolioGroupEffectiveAtThe effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio group&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupPropertyTimeSeriesWithHttpInfo()

ApiResponse<ResourceListOfPropertyInterval> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group.
codeThe code of the group. Together with the scope this uniquely identifies the portfolio group.
propertyKeyThe property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. &quot;PortfolioGroup/Manager/Id&quot;. Each property must be from the &quot;PortfolioGroup&quot; domain.
portfolioGroupEffectiveAtThe effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio group&#39;s property history. Defaults to return the current datetime if not supplied. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of ResourceListOfPropertyInterval

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupRelations()

ResourceListOfRelation Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupRelationships()

ResourceListOfRelationship Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupRelationshipsWithHttpInfo()

ApiResponse<ResourceListOfRelationship> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupRelationsWithHttpInfo()

ApiResponse<ResourceListOfRelation> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetPortfolioGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetTransactionsForPortfolioGroup()

VersionedResourceListOfTransaction Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDateThe 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)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Transaction Type, use &quot;type eq &#39;Buy&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Transaction&quot;, &quot;LegalEntity&quot; or &quot;CustodianAccount&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
showCancelledTransactionsOption 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ GetTransactionsForPortfolioGroupWithHttpInfo()

ApiResponse<VersionedResourceListOfTransaction> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group.
codeThe code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDateThe 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)
toTransactionDateThe upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAtThe asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Transaction Type, use &quot;type eq &#39;Buy&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeysA list of property keys from the &quot;Instrument&quot;, &quot;Transaction&quot;, &quot;LegalEntity&quot; or &quot;CustodianAccount&quot; domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. &quot;Instrument/system/Name&quot; or &quot;Transaction/strategy/quantsignal&quot;. (optional)
limitWhen paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
pageThe pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
showCancelledTransactionsOption 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)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of VersionedResourceListOfTransaction

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ ListPortfolioGroups()

PagedResourceListOfPortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 
)

ListPortfolioGroups: List portfolio groups

List all the portfolio groups in a single scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to list the portfolio groups in.
effectiveAtThe effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
relatedEntityPropertyKeysA 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
PagedResourceListOfPortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ ListPortfolioGroupsWithHttpInfo()

ApiResponse<PagedResourceListOfPortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 
)

ListPortfolioGroups: List portfolio groups

List all the portfolio groups in a single scope.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to list the portfolio groups in.
effectiveAtThe effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAtThe asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional)
filterExpression to filter the result set. For example, to filter on the Display Name, use &quot;displayName eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortByA list of field names to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
relatedEntityPropertyKeysA 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 &#39;Portfolio/Manager/Id&#39;. (optional)
relationshipDefinitionIdsA 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)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PagedResourceListOfPortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ PatchPortfolioGroupAccessMetadata()

Dictionary<string, List<AccessMetadataValue> > Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Group
codeThe Portfolio Group code
accessMetadataOperationThe Json patch document
effectiveAtThe date this rule will be effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ PatchPortfolioGroupAccessMetadataWithHttpInfo()

ApiResponse<Dictionary<string, List<AccessMetadataValue> > > Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 &#39;add&#39; is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Portfolio Group
codeThe Portfolio Group code
accessMetadataOperationThe Json patch document
effectiveAtThe date this rule will be effective from (optional)
effectiveUntilThe effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next &#39;effectiveAt&#39; date of the Access Metadata (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of Dictionary<string, List<AccessMetadataValue>>

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpdatePortfolioGroup()

PortfolioGroup Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to update the definition for.
codeThe code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label at which to update the definition. (optional)
updatePortfolioGroupRequestThe updated portfolio group definition. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpdatePortfolioGroupWithHttpInfo()

ApiResponse<PortfolioGroup> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the portfolio group to update the definition for.
codeThe code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAtThe effective datetime or cut label at which to update the definition. (optional)
updatePortfolioGroupRequestThe updated portfolio group definition. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroup

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertGroupProperties()

PortfolioGroupProperties Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 &#39;PortfolioGroup&#39;. 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group to update or insert the properties onto.
codeThe code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBodyThe 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. &quot;PortfolioGroup/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
PortfolioGroupProperties

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertGroupPropertiesWithHttpInfo()

ApiResponse<PortfolioGroupProperties> Lusid.Sdk.Api.IPortfolioGroupsApiSync.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 &#39;PortfolioGroup&#39;. 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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the group to update or insert the properties onto.
codeThe code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBodyThe 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. &quot;PortfolioGroup/Manager/Id&quot;. (optional)
operationIndexIndex associated with the operation.
Returns
ApiResponse of PortfolioGroupProperties

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertPortfolioGroupAccessMetadata()

ResourceListOfAccessMetadataValueOf Lusid.Sdk.Api.IPortfolioGroupsApiSync.UpsertPortfolioGroupAccessMetadata ( string  scope,
string  code,
string  metadataKey,
UpsertPortfolioGroupAccessMetadataRequest  upsertPortfolioGroupAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

◆ UpsertPortfolioGroupAccessMetadataWithHttpInfo()

ApiResponse<ResourceListOfAccessMetadataValueOf> Lusid.Sdk.Api.IPortfolioGroupsApiSync.UpsertPortfolioGroupAccessMetadataWithHttpInfo ( string  scope,
string  code,
string  metadataKey,
UpsertPortfolioGroupAccessMetadataRequest  upsertPortfolioGroupAccessMetadataRequest,
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  effectiveUntil = default(DateTimeOffset?),
int  operationIndex = 0 
)

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

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.


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