sdk.lusid.api.property_definitions_api.PropertyDefinitionsApi

class PropertyDefinitionsApi(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

`create_derived_property_definition`	[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition # noqa: E501
`create_derived_property_definition_with_http_info`	[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition # noqa: E501
`create_property_definition`	CreatePropertyDefinition: Create property definition # noqa: E501
`create_property_definition_with_http_info`	CreatePropertyDefinition: Create property definition # noqa: E501
`delete_property_definition`	DeletePropertyDefinition: Delete property definition # noqa: E501
`delete_property_definition_properties`	[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501
`delete_property_definition_properties_with_http_info`	[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501
`delete_property_definition_with_http_info`	DeletePropertyDefinition: Delete property definition # noqa: E501
`get_multiple_property_definitions`	GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501
`get_multiple_property_definitions_with_http_info`	GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501
`get_property_definition`	GetPropertyDefinition: Get property definition # noqa: E501
`get_property_definition_property_time_series`	[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501
`get_property_definition_property_time_series_with_http_info`	[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501
`get_property_definition_with_http_info`	GetPropertyDefinition: Get property definition # noqa: E501
`list_property_definitions`	ListPropertyDefinitions: List property definitions # noqa: E501
`list_property_definitions_with_http_info`	ListPropertyDefinitions: List property definitions # noqa: E501
`update_derived_property_definition`	[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition # noqa: E501
`update_derived_property_definition_with_http_info`	[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition # noqa: E501
`update_property_definition`	UpdatePropertyDefinition: Update property definition # noqa: E501
`update_property_definition_with_http_info`	UpdatePropertyDefinition: Update property definition # noqa: E501
`upsert_property_definition_properties`	[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501
`upsert_property_definition_properties_with_http_info`	[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501

create_derived_property_definition(create_derived_property_definition_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition # noqa: E501

Define a new derived property. # 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_derived_property_definition(create_derived_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_derived_property_definition_request (CreateDerivedPropertyDefinitionRequest) – The definition of the new derived property. (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:

PropertyDefinition

create_derived_property_definition_with_http_info(create_derived_property_definition_request, **kwargs)[source]

[EARLY ACCESS] CreateDerivedPropertyDefinition: Create derived property definition # noqa: E501

Define a new derived property. # 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_derived_property_definition_with_http_info(create_derived_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_derived_property_definition_request (CreateDerivedPropertyDefinitionRequest) – The definition of the new derived property. (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(PropertyDefinition, status_code(int), headers(HTTPHeaderDict))

create_property_definition(create_property_definition_request, async_req=None, **kwargs)[source]

CreatePropertyDefinition: Create property definition # noqa: E501

Define a new property. # 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_property_definition(create_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_property_definition_request (CreatePropertyDefinitionRequest) – The definition of the new property. (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:

PropertyDefinition

create_property_definition_with_http_info(create_property_definition_request, **kwargs)[source]

CreatePropertyDefinition: Create property definition # noqa: E501

Define a new property. # 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_property_definition_with_http_info(create_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

create_property_definition_request (CreatePropertyDefinitionRequest) – The definition of the new property. (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(PropertyDefinition, status_code(int), headers(HTTPHeaderDict))

delete_property_definition(domain, scope, code, async_req=None, **kwargs)[source]

DeletePropertyDefinition: Delete property definition # noqa: E501

Delete the definition of the specified property. # 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_property_definition(domain, scope, code, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property to be deleted. (required)
scope (str) – The scope of the property to be deleted. (required)
code (str) – The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. (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:

DeletedEntityResponse

delete_property_definition_properties(domain, scope, code, request_body, effective_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501

Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_property_definition_properties(domain, scope, code, request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property definition to delete properties from. (required)
scope (str) – The scope of the property definition to delete properties from. (required)
code (str) – The code of the property definition to delete properties from. (required)
request_body (List[str]) – The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g “PropertyDefinition/myScope/someAttributeKey”. Each property must be from the “PropertyDefinition” domain. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.
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:

DeletedEntityResponse

delete_property_definition_properties_with_http_info(domain, scope, code, request_body, effective_at=None, **kwargs)[source]

[EARLY ACCESS] DeletePropertyDefinitionProperties: Delete property definition properties # noqa: E501

Delete one or more properties from a single property definition. If the properties are time-variant then an effective date time from which the properties will be deleted must be specified. If the properties are perpetual then it is invalid to specify an effective date time for deletion. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_property_definition_properties_with_http_info(domain, scope, code, request_body, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property definition to delete properties from. (required)
scope (str) – The scope of the property definition to delete properties from. (required)
code (str) – The code of the property definition to delete properties from. (required)
request_body (List[str]) – The property keys of the properties to delete. These must take the format {domain}/{scope}/{code} e.g “PropertyDefinition/myScope/someAttributeKey”. Each property must be from the “PropertyDefinition” domain. (required)
effective_at (str) – The effective datetime or cut label at which to delete time-variant properties from. The property must exist at the specified ‘effectiveAt’ datetime. If the ‘effectiveAt’ is not provided or is before the time-variant property exists then a failure is returned. Do not specify this parameter if an of the properties to delete are perpetual.
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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_property_definition_with_http_info(domain, scope, code, **kwargs)[source]

DeletePropertyDefinition: Delete property definition # noqa: E501

Delete the definition of the specified property. # 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_property_definition_with_http_info(domain, scope, code, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property to be deleted. (required)
scope (str) – The scope of the property to be deleted. (required)
code (str) – The code of the property to be deleted. Together with the domain and scope this uniquely identifies the property. (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(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

get_multiple_property_definitions(property_keys, as_at=None, filter=None, effective_at=None, async_req=None, **kwargs)[source]

GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501

Retrieve the definition of one or more specified properties. # 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_multiple_property_definitions(property_keys, as_at, filter, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

property_keys (List[str]) – One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. ‘Portfolio/Manager/Id’. (required)
as_at (datetime) – The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Lifetime, use “lifeTime eq ‘Perpetual’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
effective_at (str) – The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime 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:

ResourceListOfPropertyDefinition

get_multiple_property_definitions_with_http_info(property_keys, as_at=None, filter=None, effective_at=None, **kwargs)[source]

GetMultiplePropertyDefinitions: Get multiple property definitions # noqa: E501

Retrieve the definition of one or more specified properties. # 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_multiple_property_definitions_with_http_info(property_keys, as_at, filter, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

property_keys (List[str]) – One or more property keys which identify each property that a definition should be retrieved for. The format for each property key is {domain}/{scope}/{code}, e.g. ‘Portfolio/Manager/Id’. (required)
as_at (datetime) – The asAt datetime at which to retrieve the property definitions. Defaults to return the latest version of each definition if not specified.
filter (str) – Expression to filter the result set. For example, to filter on the Lifetime, use “lifeTime eq ‘Perpetual’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
effective_at (str) – The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime 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(ResourceListOfPropertyDefinition, status_code(int), headers(HTTPHeaderDict))

get_property_definition(domain, scope, code, as_at=None, effective_at=None, async_req=None, **kwargs)[source]

GetPropertyDefinition: Get property definition # noqa: E501

Retrieve the definition of a specified property. # 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(domain, scope, code, as_at, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the specified property. (required)
scope (str) – The scope of the specified property. (required)
code (str) – The code of the specified property. Together with the domain and scope this uniquely identifies the property. (required)
as_at (datetime) – The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.
effective_at (str) – The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime 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:

PropertyDefinition

get_property_definition_property_time_series(domain, scope, code, property_key, as_at=None, filter=None, page=None, limit=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501

List the complete time series of a property definition property. # 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_property_time_series(domain, scope, code, property_key, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property definition to which the property is attached (required)
scope (str) – The scope of the property definition to which the property is attached (required)
code (str) – The code of the property definition to which the property is attached (required)
property_key (str) – The property key of the property whose history to show. This must be from the “Property Definition” domain and in the format {domain}/{scope}/{code}, for example “PropertyDefinition/myScope/someAttributeKey”. (required)
as_at (datetime) – The asAt datetime at which to show the history. Defaults to the current datetime if not specified.
filter (str) – Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
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:

ResourceListOfPropertyInterval

get_property_definition_property_time_series_with_http_info(domain, scope, code, property_key, as_at=None, filter=None, page=None, limit=None, **kwargs)[source]

[EARLY ACCESS] GetPropertyDefinitionPropertyTimeSeries: Get Property Definition Property Time Series # noqa: E501

List the complete time series of a property definition property. # 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_property_time_series_with_http_info(domain, scope, code, property_key, as_at, filter, page, limit, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property definition to which the property is attached (required)
scope (str) – The scope of the property definition to which the property is attached (required)
code (str) – The code of the property definition to which the property is attached (required)
property_key (str) – The property key of the property whose history to show. This must be from the “Property Definition” domain and in the format {domain}/{scope}/{code}, for example “PropertyDefinition/myScope/someAttributeKey”. (required)
as_at (datetime) – The asAt datetime at which to show the history. Defaults to the current datetime if not specified.
filter (str) – Expression to filter the results. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
page (str) – The pagination token to use to continue listing properties from a previous call to get property time series. This value is returned from the previous call. If a pagination token is provided the filter and asAt fields must not have changed since the original request.
limit (int) – When paginating, limit the number of returned results to this many.
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(ResourceListOfPropertyInterval, status_code(int), headers(HTTPHeaderDict))

get_property_definition_with_http_info(domain, scope, code, as_at=None, effective_at=None, **kwargs)[source]

GetPropertyDefinition: Get property definition # noqa: E501

Retrieve the definition of a specified property. # 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_with_http_info(domain, scope, code, as_at, effective_at, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the specified property. (required)
scope (str) – The scope of the specified property. (required)
code (str) – The code of the specified property. Together with the domain and scope this uniquely identifies the property. (required)
as_at (datetime) – The asAt datetime at which to retrieve the property definition. Defaults to return the latest version of the definition if not specified.
effective_at (str) – The effective datetime or cut label at which to list properties attached to the Property Definition. Defaults to the current LUSID system datetime 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(PropertyDefinition, status_code(int), headers(HTTPHeaderDict))

list_property_definitions(effective_at=None, as_at=None, property_keys=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]

ListPropertyDefinitions: List property definitions # noqa: E501

List all the property 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_property_definitions(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Property Definition’ domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g “PropertyDefinition/myScope/someAttributeKey”. Each property must be from the “PropertyDefinition” domain.
page (str) – The pagination token to use to continue listing property definitions; 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 results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the display name, specify “DisplayName eq ‘DisplayName’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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 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:

PagedResourceListOfPropertyDefinition

list_property_definitions_with_http_info(effective_at=None, as_at=None, property_keys=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]

ListPropertyDefinitions: List property definitions # noqa: E501

List all the property 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_property_definitions_with_http_info(effective_at, as_at, property_keys, page, limit, filter, sort_by, async_req=True)
>>> result = thread.get()

Parameters:

effective_at (str) – The effective datetime or cut label at which to list the property definitions. Defaults to the current LUSID system datetime if not specified.
as_at (datetime) – The asAt datetime at which to list the property definitions. Defaults to returning the latest version of each property definition if not specified.
property_keys (List[str]) – A list of property keys from the ‘Property Definition’ domain to decorate onto property definitions. These must take the format {domain}/{scope}/{code} e.g “PropertyDefinition/myScope/someAttributeKey”. Each property must be from the “PropertyDefinition” domain.
page (str) – The pagination token to use to continue listing property definitions; 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 results to this number. Defaults to 100 if not specified.
filter (str) – Expression to filter the results. For example, to filter on the display name, specify “DisplayName eq ‘DisplayName’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.
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 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(PagedResourceListOfPropertyDefinition, status_code(int), headers(HTTPHeaderDict))

update_derived_property_definition(domain, scope, code, update_derived_property_definition_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition # noqa: E501

This will fail if the property definition 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_derived_property_definition(domain, scope, code, update_derived_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – Domain of the property definition (required)
scope (str) – Scope of the property definition (required)
code (str) – Code of the property definition (required)
update_derived_property_definition_request (UpdateDerivedPropertyDefinitionRequest) – Information about the derived property definition being updated (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:

PropertyDefinition

update_derived_property_definition_with_http_info(domain, scope, code, update_derived_property_definition_request, **kwargs)[source]

[EARLY ACCESS] UpdateDerivedPropertyDefinition: Update a pre-existing derived property definition # noqa: E501

This will fail if the property definition 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_derived_property_definition_with_http_info(domain, scope, code, update_derived_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – Domain of the property definition (required)
scope (str) – Scope of the property definition (required)
code (str) – Code of the property definition (required)
update_derived_property_definition_request (UpdateDerivedPropertyDefinitionRequest) – Information about the derived property definition being updated (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(PropertyDefinition, status_code(int), headers(HTTPHeaderDict))

update_property_definition(domain, scope, code, update_property_definition_request, async_req=None, **kwargs)[source]

UpdatePropertyDefinition: Update property definition # noqa: E501

Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property. # 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_property_definition(domain, scope, code, update_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property being updated. (required)
scope (str) – The scope of the property being updated. (required)
code (str) – The code of the property being updated. Together with the domain and scope this uniquely identifies the property. (required)
update_property_definition_request (UpdatePropertyDefinitionRequest) – The updated definition of the property. (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:

PropertyDefinition

update_property_definition_with_http_info(domain, scope, code, update_property_definition_request, **kwargs)[source]

UpdatePropertyDefinition: Update property definition # noqa: E501

Update the definition of a specified existing property. Not all elements within a property definition are modifiable due to the potential implications for values already stored against the property. # 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_property_definition_with_http_info(domain, scope, code, update_property_definition_request, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the property being updated. (required)
scope (str) – The scope of the property being updated. (required)
code (str) – The code of the property being updated. Together with the domain and scope this uniquely identifies the property. (required)
update_property_definition_request (UpdatePropertyDefinitionRequest) – The updated definition of the property. (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(PropertyDefinition, status_code(int), headers(HTTPHeaderDict))

upsert_property_definition_properties(domain, scope, code, request_body, success_mode=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501

Create or update properties for a particular property definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_property_definition_properties(domain, scope, code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the specified property. (required)
scope (str) – The scope of the specified property. (required)
code (str) – The code of the specified property. Together with the domain and scope this uniquely (required)
request_body (Dict[str, ModelProperty]) – The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example ‘PropertyDefinition/Manager/Id’. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
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:

BatchUpsertPropertyDefinitionPropertiesResponse

upsert_property_definition_properties_with_http_info(domain, scope, code, request_body, success_mode=None, **kwargs)[source]

[EARLY ACCESS] UpsertPropertyDefinitionProperties: Upsert properties to a property definition # noqa: E501

Create or update properties for a particular property definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_property_definition_properties_with_http_info(domain, scope, code, request_body, success_mode, async_req=True)
>>> result = thread.get()

Parameters:

domain (str) – The domain of the specified property. (required)
scope (str) – The scope of the specified property. (required)
code (str) – The code of the specified property. Together with the domain and scope this uniquely (required)
request_body (Dict[str, ModelProperty]) – The properties to be created or updated. Each property in the request must be keyed by its unique property key. This has the format {domain}/{scope}/{code}, for example ‘PropertyDefinition/Manager/Id’. (required)
success_mode (str) – Whether the batch request should fail Atomically or in a Partial fashion - Allowed Values: Atomic, Partial.
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(BatchUpsertPropertyDefinitionPropertiesResponse, status_code(int), headers(HTTPHeaderDict))