sdk.lusid.api.group_reconciliations_api.GroupReconciliationsApi
- class GroupReconciliationsApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition.
[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition.
[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset # noqa: E501
[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset # noqa: E501
[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code.
[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code.
[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code.
[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code.
[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results.
[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results.
[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
- batch_update_comparison_results(scope, code, batch_update_user_review_for_comparison_result_request, success_mode=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Scope and Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven’t passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.batch_update_comparison_results(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults. (required)
code (str) – GroupReconciliationDefinitionId code. (required)
batch_update_user_review_for_comparison_result_request (List[BatchUpdateUserReviewForComparisonResultRequest]) – A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
success_mode (str) – Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. “Partial” (default) | “Atomic”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- batch_update_comparison_results_with_http_info(scope, code, batch_update_user_review_for_comparison_result_request, success_mode=None, **kwargs)[source]
[EXPERIMENTAL] BatchUpdateComparisonResults: Add User Review entries for a range of comparison results related to a specific GroupReconciliationDefinition. # noqa: E501
Allows to update multiple Group Reconciliation Comparison Results related to the same definition specified by the Scope and Code. Updates User Review with new entries and sets the relevant Review Status. Supports partial success when all the entries that haven’t passed validation or are not related to the definition will be returned with respectful error details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.batch_update_comparison_results_with_http_info(scope, code, batch_update_user_review_for_comparison_result_request, success_mode, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – Shared Scope of the GroupReconciliationDefinition and GroupReconciliationComparisonResults. (required)
code (str) – GroupReconciliationDefinitionId code. (required)
batch_update_user_review_for_comparison_result_request (List[BatchUpdateUserReviewForComparisonResultRequest]) – A collection of the comparison result Ids and their user review entries to be added or removed. Single request contains resultId, break code/match key/comment to add and break code/match key/comment to remove by added timestamp. (required)
success_mode (str) – Defines whether the request should fail if at least one of the entries is failed to update or process all the entries regardless and return collections of successful and failed updates. “Partial” (default) | “Atomic”.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(BatchUpdateUserReviewForComparisonResultResponse, status_code(int), headers(HTTPHeaderDict))
- create_comparison_ruleset(create_group_reconciliation_comparison_ruleset_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset # noqa: E501
Creates a set of core and aggregate rules to be run for a group reconciliation # 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_comparison_ruleset(create_group_reconciliation_comparison_ruleset_request, async_req=True) >>> result = thread.get()
- Parameters:
create_group_reconciliation_comparison_ruleset_request (CreateGroupReconciliationComparisonRulesetRequest) – The request containing the details of the ruleset
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_comparison_ruleset_with_http_info(create_group_reconciliation_comparison_ruleset_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateComparisonRuleset: Create a Group Reconciliation Comparison Ruleset # noqa: E501
Creates a set of core and aggregate rules to be run for a group reconciliation # 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_comparison_ruleset_with_http_info(create_group_reconciliation_comparison_ruleset_request, async_req=True) >>> result = thread.get()
- Parameters:
create_group_reconciliation_comparison_ruleset_request (CreateGroupReconciliationComparisonRulesetRequest) – The request containing the details of the ruleset
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
- create_group_reconciliation_definition(create_group_reconciliation_definition_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
Creates a Group Reconciliation Definition # 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_group_reconciliation_definition(create_group_reconciliation_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_group_reconciliation_definition_request (CreateGroupReconciliationDefinitionRequest) – The definition Group Reconciliation Definition details
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_group_reconciliation_definition_with_http_info(create_group_reconciliation_definition_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateGroupReconciliationDefinition: Create Group Reconciliation Definition # noqa: E501
Creates a Group Reconciliation Definition # 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_group_reconciliation_definition_with_http_info(create_group_reconciliation_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
create_group_reconciliation_definition_request (CreateGroupReconciliationDefinitionRequest) – The definition Group Reconciliation Definition details
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
- delete_comparison_ruleset(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after 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_comparison_ruleset(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_comparison_ruleset_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteComparisonRuleset: Deletes a particular Group Reconciliation Comparison Ruleset # noqa: E501
The deletion will take effect from the reconciliation comparison ruleset deletion datetime. i.e. will no longer exist at any asAt datetime after 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_comparison_ruleset_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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_group_reconciliation_definition(scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
Delete the group reconciliation definition. # 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_reconciliation_definition(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to delete. (required)
code (str) – The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_group_reconciliation_definition_with_http_info(scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteGroupReconciliationDefinition: Delete Group Reconciliation Definition # noqa: E501
Delete the group reconciliation definition. # 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_reconciliation_definition_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to delete. (required)
code (str) – The code of the group reconciliation definition to delete. Together with the scope this uniquely identifies the group reconciliation definition 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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))
- get_comparison_result(scope, code, result_id, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # 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_comparison_result(scope, code, result_id, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison result and its related reconciliation definition. (required)
code (str) – The code of the reconciliation definition that was used to produce the reconciliation result. (required)
result_id (str) – The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
as_at (datetime) – The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_comparison_result_with_http_info(scope, code, result_id, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetComparisonResult: Get a single Group Reconciliation Comparison Result by scope and code. # noqa: E501
Retrieves one Group Reconciliation Comparison Result by scope and code with the prior validation that its related reconciliation definition exists. # 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_comparison_result_with_http_info(scope, code, result_id, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison result and its related reconciliation definition. (required)
code (str) – The code of the reconciliation definition that was used to produce the reconciliation result. (required)
result_id (str) – The code of the specified reconciliation result. Together with the domain and scope this uniquely identifies the reconciliation comparison result. This value is also the same as the computed result hash based on property values. (required)
as_at (datetime) – The asAt datetime at which to retrieve the comparison result definition. Defaults to return the latest version 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationComparisonResult, status_code(int), headers(HTTPHeaderDict))
- get_comparison_ruleset(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # 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_comparison_ruleset(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
as_at (datetime) – The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_comparison_ruleset_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetComparisonRuleset: Get a single Group Reconciliation Comparison Ruleset by scope and code. # noqa: E501
Retrieves one Group Reconciliation Comparison Ruleset by scope and code. # 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_comparison_ruleset_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
as_at (datetime) – The asAt datetime at which to retrieve the comparison ruleset definition. Defaults to return the latest version of the definition 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
- get_group_reconciliation_definition(scope, code, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
Retrieves a Group Reconciliation Definition by scope and code # 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_reconciliation_definition(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to retrieve. (required)
code (str) – The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_group_reconciliation_definition_with_http_info(scope, code, effective_at=None, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetGroupReconciliationDefinition: Get group reconciliation definition # noqa: E501
Retrieves a Group Reconciliation Definition by scope and code # 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_reconciliation_definition_with_http_info(scope, code, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to retrieve. (required)
code (str) – The code of the group reconciliation definition to retrieve. Together with the scope this uniquely identifies the group reconciliation definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the group reconciliation definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the group reconciliation definition. Defaults to return the latest version of the portfolio group definition 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
- list_comparison_results(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # 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_comparison_results(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
page (str) – The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many per page.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_comparison_results_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]
[EXPERIMENTAL] ListComparisonResults: Get a set of Group Reconciliation Comparison Results. # noqa: E501
Retrieves all Group Reconciliation Comparison Results that fit the filter, in a specific order if sortBy is provided. Supports pagination. # 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_comparison_results_with_http_info(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the comparison results. Defaults to return the latest version of the comparison results if not specified.
page (str) – The pagination token to use to continue listing comparison results from a previous call to list comparison results. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”.
limit (int) – When paginating, limit the number of returned results to this many per page.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(PagedResourceListOfGroupReconciliationComparisonResult, status_code(int), headers(HTTPHeaderDict))
- list_comparison_rulesets(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # 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_comparison_rulesets(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
page (str) – The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many per page.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_comparison_rulesets_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]
[EXPERIMENTAL] ListComparisonRulesets: Get a set of Group Reconciliation Comparison Rulesets # noqa: E501
Retrieves all Group Reconciliation Comparison Ruleset that fit the filter, in a specific order if sortBy is provided Supports pagination # 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_comparison_rulesets_with_http_info(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the comparison rulesets. Defaults to return the latest version of the comparison rulesets if not specified.
page (str) – The pagination token to use to continue listing comparison rulesets from a previous call to list comparison rulesets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many per page.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(PagedResourceListOfGroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
- list_group_reconciliation_definitions(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # 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_group_reconciliation_definitions(effective_at, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
page (str) – The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. 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”
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_group_reconciliation_definitions_with_http_info(effective_at=None, as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListGroupReconciliationDefinitions: List group reconciliation definitions # noqa: E501
Lists Group Reconciliation Definitions matching any provided filter, limit and sorting rules # 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_group_reconciliation_definitions_with_http_info(effective_at, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
effective_at (str) – The effective datetime or cut label at which to list the group reconciliation definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the group reconciliation definitions. Defaults to return the latest version of each group reconciliation definition if not specified.
page (str) – The pagination token to use to continue listing group reconciliation definitions from a previous call to list group reconciliation definitions. 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”
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(PagedResourceListOfGroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))
- run_reconciliation(scope, code, group_reconciliation_run_request, instance_run_type=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
Runs a Group Reconciliation using the definition specified by the Scope and Code Supports pagination. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_reconciliation(scope, code, group_reconciliation_run_request, instance_run_type, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to use for the reconciliation. (required)
code (str) – The code of the group reconciliation definition to use for the reconciliation. (required)
group_reconciliation_run_request (GroupReconciliationRunRequest) – (required)
instance_run_type (str) – The run type of the group reconciliation run instance. Default value: Manual. Available values: Manual, WorkflowServiceTaskId.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- run_reconciliation_with_http_info(scope, code, group_reconciliation_run_request, instance_run_type=None, **kwargs)[source]
[EXPERIMENTAL] RunReconciliation: Runs a Group Reconciliation # noqa: E501
Runs a Group Reconciliation using the definition specified by the Scope and Code Supports pagination. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.run_reconciliation_with_http_info(scope, code, group_reconciliation_run_request, instance_run_type, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to use for the reconciliation. (required)
code (str) – The code of the group reconciliation definition to use for the reconciliation. (required)
group_reconciliation_run_request (GroupReconciliationRunRequest) – (required)
instance_run_type (str) – The run type of the group reconciliation run instance. Default value: Manual. Available values: Manual, WorkflowServiceTaskId.
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationRunResponse, status_code(int), headers(HTTPHeaderDict))
- update_comparison_ruleset(scope, code, update_group_reconciliation_comparison_ruleset_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # 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_comparison_ruleset(scope, code, update_group_reconciliation_comparison_ruleset_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
update_group_reconciliation_comparison_ruleset_request (UpdateGroupReconciliationComparisonRulesetRequest) – The request containing the updated details of the ruleset
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- update_comparison_ruleset_with_http_info(scope, code, update_group_reconciliation_comparison_ruleset_request=None, **kwargs)[source]
[EXPERIMENTAL] UpdateComparisonRuleset: Update Group Reconciliation Comparison Ruleset defined by scope and code # noqa: E501
Overwrites an existing Group Reconciliation Comparison Ruleset Update request has the same required fields as Create apart from the Id # 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_comparison_ruleset_with_http_info(scope, code, update_group_reconciliation_comparison_ruleset_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the specified comparison ruleset. (required)
code (str) – The code of the specified comparison ruleset. Together with the domain and scope this uniquely identifies the reconciliation comparison ruleset. (required)
update_group_reconciliation_comparison_ruleset_request (UpdateGroupReconciliationComparisonRulesetRequest) – The request containing the updated details of the ruleset
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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationComparisonRuleset, status_code(int), headers(HTTPHeaderDict))
- update_group_reconciliation_definition(scope, code, update_group_reconciliation_definition_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
Update the group reconciliation definition. # 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_group_reconciliation_definition(scope, code, update_group_reconciliation_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to update the details for. (required)
code (str) – The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition. (required)
update_group_reconciliation_definition_request (UpdateGroupReconciliationDefinitionRequest) – The updated group reconciliation definition.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- update_group_reconciliation_definition_with_http_info(scope, code, update_group_reconciliation_definition_request=None, **kwargs)[source]
[EXPERIMENTAL] UpdateGroupReconciliationDefinition: Update group reconciliation definition # noqa: E501
Update the group reconciliation definition. # 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_group_reconciliation_definition_with_http_info(scope, code, update_group_reconciliation_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the group reconciliation definition to update the details for. (required)
code (str) – The code of the group reconciliation definition to update the details for. Together with the scope this uniquely identifies the group reconciliation definition. (required)
update_group_reconciliation_definition_request (UpdateGroupReconciliationDefinitionRequest) – The updated group reconciliation 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. Do not use - use the opts parameter instead
opts (ConfigurationOptions, optional) – Configuration options for this request
_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(GroupReconciliationDefinition, status_code(int), headers(HTTPHeaderDict))