sdk.lusid.api.custom_data_models_api.CustomDataModelsApi
- class CustomDataModelsApi(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] BatchAmend: Batch amend entities Custom Data Model membership.
[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership.
[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model # noqa: E501
[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model # noqa: E501
[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies.
[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies.
[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models.
[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models.
[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model # noqa: E501
[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model # noqa: E501
- batch_amend(success_mode, request_body, async_req=None, **kwargs)[source]
[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. # noqa: E501
Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status 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.batch_amend(success_mode, request_body, async_req=True) >>> result = thread.get()
- Parameters:
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
request_body (Dict[str, MembershipAmendmentRequest]) – The payload describing the amendments to make for the given Custom Data Model. (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:
- batch_amend_with_http_info(success_mode, request_body, **kwargs)[source]
[EXPERIMENTAL] BatchAmend: Batch amend entities Custom Data Model membership. # noqa: E501
Add/Remove entities to/from a Custom Data Model in a single operation. Each amendment request must be keyed by a unique correlation ID. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each amendment in the response. Note: If using partial failure modes, then it is important to check the response body for failures as any failures will still return a 200 status 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.batch_amend_with_http_info(success_mode, request_body, async_req=True) >>> result = thread.get()
- Parameters:
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial. (required)
request_body (Dict[str, MembershipAmendmentRequest]) – The payload describing the amendments to make for the given Custom Data Model. (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(BatchAmendCustomDataModelMembershipResponse, status_code(int), headers(HTTPHeaderDict))
- create_custom_data_model(entity_type, create_custom_data_model_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model # noqa: E501
Creates a Custom Data Model. # 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_custom_data_model(entity_type, create_custom_data_model_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
create_custom_data_model_request (CreateCustomDataModelRequest) – The request containing the details of the Data Model.
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_custom_data_model_with_http_info(entity_type, create_custom_data_model_request=None, **kwargs)[source]
[EXPERIMENTAL] CreateCustomDataModel: Create a Custom Data Model # noqa: E501
Creates a Custom Data Model. # 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_custom_data_model_with_http_info(entity_type, create_custom_data_model_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
create_custom_data_model_request (CreateCustomDataModelRequest) – The request containing the details of the Data Model.
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(CustomDataModel, status_code(int), headers(HTTPHeaderDict))
- delete_custom_data_model(entity_type, scope, code, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # 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_custom_data_model(entity_type, scope, code, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (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_custom_data_model_with_http_info(entity_type, scope, code, **kwargs)[source]
[EXPERIMENTAL] DeleteCustomDataModel: Delete a Custom Data Model # noqa: E501
Delete a Custom Data Model. The data model will remain viewable at previous as at times, but will no longer be part of any hierarchies. # 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_custom_data_model_with_http_info(entity_type, scope, code, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (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_custom_data_model(entity_type, scope, code, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
Retrieves a Custom Data Model at a given as at 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_custom_data_model(entity_type, scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model 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_custom_data_model_with_http_info(entity_type, scope, code, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetCustomDataModel: Get a Custom Data Model # noqa: E501
Retrieves a Custom Data Model at a given as at 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_custom_data_model_with_http_info(entity_type, scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model 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(CustomDataModel, status_code(int), headers(HTTPHeaderDict))
- list_data_model_hierarchies(as_at=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. # noqa: E501
Lists the data model summaries within their hierarchical structure. # 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_data_model_hierarchies(as_at, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
filter (str) – Expression to filter the results.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – Timeout setting. 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_data_model_hierarchies_with_http_info(as_at=None, filter=None, sort_by=None, **kwargs)[source]
[EXPERIMENTAL] ListDataModelHierarchies: List Custom Data Model hierarchies. # noqa: E501
Lists the data model summaries within their hierarchical structure. # 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_data_model_hierarchies_with_http_info(as_at, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the Data Model. Defaults to return the latest version of the Data Model if not specified.
filter (str) – Expression to filter the results.
sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – Timeout setting. 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(ResourceListOfDataModelSummary, status_code(int), headers(HTTPHeaderDict))
- list_supported_entity_types(async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. # noqa: E501
Lists the currently supported entity types available to bind with Custom Data Models. # 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_supported_entity_types(async_req=True) >>> result = thread.get()
- Parameters:
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_supported_entity_types_with_http_info(**kwargs)[source]
[EXPERIMENTAL] ListSupportedEntityTypes: List the currently supported entity types for use in Custom Data Models. # noqa: E501
Lists the currently supported entity types available to bind with Custom Data Models. # 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_supported_entity_types_with_http_info(async_req=True) >>> result = thread.get()
- Parameters:
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(ResourceListOfString, status_code(int), headers(HTTPHeaderDict))
- update_custom_data_model(entity_type, scope, code, update_custom_data_model_request=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model # noqa: E501
Updates a Custom Data Model. # 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_custom_data_model(entity_type, scope, code, update_custom_data_model_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (required)
update_custom_data_model_request (UpdateCustomDataModelRequest) – The request containing the details of the Data Model.
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_custom_data_model_with_http_info(entity_type, scope, code, update_custom_data_model_request=None, **kwargs)[source]
[EXPERIMENTAL] UpdateCustomDataModel: Update a Custom Data Model # noqa: E501
Updates a Custom Data Model. # 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_custom_data_model_with_http_info(entity_type, scope, code, update_custom_data_model_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type of the Data Model. (required)
scope (str) – The scope of the specified Data Model. (required)
code (str) – The code of the specified Data Model. (required)
update_custom_data_model_request (UpdateCustomDataModelRequest) – The request containing the details of the Data Model.
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(CustomDataModel, status_code(int), headers(HTTPHeaderDict))