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

Inheritance diagram for Lusid.Sdk.Api.IPortfolioGroupsApiSync:

[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< PortfolioGroup >	AddPortfolioToGroupWithHttpInfo (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< PortfolioGroup >	AddSubGroupToGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), ResourceId? resourceId=default(ResourceId?), int operationIndex=0)
	[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group 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< VersionedResourceListOfOutputTransaction >	BuildTransactionsForPortfolioGroupWithHttpInfo (string scope, string code, TransactionQueryParameters transactionQueryParameters, DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), int operationIndex=0)
	BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group More...

PortfolioGroup	CreatePortfolioGroup (string scope, CreatePortfolioGroupRequest? createPortfolioGroupRequest=default(CreatePortfolioGroupRequest?), int operationIndex=0)
	CreatePortfolioGroup: Create portfolio group More...

ApiResponse< PortfolioGroup >	CreatePortfolioGroupWithHttpInfo (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< DeletedEntityResponse >	DeleteGroupPropertiesWithHttpInfo (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< DeletedEntityResponse >	DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry 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< PortfolioGroup >	DeletePortfolioFromGroupWithHttpInfo (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< DeletedEntityResponse >	DeletePortfolioGroupWithHttpInfo (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< PortfolioGroup >	DeleteSubGroupFromGroupWithHttpInfo (string scope, string code, string subgroupScope, string subgroupCode, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), int operationIndex=0)
	[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group 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< VersionedResourceListOfA2BDataRecord >	GetA2BDataForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel fromEffectiveAt, DateTimeOrCutLabel toEffectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? recipeIdScope=default(string?), string? recipeIdCode=default(string?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0)
	[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group 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< PortfolioGroupProperties >	GetGroupPropertiesWithHttpInfo (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 operationIndex=0)
	GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group More...

ApiResponse< VersionedResourceListOfPortfolioHolding >	GetHoldingsForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), bool? byTaxlots=default(bool?), int operationIndex=0)
	GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group 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< PortfolioGroup >	GetPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
	GetPortfolioGroup: Get portfolio group More...

List< AccessMetadataValue >	GetPortfolioGroupAccessMetadataByKey (string scope, string code, string metadataKey, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group 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< ResourceListOfProcessedCommand >	GetPortfolioGroupCommandsWithHttpInfo (string scope, string code, DateTimeOffset? fromAsAt=default(DateTimeOffset?), DateTimeOffset? toAsAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0)
	GetPortfolioGroupCommands: Get portfolio group commands 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< ExpandedGroup >	GetPortfolioGroupExpansionWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyFilter=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion 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< ResourceListOfPropertyInterval >	GetPortfolioGroupPropertyTimeSeriesWithHttpInfo (string scope, string code, string propertyKey, string? portfolioGroupEffectiveAt=default(string?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), string? page=default(string?), int? limit=default(int?), int operationIndex=0)
	[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property 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< ResourceListOfRelation >	GetPortfolioGroupRelationsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group 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< ResourceListOfRelationship >	GetPortfolioGroupRelationshipsWithHttpInfo (string scope, string code, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? identifierTypes=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group 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< VersionedResourceListOfTransaction >	GetTransactionsForPortfolioGroupWithHttpInfo (string scope, string code, DateTimeOrCutLabel? fromTransactionDate=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toTransactionDate=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int? limit=default(int?), string? page=default(string?), bool? showCancelledTransactions=default(bool?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group More...

PagedResourceListOfPortfolioGroup	ListPortfolioGroups (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListPortfolioGroups: List portfolio groups More...

ApiResponse< PagedResourceListOfPortfolioGroup >	ListPortfolioGroupsWithHttpInfo (string scope, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? relatedEntityPropertyKeys=default(List< string >?), List< string >? relationshipDefinitionIds=default(List< string >?), int operationIndex=0)
	[EARLY ACCESS] ListPortfolioGroups: List portfolio groups 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< PortfolioGroup >	UpdatePortfolioGroupWithHttpInfo (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< PortfolioGroupProperties >	UpsertGroupPropertiesWithHttpInfo (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)
	[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. More...

ApiResponse< ResourceListOfAccessMetadataValueOf >	UpsertPortfolioGroupAccessMetadataWithHttpInfo (string scope, string code, string metadataKey, UpsertPortfolioGroupAccessMetadataRequest upsertPortfolioGroupAccessMetadataRequest, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? effectiveUntil=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey. This creates or updates the data in LUSID. 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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to add a portfolio to.
code	The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label from which the portfolio will be added to the group. (optional)
resourceId	The resource identifier of the portfolio to add to the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to add a portfolio to.
code	The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label from which the portfolio will be added to the group. (optional)
resourceId	The resource identifier of the portfolio to add to the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to add a portfolio group to.
code	The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label from which the sub group will be added to the group. (optional)
resourceId	The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to add a portfolio group to.
code	The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label from which the sub group will be added to the group. (optional)
resourceId	The resource identifier of the portfolio group to add to the portfolio group as a sub group. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
transactionQueryParameters	The query queryParameters which control how the output transactions are built.
asAt	The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfOutputTransaction

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
transactionQueryParameters	The query queryParameters which control how the output transactions are built.
asAt	The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument" or "Transaction" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to BuildTransactions. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfOutputTransaction

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope that the portfolio group will be created in.
createPortfolioGroupRequest	The definition and details of the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope that the portfolio group will be created in.
createPortfolioGroupRequest	The definition and details of the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to delete properties from.
code	The code of the group to delete properties from. Together with the scope this uniquely identifies the group.
requestBody	The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to delete properties from.
code	The code of the group to delete properties from. Together with the scope this uniquely identifies the group.
requestBody	The property keys of the properties to delete. These take the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
effectiveAt	The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified 'effectiveAt' datetime. If the 'effectiveAt' is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if any of the properties to delete are perpetual. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the Access Metadata entry to delete
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the Access Metadata entry to delete
effectiveAt	The effective date to delete at, if this is not supplied, it will delete all data found (optional)
effectiveUntil	The effective date until which the delete is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to remove the portfolio from.
code	The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScope	The scope of the portfolio being removed from the portfolio group.
portfolioCode	The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAt	The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to remove the portfolio from.
code	The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group.
portfolioScope	The scope of the portfolio being removed from the portfolio group.
portfolioCode	The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove.
effectiveAt	The effective datetime or cut label from which the portfolio will be removed from the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to delete.
code	The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
operationIndex	Index associated with the operation.

Returns: DeletedEntityResponse

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's creation datetime, ie. the portfolio group will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to delete.
code	The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DeletedEntityResponse

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to remove the sub group from.
code	The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScope	The scope of the sub group to remove from the portfolio group.
subgroupCode	The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAt	The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to remove the sub group from.
code	The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group.
subgroupScope	The scope of the sub group to remove from the portfolio group.
subgroupCode	The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group.
effectiveAt	The effective datetime or cut label from which the sub group will be removed from the portfolio group. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to retrieve the A2B report for.
code	The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.
fromEffectiveAt	The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAt	The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAt	The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScope	The scope of the given recipeId (optional)
recipeIdCode	The code of the given recipeId (optional)
propertyKeys	A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfA2BDataRecord

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to retrieve the A2B report for.
code	The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group.
fromEffectiveAt	The lower bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no lower bound if this is not specified.
toEffectiveAt	The upper bound effective datetime or cut label (inclusive) from which to retrieve the data. There is no upper bound if this is not specified.
asAt	The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified. (optional)
recipeIdScope	The scope of the given recipeId (optional)
recipeIdCode	The code of the given recipeId (optional)
propertyKeys	A list of property keys from the "Instrument" domain to decorate onto the results. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name". (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfA2BDataRecord

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to list the properties for.
code	The code of the group to list the properties for. Together with the scope this uniquely identifies the group.
effectiveAt	The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroupProperties

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to list the properties for.
code	The code of the group to list the properties for. Together with the scope this uniquely identifies the group.
effectiveAt	The effective date time or cut label at which to list the group's properties. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt date time at which to list the group's properties. Defaults to return the latest version of each property if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroupProperties

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	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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional)
byTaxlots	Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfPortfolioHolding

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	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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the holdings of transaction portfolios in the portfolio group. Defaults to return the latest version of the holdings if not specified. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument", "Holding" or "Portfolio" domain to decorate onto the holdings. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Holding/system/Cost". (optional)
byTaxlots	Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfPortfolioHolding

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to retrieve the definition for.
code	The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effectiveAt datetime at which to retrieve the access metadata (optional)
asAt	The asAt datetime at which to retrieve the access metadata (optional)
operationIndex	Index associated with the operation.

Returns: List<AccessMetadataValue>

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the metadata entry to retrieve
effectiveAt	The effectiveAt datetime at which to retrieve the access metadata (optional)
asAt	The asAt datetime at which to retrieve the access metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of List<AccessMetadataValue>

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to retrieve the commands for.
code	The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfProcessedCommand

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to retrieve the commands for.
code	The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group.
fromAsAt	The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified. (optional)
toAsAt	The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the User ID, use "userId.id eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfProcessedCommand

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to expand.
code	The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAt	The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional)
propertyFilter	The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: ExpandedGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to expand.
code	The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand.
effectiveAt	The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to expand the portfolio group. Defaults to return the latest version of each portfolio in the group if not specified. (optional)
propertyFilter	The restricted list of property keys from the "Portfolio" domain which will be decorated onto each portfolio. These take the format {domain}/{scope}/{code} e.g. "Portfolio/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ExpandedGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: Dictionary<string, List<AccessMetadataValue>>

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
effectiveAt	The effectiveAt datetime at which to retrieve the Access Metadata (optional)
asAt	The asAt datetime at which to retrieve the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group.
code	The code of the group. Together with the scope this uniquely identifies the portfolio group.
propertyKey	The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
portfolioGroupEffectiveAt	The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfPropertyInterval

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group.
code	The code of the group. Together with the scope this uniquely identifies the portfolio group.
propertyKey	The property key of the property that will have its history shown. These must be in the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". Each property must be from the "PortfolioGroup" domain.
portfolioGroupEffectiveAt	The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio group's property history. Defaults to return the current datetime if not supplied. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
page	The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfPropertyInterval

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfRelation

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfRelationship

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter relationships. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifier types (as property keys) used for referencing Persons or Legal Entities. These can be specified from the 'Person' or 'LegalEntity' domains and have the format {domain}/{scope}/{code}, for example 'Person/CompanyDetails/Role'. An Empty array may be used to return all related Entities. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfRelationship

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified. (optional)
filter	Expression to filter the relations. Users should provide null or empty string for this field until further notice. (optional)
identifierTypes	Identifiers types (as property keys) used for referencing Persons or Legal Entities. These take the format {domain}/{scope}/{code} e.g. "Person/CompanyDetails/Role". They must be from the "Person" or "LegalEntity" domain. Only identifier types stated will be used to look up relevant entities in relations. If not applicable, provide an empty array. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfRelation

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to retrieve the definition for.
code	The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to retrieve the portfolio group definition. Defaults to return the latest version of the portfolio group definition if not specified. (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio group in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional)
toTransactionDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAt	The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
showCancelledTransactions	Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.

Returns: VersionedResourceListOfTransaction

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group.
code	The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group.
fromTransactionDate	The lower bound effective datetime or cut label (inclusive) from which to retrieve the transactions. There is no lower bound if this is not specified. (optional)
toTransactionDate	The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified. (optional)
asAt	The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Transaction Type, use "type eq 'Buy'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
propertyKeys	A list of property keys from the "Instrument", "Transaction", "LegalEntity" or "CustodianAccount" domain to decorate onto the transactions. These take the format {domain}/{scope}/{code} e.g. "Instrument/system/Name" or "Transaction/strategy/quantsignal". (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to 100 if not specified. (optional)
page	The pagination token to use to continue listing transactions from a previous call to GetTransactions. (optional)
showCancelledTransactions	Option to specify whether or not to include cancelled transactions, including previous versions of transactions which have since been amended. Defaults to False if not specified. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of VersionedResourceListOfTransaction

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`
	)

[EARLY ACCESS] ListPortfolioGroups: List portfolio groups

List all the portfolio groups in a single scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to list the portfolio groups in.
effectiveAt	The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
page	The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfPortfolioGroup

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`
	)

[EARLY ACCESS] ListPortfolioGroups: List portfolio groups

List all the portfolio groups in a single scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to list the portfolio groups in.
effectiveAt	The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified. (optional)
asAt	The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified. (optional)
page	The pagination token to use to continue listing portfolio groups from a previous call to list portfolio groups. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, sortBy and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. Defaults to no limit if not specified. (optional)
filter	Expression to filter the result set. For example, to filter on the Display Name, use "displayName eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
relatedEntityPropertyKeys	A list of property keys from any domain that supports relationships to decorate onto related entities. These must take the format {domain}/{scope}/{code}, for example 'Portfolio/Manager/Id'. (optional)
relationshipDefinitionIds	A list of relationship definitions that are used to decorate related entities onto the portfolio groups in the response. These must take the form {relationshipDefinitionScope}/{relationshipDefinitionCode}. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfPortfolioGroup

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 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
accessMetadataOperation	The Json patch document
effectiveAt	The date this rule will be effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: Dictionary<string, List<AccessMetadataValue>>

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 'add' is a supported operation on the patch document. Currently only valid metadata keys are supported paths on the patch document. The response will return any affected Portfolio Group Access Metadata rules or a failure message if unsuccessful. It is important to always check to verify success (or failure). Multiple rules for a metadataKey can exist with different effective at dates, when resources are accessed the rule that is active for the current time will be fetched.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
accessMetadataOperation	The Json patch document
effectiveAt	The date this rule will be effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of Dictionary<string, List<AccessMetadataValue>>

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to update the definition for.
code	The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to update the definition. (optional)
updatePortfolioGroupRequest	The updated portfolio group definition. (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroup

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.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the portfolio group to update the definition for.
code	The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group.
effectiveAt	The effective datetime or cut label at which to update the definition. (optional)
updatePortfolioGroupRequest	The updated portfolio group definition. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroup

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 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to update or insert the properties onto.
code	The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBody	The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: PortfolioGroupProperties

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 'PortfolioGroup'. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an effectiveFrom datetime for which the property is valid, and an effectiveUntil datetime until which the property is valid. Not supplying an effectiveUntil datetime results in the property being valid indefinitely, or until the next effectiveFrom datetime of the property.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the group to update or insert the properties onto.
code	The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group.
requestBody	The properties to be updated or inserted onto the group. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code} e.g. "PortfolioGroup/Manager/Id". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PortfolioGroupProperties

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`
	)

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

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the access metadata entry to upsert
upsertPortfolioGroupAccessMetadataRequest	The Portfolio Group Access Metadata rule to upsert
effectiveAt	The date this rule will be effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfAccessMetadataValueOf

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`
	)

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

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Portfolio Group
code	The Portfolio Group code
metadataKey	Key of the access metadata entry to upsert
upsertPortfolioGroupAccessMetadataRequest	The Portfolio Group Access Metadata rule to upsert
effectiveAt	The date this rule will be effective from (optional)
effectiveUntil	The effective date until which the Access Metadata is valid. If not supplied this will be valid indefinitely, or until the next 'effectiveAt' date of the Access Metadata (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfAccessMetadataValueOf

Implemented in Lusid.Sdk.Api.PortfolioGroupsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/PortfolioGroupsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddPortfolioToGroup()

◆ AddPortfolioToGroupWithHttpInfo()

◆ AddSubGroupToGroup()

◆ AddSubGroupToGroupWithHttpInfo()

◆ BuildTransactionsForPortfolioGroup()

◆ BuildTransactionsForPortfolioGroupWithHttpInfo()

◆ CreatePortfolioGroup()

◆ CreatePortfolioGroupWithHttpInfo()

◆ DeleteGroupProperties()

◆ DeleteGroupPropertiesWithHttpInfo()

◆ DeleteKeyFromPortfolioGroupAccessMetadata()

◆ DeleteKeyFromPortfolioGroupAccessMetadataWithHttpInfo()

◆ DeletePortfolioFromGroup()

◆ DeletePortfolioFromGroupWithHttpInfo()

◆ DeletePortfolioGroup()

◆ DeletePortfolioGroupWithHttpInfo()

◆ DeleteSubGroupFromGroup()

◆ DeleteSubGroupFromGroupWithHttpInfo()

◆ GetA2BDataForPortfolioGroup()

◆ GetA2BDataForPortfolioGroupWithHttpInfo()

◆ GetGroupProperties()

◆ GetGroupPropertiesWithHttpInfo()

◆ GetHoldingsForPortfolioGroup()

◆ GetHoldingsForPortfolioGroupWithHttpInfo()

◆ GetPortfolioGroup()

◆ GetPortfolioGroupAccessMetadataByKey()

◆ GetPortfolioGroupAccessMetadataByKeyWithHttpInfo()

◆ GetPortfolioGroupCommands()

◆ GetPortfolioGroupCommandsWithHttpInfo()

◆ GetPortfolioGroupExpansion()

◆ GetPortfolioGroupExpansionWithHttpInfo()

◆ GetPortfolioGroupMetadata()

◆ GetPortfolioGroupMetadataWithHttpInfo()

◆ GetPortfolioGroupPropertyTimeSeries()

◆ GetPortfolioGroupPropertyTimeSeriesWithHttpInfo()

◆ GetPortfolioGroupRelations()

◆ GetPortfolioGroupRelationships()

◆ GetPortfolioGroupRelationshipsWithHttpInfo()

◆ GetPortfolioGroupRelationsWithHttpInfo()

◆ GetPortfolioGroupWithHttpInfo()

◆ GetTransactionsForPortfolioGroup()

◆ GetTransactionsForPortfolioGroupWithHttpInfo()

◆ ListPortfolioGroups()

◆ ListPortfolioGroupsWithHttpInfo()

◆ PatchPortfolioGroupAccessMetadata()

◆ PatchPortfolioGroupAccessMetadataWithHttpInfo()

◆ UpdatePortfolioGroup()

◆ UpdatePortfolioGroupWithHttpInfo()

◆ UpsertGroupProperties()

◆ UpsertGroupPropertiesWithHttpInfo()

◆ UpsertPortfolioGroupAccessMetadata()

◆ UpsertPortfolioGroupAccessMetadataWithHttpInfo()