sdk.lusid.api.portfolio_groups_api.PortfolioGroupsApi

class PortfolioGroupsApi(api_client=None)

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

add_portfolio_to_group	[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group # noqa: E501
add_portfolio_to_group_with_http_info	[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group # noqa: E501
add_sub_group_to_group	[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group # noqa: E501
add_sub_group_to_group_with_http_info	[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group # noqa: E501
build_transactions_for_portfolio_group	BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501
build_transactions_for_portfolio_group_with_http_info	BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501
create_portfolio_group	CreatePortfolioGroup: Create portfolio group # noqa: E501
create_portfolio_group_with_http_info	CreatePortfolioGroup: Create portfolio group # noqa: E501
delete_group_properties	[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501
delete_group_properties_with_http_info	[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501
delete_key_from_portfolio_group_access_metadata	[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501
delete_key_from_portfolio_group_access_metadata_with_http_info	[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501
delete_portfolio_from_group	[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group # noqa: E501
delete_portfolio_from_group_with_http_info	[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group # noqa: E501
delete_portfolio_group	[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501
delete_portfolio_group_with_http_info	[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501
delete_sub_group_from_group	[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group # noqa: E501
delete_sub_group_from_group_with_http_info	[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group # noqa: E501
get_a2_b_data_for_portfolio_group	[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501
get_a2_b_data_for_portfolio_group_with_http_info	[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501
get_group_properties	[EARLY ACCESS] GetGroupProperties: Get group properties # noqa: E501
get_group_properties_with_http_info	[EARLY ACCESS] GetGroupProperties: Get group properties # noqa: E501
get_holdings_for_portfolio_group	GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501
get_holdings_for_portfolio_group_with_http_info	GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501
get_portfolio_group	GetPortfolioGroup: Get portfolio group # noqa: E501
get_portfolio_group_access_metadata_by_key	[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501
get_portfolio_group_access_metadata_by_key_with_http_info	[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501
get_portfolio_group_commands	GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501
get_portfolio_group_commands_with_http_info	GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501
get_portfolio_group_expansion	[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501
get_portfolio_group_expansion_with_http_info	[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501
get_portfolio_group_metadata	[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group # noqa: E501
get_portfolio_group_metadata_with_http_info	[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group # noqa: E501
get_portfolio_group_property_time_series	[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501
get_portfolio_group_property_time_series_with_http_info	[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501
get_portfolio_group_relations	[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501
get_portfolio_group_relations_with_http_info	[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501
get_portfolio_group_relationships	[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501
get_portfolio_group_relationships_with_http_info	[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501
get_portfolio_group_with_http_info	GetPortfolioGroup: Get portfolio group # noqa: E501
get_transactions_for_portfolio_group	GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501
get_transactions_for_portfolio_group_with_http_info	GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501
list_portfolio_groups	[EARLY ACCESS] ListPortfolioGroups: List portfolio groups # noqa: E501
list_portfolio_groups_with_http_info	[EARLY ACCESS] ListPortfolioGroups: List portfolio groups # noqa: E501
patch_portfolio_group_access_metadata	[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group.
patch_portfolio_group_access_metadata_with_http_info	[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group.
update_portfolio_group	[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501
update_portfolio_group_with_http_info	[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501
upsert_group_properties	[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501
upsert_group_properties_with_http_info	[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501
upsert_portfolio_group_access_metadata	[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey.
upsert_portfolio_group_access_metadata_with_http_info	[EARLY ACCESS] UpsertPortfolioGroupAccessMetadata: Upsert a Portfolio Group Access Metadata entry associated with a specific metadataKey.

add_portfolio_to_group(scope, code, effective_at=None, resource_id=None, async_req=None, **kwargs)

[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group # noqa: E501

Add a single portfolio to a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_portfolio_to_group(scope, code, effective_at, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to add a portfolio to. (required)

• code (str) – The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label from which the portfolio will be added to the group.

• resource_id (ResourceId) – The resource identifier of the portfolio to add to the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

add_portfolio_to_group_with_http_info(scope, code, effective_at=None, resource_id=None, **kwargs)

[EARLY ACCESS] AddPortfolioToGroup: Add portfolio to group # noqa: E501

Add a single portfolio to a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_portfolio_to_group_with_http_info(scope, code, effective_at, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to add a portfolio to. (required)

• code (str) – The code of the portfolio group to add a portfolio to. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label from which the portfolio will be added to the group.

• resource_id (ResourceId) – The resource identifier of the portfolio to add to the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

add_sub_group_to_group(scope, code, effective_at=None, resource_id=None, async_req=None, **kwargs)

[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group # noqa: E501

Add a portfolio group to a portfolio group as a sub group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_sub_group_to_group(scope, code, effective_at, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to add a portfolio group to. (required)

• code (str) – The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label from which the sub group will be added to the group.

• resource_id (ResourceId) – The resource identifier of the portfolio group to add to the portfolio group as a sub group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

add_sub_group_to_group_with_http_info(scope, code, effective_at=None, resource_id=None, **kwargs)

[EARLY ACCESS] AddSubGroupToGroup: Add sub group to group # noqa: E501

Add a portfolio group to a portfolio group as a sub group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.add_sub_group_to_group_with_http_info(scope, code, effective_at, resource_id, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to add a portfolio group to. (required)

• code (str) – The code of the portfolio group to add a portfolio group to. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label from which the sub group will be added to the group.

• resource_id (ResourceId) – The resource identifier of the portfolio group to add to the portfolio group as a sub group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

build_transactions_for_portfolio_group(scope, code, transaction_query_parameters, as_at=None, filter=None, property_keys=None, limit=None, page=None, async_req=None, **kwargs)

BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.build_transactions_for_portfolio_group(scope, code, transaction_query_parameters, as_at, filter, property_keys, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• transaction_query_parameters (TransactionQueryParameters) – The query queryParameters which control how the output transactions are built. (required)

• as_at (datetime) – The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.

• filter (str) – 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.

• property_keys (List[str]) – 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”.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to BuildTransactions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

VersionedResourceListOfOutputTransaction

build_transactions_for_portfolio_group_with_http_info(scope, code, transaction_query_parameters, as_at=None, filter=None, property_keys=None, limit=None, page=None, **kwargs)

BuildTransactionsForPortfolioGroup: Build transactions for transaction portfolios in a portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.build_transactions_for_portfolio_group_with_http_info(scope, code, transaction_query_parameters, as_at, filter, property_keys, limit, page, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• transaction_query_parameters (TransactionQueryParameters) – The query queryParameters which control how the output transactions are built. (required)

• as_at (datetime) – The asAt datetime at which to build the transactions. Defaults to return the latest version of each transaction if not specified.

• filter (str) – 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.

• property_keys (List[str]) – 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”.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to BuildTransactions.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(VersionedResourceListOfOutputTransaction, status_code(int), headers(HTTPHeaderDict))

create_portfolio_group(scope, create_portfolio_group_request=None, async_req=None, **kwargs)

CreatePortfolioGroup: Create portfolio group # noqa: E501

Create a portfolio group in a specific scope. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_portfolio_group(scope, create_portfolio_group_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope that the portfolio group will be created in. (required)

• create_portfolio_group_request (CreatePortfolioGroupRequest) – The definition and details of the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

create_portfolio_group_with_http_info(scope, create_portfolio_group_request=None, **kwargs)

CreatePortfolioGroup: Create portfolio group # noqa: E501

Create a portfolio group in a specific scope. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_portfolio_group_with_http_info(scope, create_portfolio_group_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope that the portfolio group will be created in. (required)

• create_portfolio_group_request (CreatePortfolioGroupRequest) – The definition and details of the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

delete_group_properties(scope, code, request_body, effective_at=None, async_req=None, **kwargs)

[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_group_properties(scope, code, request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to delete properties from. (required)

• code (str) – The code of the group to delete properties from. Together with the scope this uniquely identifies the group. (required)

• request_body (List[str]) – 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. (required)

• effective_at (str) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_group_properties_with_http_info(scope, code, request_body, effective_at=None, **kwargs)

[EARLY ACCESS] DeleteGroupProperties: Delete group properties # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_group_properties_with_http_info(scope, code, request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to delete properties from. (required)

• code (str) – The code of the group to delete properties from. Together with the scope this uniquely identifies the group. (required)

• request_body (List[str]) – 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. (required)

• effective_at (str) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_key_from_portfolio_group_access_metadata(scope, code, metadata_key, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501

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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_key_from_portfolio_group_access_metadata(scope, code, metadata_key, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the Access Metadata entry to delete (required)

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_key_from_portfolio_group_access_metadata_with_http_info(scope, code, metadata_key, effective_at=None, effective_until=None, **kwargs)

[EARLY ACCESS] DeleteKeyFromPortfolioGroupAccessMetadata: Delete a Portfolio Group Access Metadata entry # noqa: E501

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). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_key_from_portfolio_group_access_metadata_with_http_info(scope, code, metadata_key, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the Access Metadata entry to delete (required)

• effective_at (str) – The effective date to delete at, if this is not supplied, it will delete all data found

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_portfolio_from_group(scope, code, portfolio_scope, portfolio_code, effective_at=None, async_req=None, **kwargs)

[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group # noqa: E501

Remove a single portfolio from a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_portfolio_from_group(scope, code, portfolio_scope, portfolio_code, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to remove the portfolio from. (required)

• code (str) – The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. (required)

• portfolio_scope (str) – The scope of the portfolio being removed from the portfolio group. (required)

• portfolio_code (str) – The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. (required)

• effective_at (str) – The effective datetime or cut label from which the portfolio will be removed from the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

delete_portfolio_from_group_with_http_info(scope, code, portfolio_scope, portfolio_code, effective_at=None, **kwargs)

[EARLY ACCESS] DeletePortfolioFromGroup: Delete portfolio from group # noqa: E501

Remove a single portfolio from a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_portfolio_from_group_with_http_info(scope, code, portfolio_scope, portfolio_code, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to remove the portfolio from. (required)

• code (str) – The code of the portfolio group to remove the portfolio from. Together with the scope this uniquely identifies the portfolio group. (required)

• portfolio_scope (str) – The scope of the portfolio being removed from the portfolio group. (required)

• portfolio_code (str) – The code of the portfolio being removed from the portfolio group. Together with the scope this uniquely identifies the portfolio to remove. (required)

• effective_at (str) – The effective datetime or cut label from which the portfolio will be removed from the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

delete_portfolio_group(scope, code, async_req=None, **kwargs)

[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_portfolio_group(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to delete. (required)

• code (str) – The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_portfolio_group_with_http_info(scope, code, **kwargs)

[EARLY ACCESS] DeletePortfolioGroup: Delete portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_portfolio_group_with_http_info(scope, code, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to delete. (required)

• code (str) – The code of the portfolio group to delete. Together with the scope this uniquely identifies the portfolio group to delete. (required)

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_sub_group_from_group(scope, code, subgroup_scope, subgroup_code, effective_at=None, async_req=None, **kwargs)

[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group # noqa: E501

Remove a single portfolio group (sub group) from a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_sub_group_from_group(scope, code, subgroup_scope, subgroup_code, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to remove the sub group from. (required)

• code (str) – The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. (required)

• subgroup_scope (str) – The scope of the sub group to remove from the portfolio group. (required)

• subgroup_code (str) – The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. (required)

• effective_at (str) – The effective datetime or cut label from which the sub group will be removed from the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

delete_sub_group_from_group_with_http_info(scope, code, subgroup_scope, subgroup_code, effective_at=None, **kwargs)

[EARLY ACCESS] DeleteSubGroupFromGroup: Delete sub group from group # noqa: E501

Remove a single portfolio group (sub group) from a portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_sub_group_from_group_with_http_info(scope, code, subgroup_scope, subgroup_code, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to remove the sub group from. (required)

• code (str) – The code of the portfolio group to remove the sub group from. Together with the scope this uniquely identifies the portfolio group. (required)

• subgroup_scope (str) – The scope of the sub group to remove from the portfolio group. (required)

• subgroup_code (str) – The code of the sub group to remove from the portfolio group. Together with the scope this uniquely identifies the sub group. (required)

• effective_at (str) – The effective datetime or cut label from which the sub group will be removed from the portfolio group.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

get_a2_b_data_for_portfolio_group(scope, code, from_effective_at, to_effective_at, as_at=None, recipe_id_scope=None, recipe_id_code=None, property_keys=None, filter=None, async_req=None, **kwargs)

[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501

Get an A2B report for all Transaction Portfolios within the given portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_a2_b_data_for_portfolio_group(scope, code, from_effective_at, to_effective_at, as_at, recipe_id_scope, recipe_id_code, property_keys, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to retrieve the A2B report for. (required)

• code (str) – The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. (required)

• from_effective_at (str) – 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. (required)

• to_effective_at (str) – 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. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.

• recipe_id_scope (str) – The scope of the given recipeId

• recipe_id_code (str) – The code of the given recipeId

• property_keys (List[str]) – 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”.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

VersionedResourceListOfA2BDataRecord

get_a2_b_data_for_portfolio_group_with_http_info(scope, code, from_effective_at, to_effective_at, as_at=None, recipe_id_scope=None, recipe_id_code=None, property_keys=None, filter=None, **kwargs)

[EARLY ACCESS] GetA2BDataForPortfolioGroup: Get A2B data for a Portfolio Group # noqa: E501

Get an A2B report for all Transaction Portfolios within the given portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_a2_b_data_for_portfolio_group_with_http_info(scope, code, from_effective_at, to_effective_at, as_at, recipe_id_scope, recipe_id_code, property_keys, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to retrieve the A2B report for. (required)

• code (str) – The code of the group to retrieve the A2B report for. Together with the scope this uniquely identifies the portfolio group. (required)

• from_effective_at (str) – 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. (required)

• to_effective_at (str) – 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. (required)

• as_at (datetime) – The asAt datetime at which to retrieve the portfolio. Defaults to return the latest version of each transaction if not specified.

• recipe_id_scope (str) – The scope of the given recipeId

• recipe_id_code (str) – The code of the given recipeId

• property_keys (List[str]) – 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”.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(VersionedResourceListOfA2BDataRecord, status_code(int), headers(HTTPHeaderDict))

get_group_properties(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetGroupProperties: Get group properties # noqa: E501

List all the properties of a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_group_properties(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to list the properties for. (required)

• code (str) – The code of the group to list the properties for. Together with the scope this uniquely identifies the group. (required)

• effective_at (str) – 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.

• as_at (datetime) – The asAt date time at which to list the group’s properties. Defaults to return the latest version of each property if not specified.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroupProperties

get_group_properties_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetGroupProperties: Get group properties # noqa: E501

List all the properties of a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_group_properties_with_http_info(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to list the properties for. (required)

• code (str) – The code of the group to list the properties for. Together with the scope this uniquely identifies the group. (required)

• effective_at (str) – 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.

• as_at (datetime) – The asAt date time at which to list the group’s properties. Defaults to return the latest version of each property if not specified.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroupProperties, status_code(int), headers(HTTPHeaderDict))

get_holdings_for_portfolio_group(scope, code, effective_at=None, as_at=None, filter=None, property_keys=None, by_taxlots=None, async_req=None, **kwargs)

GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501

Get the holdings of transaction portfolios in specified portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_holdings_for_portfolio_group(scope, code, effective_at, as_at, filter, property_keys, by_taxlots, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – 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.

• as_at (datetime) – 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.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• property_keys (List[str]) – 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”.

• by_taxlots (bool) – Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

VersionedResourceListOfPortfolioHolding

get_holdings_for_portfolio_group_with_http_info(scope, code, effective_at=None, as_at=None, filter=None, property_keys=None, by_taxlots=None, **kwargs)

GetHoldingsForPortfolioGroup: Get holdings for transaction portfolios in portfolio group # noqa: E501

Get the holdings of transaction portfolios in specified portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_holdings_for_portfolio_group_with_http_info(scope, code, effective_at, as_at, filter, property_keys, by_taxlots, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – 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.

• as_at (datetime) – 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.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• property_keys (List[str]) – 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”.

• by_taxlots (bool) – Whether or not to expand the holdings to return the underlying tax-lots. Defaults to False.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(VersionedResourceListOfPortfolioHolding, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group(scope, code, effective_at=None, as_at=None, related_entity_property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)

GetPortfolioGroup: Get portfolio group # noqa: E501

Retrieve the definition of a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group(scope, code, effective_at, as_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to retrieve the definition for. (required)

• code (str) – The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – 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.

• related_entity_property_keys (List[str]) – 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’.

• relationship_definition_ids (List[str]) – 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}.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

get_portfolio_group_access_metadata_by_key(scope, code, metadata_key, effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501

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 # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_access_metadata_by_key(scope, code, metadata_key, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the metadata entry to retrieve (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the access metadata

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

List[AccessMetadataValue]

get_portfolio_group_access_metadata_by_key_with_http_info(scope, code, metadata_key, effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupAccessMetadataByKey: Get an entry identified by a metadataKey in the Access Metadata of a Portfolio Group # noqa: E501

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 # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_access_metadata_by_key_with_http_info(scope, code, metadata_key, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the metadata entry to retrieve (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the access metadata

• as_at (datetime) – The asAt datetime at which to retrieve the access metadata

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(List[AccessMetadataValue], status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_commands(scope, code, from_as_at=None, to_as_at=None, filter=None, async_req=None, **kwargs)

GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501

Gets all the commands that modified a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_commands(scope, code, from_as_at, to_as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to retrieve the commands for. (required)

• code (str) – The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. (required)

• from_as_at (datetime) – The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.

• to_as_at (datetime) – The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.

• filter (str) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfProcessedCommand

get_portfolio_group_commands_with_http_info(scope, code, from_as_at=None, to_as_at=None, filter=None, **kwargs)

GetPortfolioGroupCommands: Get portfolio group commands # noqa: E501

Gets all the commands that modified a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_commands_with_http_info(scope, code, from_as_at, to_as_at, filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to retrieve the commands for. (required)

• code (str) – The code of the portfolio group to retrieve the commands for. Together with the scope this uniquely identifies the portfolio group. (required)

• from_as_at (datetime) – The lower bound asAt datetime (inclusive) from which to retrieve commands. There is no lower bound if this is not specified.

• to_as_at (datetime) – The upper bound asAt datetime (inclusive) from which to retrieve commands. There is no upper bound if this is not specified.

• filter (str) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfProcessedCommand, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_expansion(scope, code, effective_at=None, as_at=None, property_filter=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_expansion(scope, code, effective_at, as_at, property_filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to expand. (required)

• code (str) – The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. (required)

• effective_at (str) – The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – 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.

• property_filter (List[str]) – 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”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ExpandedGroup

get_portfolio_group_expansion_with_http_info(scope, code, effective_at=None, as_at=None, property_filter=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupExpansion: Get portfolio group expansion # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_expansion_with_http_info(scope, code, effective_at, as_at, property_filter, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to expand. (required)

• code (str) – The code of the portfolio group to expand. Together with the scope this uniquely identifies the portfolio group to expand. (required)

• effective_at (str) – The effective datetime or cut label at which to expand the portfolio group. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – 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.

• property_filter (List[str]) – 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”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ExpandedGroup, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_metadata(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group # noqa: E501

Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_metadata(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata

• as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Dict[str, List[AccessMetadataValue]]

get_portfolio_group_metadata_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupMetadata: Get Access Metadata rules for Portfolio Group # noqa: E501

Pass the scope and Portfolio Group code parameters to retrieve the associated Access Metadata # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_metadata_with_http_info(scope, code, effective_at, as_at, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• effective_at (str) – The effectiveAt datetime at which to retrieve the Access Metadata

• as_at (datetime) – The asAt datetime at which to retrieve the Access Metadata

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_property_time_series(scope, code, property_key, portfolio_group_effective_at=None, as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501

List the complete time series of a portfolio group property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_property_time_series(scope, code, property_key, portfolio_group_effective_at, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group. (required)

• code (str) – The code of the group. Together with the scope this uniquely identifies the portfolio group. (required)

• property_key (str) – 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. (required)

• portfolio_group_effective_at (str) – The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the portfolio group’s property history. Defaults to return the current datetime if not supplied.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• page (str) – 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.

• limit (int) – When paginating, limit the number of returned results to this many.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfPropertyInterval

get_portfolio_group_property_time_series_with_http_info(scope, code, property_key, portfolio_group_effective_at=None, as_at=None, filter=None, page=None, limit=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupPropertyTimeSeries: Get the time series of a portfolio group property # noqa: E501

List the complete time series of a portfolio group property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_property_time_series_with_http_info(scope, code, property_key, portfolio_group_effective_at, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group. (required)

• code (str) – The code of the group. Together with the scope this uniquely identifies the portfolio group. (required)

• property_key (str) – 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. (required)

• portfolio_group_effective_at (str) – The effective datetime used to resolve the portfolio group. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the portfolio group’s property history. Defaults to return the current datetime if not supplied.

• filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.

• page (str) – 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.

• limit (int) – When paginating, limit the number of returned results to this many.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfPropertyInterval, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_relations(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)

[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501

Get relations for the specified Portfolio Group # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_relations(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relations. Users should provide null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfRelation

get_portfolio_group_relations_with_http_info(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)

[EXPERIMENTAL] GetPortfolioGroupRelations: Get Relations for Portfolio Group # noqa: E501

Get relations for the specified Portfolio Group # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_relations_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve relations. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve relations. Defaults to return the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter the relations. Users should provide null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfRelation, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_relationships(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, async_req=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501

Get relationships for the specified Portfolio Group # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_relationships(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfRelationship

get_portfolio_group_relationships_with_http_info(scope, code, effective_at=None, as_at=None, filter=None, identifier_types=None, **kwargs)

[EARLY ACCESS] GetPortfolioGroupRelationships: Get Relationships for Portfolio Group # noqa: E501

Get relationships for the specified Portfolio Group # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_relationships_with_http_info(scope, code, effective_at, as_at, filter, identifier_types, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve relationship. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to retrieve relationships. Defaults to return the latest LUSID AsAt time if not specified.

• filter (str) – Expression to filter relationships. Users should provide null or empty string for this field until further notice.

• identifier_types (List[str]) – 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.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfRelationship, status_code(int), headers(HTTPHeaderDict))

get_portfolio_group_with_http_info(scope, code, effective_at=None, as_at=None, related_entity_property_keys=None, relationship_definition_ids=None, **kwargs)

GetPortfolioGroup: Get portfolio group # noqa: E501

Retrieve the definition of a single portfolio group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_portfolio_group_with_http_info(scope, code, effective_at, as_at, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to retrieve the definition for. (required)

• code (str) – The code of the portfolio group to retrieve the definition for. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to retrieve the portfolio group definition. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – 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.

• related_entity_property_keys (List[str]) – 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’.

• relationship_definition_ids (List[str]) – 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}.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

get_transactions_for_portfolio_group(scope, code, from_transaction_date=None, to_transaction_date=None, as_at=None, filter=None, property_keys=None, limit=None, page=None, show_cancelled_transactions=None, sort_by=None, async_req=None, **kwargs)

GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_transactions_for_portfolio_group(scope, code, from_transaction_date, to_transaction_date, as_at, filter, property_keys, limit, page, show_cancelled_transactions, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• from_transaction_date (str) – 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.

• to_transaction_date (str) – The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.

• filter (str) – 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.

• property_keys (List[str]) – 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”.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to GetTransactions.

• show_cancelled_transactions (bool) – 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.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

VersionedResourceListOfTransaction

get_transactions_for_portfolio_group_with_http_info(scope, code, from_transaction_date=None, to_transaction_date=None, as_at=None, filter=None, property_keys=None, limit=None, page=None, show_cancelled_transactions=None, sort_by=None, **kwargs)

GetTransactionsForPortfolioGroup: Get transactions for transaction portfolios in a portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_transactions_for_portfolio_group_with_http_info(scope, code, from_transaction_date, to_transaction_date, as_at, filter, property_keys, limit, page, show_cancelled_transactions, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group. (required)

• code (str) – The code of the portfolio group. Together with the scope this uniquely identifies the portfolio group. (required)

• from_transaction_date (str) – 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.

• to_transaction_date (str) – The upper bound effective datetime or cut label (inclusive) from which to retrieve transactions. There is no upper bound if this is not specified.

• as_at (datetime) – The asAt datetime at which to retrieve the transactions. Defaults to return the latest version of each transaction if not specified.

• filter (str) – 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.

• property_keys (List[str]) – 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”.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to 100 if not specified.

• page (str) – The pagination token to use to continue listing transactions from a previous call to GetTransactions.

• show_cancelled_transactions (bool) – 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.

• sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(VersionedResourceListOfTransaction, status_code(int), headers(HTTPHeaderDict))

list_portfolio_groups(scope, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, related_entity_property_keys=None, relationship_definition_ids=None, async_req=None, **kwargs)

[EARLY ACCESS] ListPortfolioGroups: List portfolio groups # noqa: E501

List all the portfolio groups in a single scope. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_portfolio_groups(scope, effective_at, as_at, page, limit, filter, sort_by, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to list the portfolio groups in. (required)

• effective_at (str) – The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified.

• page (str) – 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.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.

• filter (str) – 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.

• sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”

• related_entity_property_keys (List[str]) – 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’.

• relationship_definition_ids (List[str]) – 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}.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfPortfolioGroup

list_portfolio_groups_with_http_info(scope, effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, related_entity_property_keys=None, relationship_definition_ids=None, **kwargs)

[EARLY ACCESS] ListPortfolioGroups: List portfolio groups # noqa: E501

List all the portfolio groups in a single scope. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_portfolio_groups_with_http_info(scope, effective_at, as_at, page, limit, filter, sort_by, related_entity_property_keys, relationship_definition_ids, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope to list the portfolio groups in. (required)

• effective_at (str) – The effective datetime or cut label at which to list the portfolio groups. Defaults to the current LUSID system datetime if not specified.

• as_at (datetime) – The asAt datetime at which to list the portfolio groups. Defaults to return the latest version of each portfolio group if not specified.

• page (str) – 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.

• limit (int) – When paginating, limit the number of returned results to this many. Defaults to no limit if not specified.

• filter (str) – 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.

• sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”

• related_entity_property_keys (List[str]) – 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’.

• relationship_definition_ids (List[str]) – 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}.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfPortfolioGroup, status_code(int), headers(HTTPHeaderDict))

patch_portfolio_group_access_metadata(scope, code, access_metadata_operation, effective_at=None, effective_until=None, async_req=None, **kwargs)

[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio_group_access_metadata(scope, code, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• access_metadata_operation (List[AccessMetadataOperation]) – The Json patch document (required)

• effective_at (str) – The date this rule will be effective from

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Dict[str, List[AccessMetadataValue]]

patch_portfolio_group_access_metadata_with_http_info(scope, code, access_metadata_operation, effective_at=None, effective_until=None, **kwargs)

[EARLY ACCESS] PatchPortfolioGroupAccessMetadata: Patch Access Metadata rules for a Portfolio Group. # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.patch_portfolio_group_access_metadata_with_http_info(scope, code, access_metadata_operation, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• access_metadata_operation (List[AccessMetadataOperation]) – The Json patch document (required)

• effective_at (str) – The date this rule will be effective from

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Dict[str, List[AccessMetadataValue]], status_code(int), headers(HTTPHeaderDict))

update_portfolio_group(scope, code, effective_at=None, update_portfolio_group_request=None, async_req=None, **kwargs)

[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_portfolio_group(scope, code, effective_at, update_portfolio_group_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to update the definition for. (required)

• code (str) – The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to update the definition.

• update_portfolio_group_request (UpdatePortfolioGroupRequest) – The updated portfolio group definition.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroup

update_portfolio_group_with_http_info(scope, code, effective_at=None, update_portfolio_group_request=None, **kwargs)

[EARLY ACCESS] UpdatePortfolioGroup: Update portfolio group # noqa: E501

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_portfolio_group_with_http_info(scope, code, effective_at, update_portfolio_group_request, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the portfolio group to update the definition for. (required)

• code (str) – The code of the portfolio group to update the definition for. Together with the scope this uniquely identifies the portfolio group. (required)

• effective_at (str) – The effective datetime or cut label at which to update the definition.

• update_portfolio_group_request (UpdatePortfolioGroupRequest) – The updated portfolio group definition.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroup, status_code(int), headers(HTTPHeaderDict))

upsert_group_properties(scope, code, request_body=None, async_req=None, **kwargs)

[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501

Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘PortfolioGroup’. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_group_properties(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to update or insert the properties onto. (required)

• code (str) – The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. (required)

• request_body (Dict[str, ModelProperty]) – 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”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PortfolioGroupProperties

upsert_group_properties_with_http_info(scope, code, request_body=None, **kwargs)

[EARLY ACCESS] UpsertGroupProperties: Upsert group properties # noqa: E501

Update or insert one or more properties onto a single group. A property will be updated if it already exists and inserted if it does not. All properties must be of the domain ‘PortfolioGroup’. Upserting a property that exists for a group, with a null value, will delete the instance of the property for that group. Properties have an <i>effectiveFrom</i> datetime for which the property is valid, and an <i>effectiveUntil</i> datetime until which the property is valid. Not supplying an <i>effectiveUntil</i> datetime results in the property being valid indefinitely, or until the next <i>effectiveFrom</i> datetime of the property. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_group_properties_with_http_info(scope, code, request_body, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the group to update or insert the properties onto. (required)

• code (str) – The code of the group to update or insert the properties onto. Together with the scope this uniquely identifies the group. (required)

• request_body (Dict[str, ModelProperty]) – 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”.

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PortfolioGroupProperties, status_code(int), headers(HTTPHeaderDict))

upsert_portfolio_group_access_metadata(scope, code, metadata_key, upsert_portfolio_group_access_metadata_request, effective_at=None, effective_until=None, async_req=None, **kwargs)

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

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_portfolio_group_access_metadata(scope, code, metadata_key, upsert_portfolio_group_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the access metadata entry to upsert (required)

• upsert_portfolio_group_access_metadata_request (UpsertPortfolioGroupAccessMetadataRequest) – The Portfolio Group Access Metadata rule to upsert (required)

• effective_at (str) – The date this rule will be effective from

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

ResourceListOfAccessMetadataValueOf

upsert_portfolio_group_access_metadata_with_http_info(scope, code, metadata_key, upsert_portfolio_group_access_metadata_request, effective_at=None, effective_until=None, **kwargs)

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

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. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_portfolio_group_access_metadata_with_http_info(scope, code, metadata_key, upsert_portfolio_group_access_metadata_request, effective_at, effective_until, async_req=True)
>>> result = thread.get()

Parameters:

• scope (str) – The scope of the Portfolio Group (required)

• code (str) – The Portfolio Group code (required)

• metadata_key (str) – Key of the access metadata entry to upsert (required)

• upsert_portfolio_group_access_metadata_request (UpsertPortfolioGroupAccessMetadataRequest) – The Portfolio Group Access Metadata rule to upsert (required)

• effective_at (str) – The date this rule will be effective from

• effective_until (datetime) – 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

• async_req (bool, optional) – Whether to execute the request asynchronously.

• _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

• _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

• _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(ResourceListOfAccessMetadataValueOf, status_code(int), headers(HTTPHeaderDict))