sdk.lusid.api.market_data_field_configuration_api.MarketDataFieldConfigurationApi

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

`get_market_data_field_configuration`	[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration # noqa: E501
`get_market_data_field_configuration_with_http_info`	[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration # noqa: E501
`update_market_data_field_configuration`	[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration # noqa: E501
`update_market_data_field_configuration_with_http_info`	[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration # noqa: E501

get_market_data_field_configuration(market_data_category, as_at=None, async_req=None, **kwargs)[source]

[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration # noqa: E501

Retrieve the market data field configuration for a given market data category. If the configuration does not yet exist, an empty configuration will be returned. # 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_market_data_field_configuration(market_data_category, as_at, async_req=True)
>>> result = thread.get()

Parameters:

market_data_category (str) – The market data category. (required)
as_at (datetime) – The asAt datetime at which to retrieve the configuration. Defaults to return the latest version 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:

MarketDataFieldConfiguration

get_market_data_field_configuration_with_http_info(market_data_category, as_at=None, **kwargs)[source]

[EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration # noqa: E501

Retrieve the market data field configuration for a given market data category. If the configuration does not yet exist, an empty configuration will be returned. # 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_market_data_field_configuration_with_http_info(market_data_category, as_at, async_req=True)
>>> result = thread.get()

Parameters:

market_data_category (str) – The market data category. (required)
as_at (datetime) – The asAt datetime at which to retrieve the configuration. Defaults to return the latest version 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(MarketDataFieldConfiguration, status_code(int), headers(HTTPHeaderDict))

update_market_data_field_configuration(market_data_category, update_market_data_field_configuration_request, async_req=None, **kwargs)[source]

[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration # noqa: E501

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions. # 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_market_data_field_configuration(market_data_category, update_market_data_field_configuration_request, async_req=True)
>>> result = thread.get()

Parameters:

market_data_category (str) – The market data category. (required)
update_market_data_field_configuration_request (UpdateMarketDataFieldConfigurationRequest) – The metadata fields to add, update, or remove. (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:

MarketDataFieldConfiguration

update_market_data_field_configuration_with_http_info(market_data_category, update_market_data_field_configuration_request, **kwargs)[source]

[EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration # noqa: E501

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions. # 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_market_data_field_configuration_with_http_info(market_data_category, update_market_data_field_configuration_request, async_req=True)
>>> result = thread.get()

Parameters:

market_data_category (str) – The market data category. (required)
update_market_data_field_configuration_request (UpdateMarketDataFieldConfigurationRequest) – The metadata fields to add, update, or remove. (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(MarketDataFieldConfiguration, status_code(int), headers(HTTPHeaderDict))