sdk.lusid.api.data_types_api.DataTypesApi
- class DataTypesApi(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] CreateDataType: Create data type definition # noqa: E501
[EARLY ACCESS] CreateDataType: Create data type definition # noqa: E501
GetDataType: Get data type definition # noqa: E501
GetDataType: Get data type definition # noqa: E501
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
ListDataTypes: List data types # noqa: E501
ListDataTypes: List data types # noqa: E501
[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type # noqa: E501
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type # noqa: E501
- create_data_type(create_data_type_request=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateDataType: Create data type definition # noqa: E501
Create a new data type definition Data types cannot be created in either the “default” or “system” scopes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_data_type(create_data_type_request, async_req=True) >>> result = thread.get()
- Parameters:
create_data_type_request (CreateDataTypeRequest) – The definition of the new data type
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_data_type_with_http_info(create_data_type_request=None, **kwargs)[source]
[EARLY ACCESS] CreateDataType: Create data type definition # noqa: E501
Create a new data type definition Data types cannot be created in either the “default” or “system” scopes. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_data_type_with_http_info(create_data_type_request, async_req=True) >>> result = thread.get()
- Parameters:
create_data_type_request (CreateDataTypeRequest) – The definition of the new data type
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:
- get_data_type(scope, code, as_at=None, async_req=None, **kwargs)[source]
GetDataType: Get data type definition # noqa: E501
Get the definition of a specified data type # 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(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
as_at (datetime) – The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_data_type_with_http_info(scope, code, as_at=None, **kwargs)[source]
GetDataType: Get data type definition # noqa: E501
Get the definition of a specified data type # 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_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
as_at (datetime) – The asAt datetime at which to retrieve the data type definition. Defaults to return the latest version of the instrument definition 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:
- get_units_from_data_type(scope, code, units=None, filter=None, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
Get the definitions of the specified units associated bound to a specific data type # 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_units_from_data_type(scope, code, units, filter, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
units (List[str]) – One or more unit identifiers for which the definition is being requested
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Schema, use “schema eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
as_at (datetime) – Optional. The as at of the requested data type
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_units_from_data_type_with_http_info(scope, code, units=None, filter=None, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetUnitsFromDataType: Get units from data type # noqa: E501
Get the definitions of the specified units associated bound to a specific data type # 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_units_from_data_type_with_http_info(scope, code, units, filter, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
units (List[str]) – One or more unit identifiers for which the definition is being requested
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Schema, use “schema eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
as_at (datetime) – Optional. The as at of the requested data type
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(ResourceListOfIUnitDefinitionDto, status_code(int), headers(HTTPHeaderDict))
- list_data_type_summaries(as_at=None, page=None, limit=None, filter=None, sort_by=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
List all data type summaries # 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_type_summaries(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
page (str) – The pagination token to use to continue listing data type summaries. 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 results to this number. Defaults to 100 if not specified.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Scope, use “id.scope eq ‘myscope’”, to filter on Schema, use “schema eq ‘string’”, to filter on AcceptableValues use “acceptableValues any (~ eq ‘value’)” 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 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:
- list_data_type_summaries_with_http_info(as_at=None, page=None, limit=None, filter=None, sort_by=None, **kwargs)[source]
[EARLY ACCESS] ListDataTypeSummaries: List all data type summaries, without the reference data # noqa: E501
List all data type summaries # 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_type_summaries_with_http_info(as_at, page, limit, filter, sort_by, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the data type summaries. Defaults to returning the latest version of each summary if not specified.
page (str) – The pagination token to use to continue listing data type summaries. 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 results to this number. Defaults to 100 if not specified.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Scope, use “id.scope eq ‘myscope’”, to filter on Schema, use “schema eq ‘string’”, to filter on AcceptableValues use “acceptableValues any (~ eq ‘value’)” 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 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(PagedResourceListOfDataTypeSummary, status_code(int), headers(HTTPHeaderDict))
- list_data_types(scope, as_at=None, include_system=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]
ListDataTypes: List data types # noqa: E501
List all data types in a specified scope # 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_types(scope, as_at, include_system, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The requested scope of the data types (required)
as_at (datetime) – The as at of the requested data types
include_system (bool) – Whether to additionally include those data types in the “system” scope
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Display Name, use “displayName eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_data_types_with_http_info(scope, as_at=None, include_system=None, sort_by=None, limit=None, filter=None, **kwargs)[source]
ListDataTypes: List data types # noqa: E501
List all data types in a specified scope # 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_types_with_http_info(scope, as_at, include_system, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The requested scope of the data types (required)
as_at (datetime) – The as at of the requested data types
include_system (bool) – Whether to additionally include those data types in the “system” scope
sort_by (List[str]) – Optional. Order the results by these fields. Use use the ‘-’ sign to denote descending order e.g. -MyFieldName
limit (int) – Optional. When paginating, limit the number of returned results to this many.
filter (str) – Optional. Expression to filter the result set. For example, to filter on the Display Name, use “displayName eq ‘string’” Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(ResourceListOfDataType, status_code(int), headers(HTTPHeaderDict))
- update_data_type(scope, code, update_data_type_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types # 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_data_type(scope, code, update_data_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
update_data_type_request (UpdateDataTypeRequest) – The updated definition of the data 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_data_type_with_http_info(scope, code, update_data_type_request, **kwargs)[source]
[EARLY ACCESS] UpdateDataType: Update data type definition # noqa: E501
Update the definition of the specified existing data type Not all elements within a data type definition are modifiable due to the potential implications for data already stored against the types # 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_data_type_with_http_info(scope, code, update_data_type_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
update_data_type_request (UpdateDataTypeRequest) – The updated definition of the data 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:
- update_reference_values(scope, code, field_value, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type # noqa: E501
Replaces the whole set of reference values # 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_reference_values(scope, code, field_value, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
field_value (List[FieldValue]) – The updated reference values (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_reference_values_with_http_info(scope, code, field_value, **kwargs)[source]
[EARLY ACCESS] UpdateReferenceValues: Update reference data on a data type # noqa: E501
Replaces the whole set of reference values # 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_reference_values_with_http_info(scope, code, field_value, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the data type (required)
code (str) – The code of the data type (required)
field_value (List[FieldValue]) – The updated reference values (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: