sdk.lusid.api.custom_entity_definitions_api.CustomEntityDefinitionsApi
- class CustomEntityDefinitionsApi(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
[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type.
[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type.
[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.
[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition.
[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.
[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type.
- create_custom_entity_definition(custom_entity_definition_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. # noqa: E501
The API will return a Bad Request if the Custom Entity type already 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.create_custom_entity_definition(custom_entity_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
custom_entity_definition_request (CustomEntityDefinitionRequest) – The payload containing the description of the Custom Entity type. (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_custom_entity_definition_with_http_info(custom_entity_definition_request, **kwargs)[source]
[EARLY ACCESS] CreateCustomEntityDefinition: Define a new Custom Entity type. # noqa: E501
The API will return a Bad Request if the Custom Entity type already 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.create_custom_entity_definition_with_http_info(custom_entity_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
custom_entity_definition_request (CustomEntityDefinitionRequest) – The payload containing the description of the Custom Entity type. (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(CustomEntityDefinition, status_code(int), headers(HTTPHeaderDict))
- get_definition(entity_type, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. # noqa: E501
Retrieve a CustomEntityDefinition by a specific entityType at a 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_definition(entity_type, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The identifier for the Custom Entity type, derived from the “entityTypeName” provided on creation. (required)
as_at (datetime) – The AsAt datetime at which to retrieve the definition.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_definition_with_http_info(entity_type, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetDefinition: Get a Custom Entity type definition. # noqa: E501
Retrieve a CustomEntityDefinition by a specific entityType at a 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_definition_with_http_info(entity_type, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The identifier for the Custom Entity type, derived from the “entityTypeName” provided on creation. (required)
as_at (datetime) – The AsAt datetime at which to retrieve the definition.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(CustomEntityDefinition, status_code(int), headers(HTTPHeaderDict))
- list_custom_entity_definitions(as_at=None, limit=None, filter=None, page=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
List all Custom Entity type definitions matching particular criteria. # 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_custom_entity_definitions(as_at, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
page (str) – The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_custom_entity_definitions_with_http_info(as_at=None, limit=None, filter=None, page=None, **kwargs)[source]
[EARLY ACCESS] ListCustomEntityDefinitions: List the Custom Entity type definitions # noqa: E501
List all Custom Entity type definitions matching particular criteria. # 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_custom_entity_definitions_with_http_info(as_at, limit, filter, page, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the entities. Defaults to returning the latest version of each portfolio if not specified.
limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
page (str) – The pagination token to use to continue listing entities; this value is returned from the previous call. If a pagination token is provided, the filter, limit and asAt fields must not have changed since the original request.
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(PagedResourceListOfCustomEntityDefinition, status_code(int), headers(HTTPHeaderDict))
- update_custom_entity_definition(entity_type, update_custom_entity_definition_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. # noqa: E501
The API will return a Bad Request if the Custom Entity type does not exist. # 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_entity_definition(entity_type, update_custom_entity_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The identifier for the Custom Entity type, derived from the “entityTypeName” provided on creation. (required)
update_custom_entity_definition_request (UpdateCustomEntityDefinitionRequest) – The payload containing the description of the Custom Entity type. (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:
- update_custom_entity_definition_with_http_info(entity_type, update_custom_entity_definition_request, **kwargs)[source]
[EARLY ACCESS] UpdateCustomEntityDefinition: Modify an existing Custom Entity type. # noqa: E501
The API will return a Bad Request if the Custom Entity type does not exist. # 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_entity_definition_with_http_info(entity_type, update_custom_entity_definition_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The identifier for the Custom Entity type, derived from the “entityTypeName” provided on creation. (required)
update_custom_entity_definition_request (UpdateCustomEntityDefinitionRequest) – The payload containing the description of the Custom Entity type. (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(CustomEntityDefinition, status_code(int), headers(HTTPHeaderDict))