LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync:
Inheritance graph
[legend]

Public Member Functions

MarketDataFieldConfiguration GetMarketDataFieldConfiguration (string marketDataCategory, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration More...
 
Lusid.Sdk.Client.ApiResponse< MarketDataFieldConfigurationGetMarketDataFieldConfigurationWithHttpInfo (string marketDataCategory, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] GetMarketDataFieldConfiguration: Get a Market Data Field Configuration More...
 
MarketDataFieldConfiguration UpdateMarketDataFieldConfiguration (string marketDataCategory, UpdateMarketDataFieldConfigurationRequest updateMarketDataFieldConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration More...
 
Lusid.Sdk.Client.ApiResponse< MarketDataFieldConfigurationUpdateMarketDataFieldConfigurationWithHttpInfo (string marketDataCategory, UpdateMarketDataFieldConfigurationRequest updateMarketDataFieldConfigurationRequest, int operationIndex=0, ConfigurationOptions? opts=null)
 [EARLY ACCESS] UpdateMarketDataFieldConfiguration: Update a Market Data Field Configuration More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ GetMarketDataFieldConfiguration()

MarketDataFieldConfiguration Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync.GetMarketDataFieldConfiguration ( string  marketDataCategory,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
asAtThe asAt datetime at which to retrieve the configuration. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ GetMarketDataFieldConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<MarketDataFieldConfiguration> Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync.GetMarketDataFieldConfigurationWithHttpInfo ( string  marketDataCategory,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
asAtThe asAt datetime at which to retrieve the configuration. Defaults to return the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ UpdateMarketDataFieldConfiguration()

MarketDataFieldConfiguration Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync.UpdateMarketDataFieldConfiguration ( string  marketDataCategory,
UpdateMarketDataFieldConfigurationRequest  updateMarketDataFieldConfigurationRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

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

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
updateMarketDataFieldConfigurationRequestThe metadata fields to add, update, or remove.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.

◆ UpdateMarketDataFieldConfigurationWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<MarketDataFieldConfiguration> Lusid.Sdk.Api.IMarketDataFieldConfigurationApiSync.UpdateMarketDataFieldConfigurationWithHttpInfo ( string  marketDataCategory,
UpdateMarketDataFieldConfigurationRequest  updateMarketDataFieldConfigurationRequest,
int  operationIndex = 0,
ConfigurationOptions opts = null 
)

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

Update the metadata field schema for a market data field configuration. Allows adding, updating, and removing metadata field definitions.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
marketDataCategoryThe market data category.
updateMarketDataFieldConfigurationRequestThe metadata fields to add, update, or remove.
operationIndexIndex associated with the operation.
optsOptions for this request.
Returns
ApiResponse of MarketDataFieldConfiguration

Implemented in Lusid.Sdk.Api.MarketDataFieldConfigurationApi.


The documentation for this interface was generated from the following file: