sdk.lusid.api.structured_result_data_api.StructuredResultDataApi
- class StructuredResultDataApi(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] CreateDataMap: Create data map # noqa: E501
[EXPERIMENTAL] CreateDataMap: Create data map # noqa: E501
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data # noqa: E501
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data # noqa: E501
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document.
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document.
[EXPERIMENTAL] GetDataMap: Get data map # noqa: E501
[EXPERIMENTAL] GetDataMap: Get data map # noqa: E501
[EXPERIMENTAL] GetStructuredResultData: Get structured result data # noqa: E501
[EXPERIMENTAL] GetStructuredResultData: Get structured result data # noqa: E501
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents # noqa: E501
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents # noqa: E501
[EXPERIMENTAL] UpsertResultValue: Upsert result value # noqa: E501
[EXPERIMENTAL] UpsertResultValue: Upsert result value # noqa: E501
[BETA] UpsertStructuredResultData: Upsert structured result data # noqa: E501
[BETA] UpsertStructuredResultData: Upsert structured result data # noqa: E501
- create_data_map(scope, request_body, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateDataMap: Create data map # noqa: E501
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_data_map(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create or update data maps. (required)
request_body (Dict[str, CreateDataMapRequest]) – Individual data map creation requests. (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:
- create_data_map_with_http_info(scope, request_body, **kwargs)[source]
[EXPERIMENTAL] CreateDataMap: Create data map # noqa: E501
Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_data_map_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create or update data maps. (required)
request_body (Dict[str, CreateDataMapRequest]) – Individual data map creation requests. (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(UpsertStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- delete_structured_result_data(scope, request_body, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data # noqa: E501
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_structured_result_data(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to delete data items. (required)
request_body (Dict[str, StructuredResultDataId]) – The data IDs to delete, each keyed by a unique, ephemeral correlation ID. (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:
- delete_structured_result_data_with_http_info(scope, request_body, **kwargs)[source]
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data # noqa: E501
Delete one or more structured result data items from a particular scope. Each item is identified by a unique ID which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_structured_result_data_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to delete data items. (required)
request_body (Dict[str, StructuredResultDataId]) – The data IDs to delete, each keyed by a unique, ephemeral correlation ID. (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(AnnulStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- get_address_key_definitions_for_document(scope, code, source, result_type, effective_at=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
For a given virtual document retrieve all the address key definitions that are in use. # 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_address_key_definitions_for_document(scope, code, source, result_type, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the document for which address key definitions are retrieved. (required)
code (str) – The code of the document for which address key definitions are retrieved. (required)
source (str) – The source of the document for which address key definitions are retrieved. (required)
result_type (str) – The result type of the document for which address key definitions are retrieved. (required)
effective_at (str) – The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
as_at (datetime) – The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version 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:
- get_address_key_definitions_for_document_with_http_info(scope, code, source, result_type, effective_at=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. # noqa: E501
For a given virtual document retrieve all the address key definitions that are in use. # 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_address_key_definitions_for_document_with_http_info(scope, code, source, result_type, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the document for which address key definitions are retrieved. (required)
code (str) – The code of the document for which address key definitions are retrieved. (required)
source (str) – The source of the document for which address key definitions are retrieved. (required)
result_type (str) – The result type of the document for which address key definitions are retrieved. (required)
effective_at (str) – The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified.
as_at (datetime) – The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying 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 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(ResourceListOfAddressKeyDefinition, status_code(int), headers(HTTPHeaderDict))
- get_data_map(scope, request_body, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetDataMap: Get data map # noqa: E501
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_data_map(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to retrieve data maps. (required)
request_body (Dict[str, DataMapKey]) – The data map keys to look up, each keyed by a unique, ephemeral correlation ID. (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:
- get_data_map_with_http_info(scope, request_body, **kwargs)[source]
[EXPERIMENTAL] GetDataMap: Get data map # noqa: E501
Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_data_map_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to retrieve data maps. (required)
request_body (Dict[str, DataMapKey]) – The data map keys to look up, each keyed by a unique, ephemeral correlation ID. (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(GetDataMapResponse, status_code(int), headers(HTTPHeaderDict))
- get_structured_result_data(scope, request_body, as_at=None, max_age=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetStructuredResultData: Get structured result data # noqa: E501
Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_structured_result_data(scope, request_body, as_at, max_age, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to retrieve data items. (required)
request_body (Dict[str, StructuredResultDataId]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (required)
as_at (datetime) – The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.
max_age (str) – The duration of the look-back window in ISO8601 time interval format, for example ‘P1Y2M3DT4H30M’ (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.
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:
- get_structured_result_data_with_http_info(scope, request_body, as_at=None, max_age=None, **kwargs)[source]
[EXPERIMENTAL] GetStructuredResultData: Get structured result data # noqa: E501
Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_structured_result_data_with_http_info(scope, request_body, as_at, max_age, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope from which to retrieve data items. (required)
request_body (Dict[str, StructuredResultDataId]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (required)
as_at (datetime) – The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified.
max_age (str) – The duration of the look-back window in ISO8601 time interval format, for example ‘P1Y2M3DT4H30M’ (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a data item must exist to be retrieved.
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(GetStructuredResultDataResponse, status_code(int), headers(HTTPHeaderDict))
- get_virtual_document(scope, request_body, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents # noqa: E501
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_virtual_document(scope, request_body, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to construct the virtual documents. (required)
request_body (Dict[str, StructuredResultDataId]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (required)
as_at (datetime) – The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version 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:
- get_virtual_document_rows(scope, code, source, result_type, effective_at, as_at=None, page=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # 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_virtual_document_rows(scope, code, source, result_type, effective_at, as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to retrieve the virtual document. (required)
code (str) – The code of the virtual document to retrieve. (required)
source (str) – The source of the virtual document to retrieve. (required)
result_type (str) – The result type of the virtual document to retrieve. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the virtual document. (required)
as_at (datetime) – The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. 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.
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:
- get_virtual_document_rows_with_http_info(scope, code, source, result_type, effective_at, as_at=None, page=None, limit=None, filter=None, **kwargs)[source]
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows # noqa: E501
Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. # 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_virtual_document_rows_with_http_info(scope, code, source, result_type, effective_at, as_at, page, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to retrieve the virtual document. (required)
code (str) – The code of the virtual document to retrieve. (required)
source (str) – The source of the virtual document to retrieve. (required)
result_type (str) – The result type of the virtual document to retrieve. (required)
effective_at (str) – The effectiveAt datetime at which to retrieve the virtual document. (required)
as_at (datetime) – The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified.
page (str) – The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. 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.
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(PagedResourceListOfVirtualRow, status_code(int), headers(HTTPHeaderDict))
- get_virtual_document_with_http_info(scope, request_body, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents # noqa: E501
Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or those that failed because LUSID could not construct a valid identifier from the request. For the IDs that failed to resolve or could not be found, a reason is provided. It is important to check the failed sets for any unsuccessful results. # 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_virtual_document_with_http_info(scope, request_body, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to construct the virtual documents. (required)
request_body (Dict[str, StructuredResultDataId]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (required)
as_at (datetime) – The asAt datetime at which to retrieve the structured result data. Defaults to returning 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 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(GetVirtualDocumentResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_result_value(scope, request_body, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpsertResultValue: Upsert result value # noqa: E501
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_result_value(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to construct the virtual documents. (required)
request_body (Dict[str, UpsertResultValuesDataRequest]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (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:
- upsert_result_value_with_http_info(scope, request_body, **kwargs)[source]
[EXPERIMENTAL] UpsertResultValue: Upsert result value # noqa: E501
Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_result_value_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to construct the virtual documents. (required)
request_body (Dict[str, UpsertResultValuesDataRequest]) – The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. (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(UpsertStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_structured_result_data(scope, request_body, async_req=None, **kwargs)[source]
[BETA] UpsertStructuredResultData: Upsert structured result data # noqa: E501
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_structured_result_data(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create or update data items. (required)
request_body (Dict[str, UpsertStructuredResultDataRequest]) – The set of data items to create or update, keyed by a unique, ephemeral correlation ID. (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:
- upsert_structured_result_data_with_http_info(scope, request_body, **kwargs)[source]
[BETA] UpsertStructuredResultData: Upsert structured result data # noqa: E501
Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. # 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_structured_result_data_with_http_info(scope, request_body, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope in which to create or update data items. (required)
request_body (Dict[str, UpsertStructuredResultDataRequest]) – The set of data items to create or update, keyed by a unique, ephemeral correlation ID. (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(UpsertStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))