sdk.lusid.api.entities_api.EntitiesApi
- class EntitiesApi(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] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
[EXPERIMENTAL] GetEntityHistory: List an entity's history information # noqa: E501
[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
GetPortfolioChanges: Get the next change to each portfolio in a scope.
GetPortfolioChanges: Get the next change to each portfolio in a scope.
[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
- get_custom_entity_by_entity_unique_id(entity_unique_id, effective_at=None, as_at=None, previews=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to 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.get_custom_entity_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the Custom Entity. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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_custom_entity_by_entity_unique_id_with_http_info(entity_unique_id, effective_at=None, as_at=None, previews=None, **kwargs)[source]
[EXPERIMENTAL] GetCustomEntityByEntityUniqueId: Get a Custom Entity instance by its EntityUniqueId # noqa: E501
Retrieve a particular Custom Entity instance. If the Custom Entity is deleted, this will return the state of the Custom Entity immediately prior to 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.get_custom_entity_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the Custom Entity. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Custom Entity. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the Custom Entity. Defaults to returning the latest version of the Custom Entity if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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(CustomEntityEntity, status_code(int), headers(HTTPHeaderDict))
- get_data_type_by_entity_unique_id(entity_unique_id, as_at=None, previews=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to 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.get_data_type_by_entity_unique_id(entity_unique_id, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the DataType definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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_data_type_by_entity_unique_id_with_http_info(entity_unique_id, as_at=None, previews=None, **kwargs)[source]
[EXPERIMENTAL] GetDataTypeByEntityUniqueId: Get DataType by EntityUniqueId # noqa: E501
Retrieve the definition of a particular DataType. If the DataType is deleted, this will return the state of the DataType immediately prior to 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.get_data_type_by_entity_unique_id_with_http_info(entity_unique_id, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the DataType definition. (required)
as_at (datetime) – The asAt datetime at which to retrieve the DataType definition. Defaults to returning the latest version of the DataType definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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(DataTypeEntity, status_code(int), headers(HTTPHeaderDict))
- get_entity_history(entity_type, entity_unique_id, as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetEntityHistory: List an entity’s history information # noqa: E501
Retrieve a page of an entity’s change history up to a particular point in AsAt time. # 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_entity_history(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The type of the entity to list the change history for. (required)
entity_unique_id (str) – The universally unique identifier of the entity. (required)
as_at (datetime) – The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
page (str) – The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, 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 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names 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:
- get_entity_history_with_http_info(entity_type, entity_unique_id, as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] GetEntityHistory: List an entity’s history information # noqa: E501
Retrieve a page of an entity’s change history up to a particular point in AsAt time. # 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_entity_history_with_http_info(entity_type, entity_unique_id, as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The type of the entity to list the change history for. (required)
entity_unique_id (str) – The universally unique identifier of the entity. (required)
as_at (datetime) – The asAt datetime at which to list change history information. Defaults to return the change history at the latest datetime if not specified.
page (str) – The pagination token to use to continue listing change history information from a previous call to list change history information. This value is returned from the previous call. If a pagination token is provided the filter, 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 100 if not specified.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
sort_by (List[str]) – A list of field names 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(ResourceListOfChangeInterval, status_code(int), headers(HTTPHeaderDict))
- get_instrument_by_entity_unique_id(entity_unique_id, effective_at=None, as_at=None, previews=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to 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.get_instrument_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the instrument definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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_instrument_by_entity_unique_id_with_http_info(entity_unique_id, effective_at=None, as_at=None, previews=None, **kwargs)[source]
[EXPERIMENTAL] GetInstrumentByEntityUniqueId: Get instrument by EntityUniqueId # noqa: E501
Retrieve the definition of a particular instrument. If the instrument is deleted, this will return the state of the instrument immediately prior to 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.get_instrument_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the instrument definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the Instrument definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the instrument definition. Defaults to returning the latest version of the instrument definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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(InstrumentEntity, status_code(int), headers(HTTPHeaderDict))
- get_portfolio_by_entity_unique_id(entity_unique_id, effective_at=None, as_at=None, previews=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to 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.get_portfolio_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the portfolio definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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_portfolio_by_entity_unique_id_with_http_info(entity_unique_id, effective_at=None, as_at=None, previews=None, **kwargs)[source]
[EXPERIMENTAL] GetPortfolioByEntityUniqueId: Get portfolio by EntityUniqueId # noqa: E501
Retrieve the definition of a particular portfolio. If the portfolio is deleted, this will return the state of the portfolio immediately prior to 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.get_portfolio_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the portfolio definition. (required)
effective_at (str) – The effective datetime or cut label at which to retrieve the portfolio definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the portfolio definition. Defaults to returning the latest version of the portfolio definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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(PortfolioEntity, status_code(int), headers(HTTPHeaderDict))
- get_portfolio_changes(scope, effective_at, as_at=None, async_req=None, **kwargs)[source]
GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_portfolio_changes(scope, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope (required)
effective_at (str) – The effective date of the origin. (required)
as_at (datetime) – The as-at date of the origin.
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_portfolio_changes_with_http_info(scope, effective_at, as_at=None, **kwargs)[source]
GetPortfolioChanges: Get the next change to each portfolio in a scope. # noqa: E501
Gets the time of the next (earliest effective at) modification (correction and/or amendment) to each portfolio in a scope relative to a point in bitemporal time. Includes changes from parent portfolios in different scopes. Excludes changes from subscriptions (e.g corporate actions). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_portfolio_changes_with_http_info(scope, effective_at, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope (required)
effective_at (str) – The effective date of the origin. (required)
as_at (datetime) – The as-at date of the origin.
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(ResourceListOfChange, status_code(int), headers(HTTPHeaderDict))
- get_property_definition_by_entity_unique_id(entity_unique_id, effective_at=None, as_at=None, previews=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to 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.get_property_definition_by_entity_unique_id(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the property definition. (required)
effective_at (str) – The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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_property_definition_by_entity_unique_id_with_http_info(entity_unique_id, effective_at=None, as_at=None, previews=None, **kwargs)[source]
[EXPERIMENTAL] GetPropertyDefinitionByEntityUniqueId: Get property definition by EntityUniqueId # noqa: E501
Retrieve a particular property definition. If the property definition is deleted, this will return the state of the property definition immediately prior to 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.get_property_definition_by_entity_unique_id_with_http_info(entity_unique_id, effective_at, as_at, previews, async_req=True) >>> result = thread.get()
- Parameters:
entity_unique_id (str) – The universally unique identifier of the property definition. (required)
effective_at (str) – The effective datetime at which to retrieve the property definition. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to retrieve the property definition. Defaults to returning the latest version of the property definition if not specified.
previews (List[str]) – The ids of the staged modifications to be previewed in the response.
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(PropertyDefinitionEntity, status_code(int), headers(HTTPHeaderDict))