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

Inheritance diagram for Lusid.Sdk.Api.ComplexMarketDataApi:

[legend]

Public Member Functions
	ComplexMarketDataApi ()
	Initializes a new instance of the ComplexMarketDataApi class. More...

	ComplexMarketDataApi (string basePath)
	Initializes a new instance of the ComplexMarketDataApi class. More...

	ComplexMarketDataApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the ComplexMarketDataApi class using Configuration object More...

	ComplexMarketDataApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the ComplexMarketDataApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

AnnulStructuredDataResponse	DeleteComplexMarketData (string scope, Dictionary< string, ComplexMarketDataId > requestBody, int operationIndex=0)
	[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. More...

Lusid.Sdk.Client.ApiResponse< AnnulStructuredDataResponse >	DeleteComplexMarketDataWithHttpInfo (string scope, Dictionary< string, ComplexMarketDataId > requestBody, int operationIndex=0)
	[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. More...

async System.Threading.Tasks.Task< AnnulStructuredDataResponse >	DeleteComplexMarketDataAsync (string scope, Dictionary< string, ComplexMarketDataId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AnnulStructuredDataResponse > >	DeleteComplexMarketDataWithHttpInfoAsync (string scope, Dictionary< string, ComplexMarketDataId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results. More...

GetComplexMarketDataResponse	GetComplexMarketData (string scope, Dictionary< string, ComplexMarketDataId > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0)
	[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. More...

Lusid.Sdk.Client.ApiResponse< GetComplexMarketDataResponse >	GetComplexMarketDataWithHttpInfo (string scope, Dictionary< string, ComplexMarketDataId > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0)
	[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. More...

async System.Threading.Tasks.Task< GetComplexMarketDataResponse >	GetComplexMarketDataAsync (string scope, Dictionary< string, ComplexMarketDataId > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetComplexMarketDataResponse > >	GetComplexMarketDataWithHttpInfoAsync (string scope, Dictionary< string, ComplexMarketDataId > requestBody, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results. More...

ResourceListOfListComplexMarketDataWithMetaDataResponse	ListComplexMarketData (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfListComplexMarketDataWithMetaDataResponse >	ListComplexMarketDataWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. More...

async System.Threading.Tasks.Task< ResourceListOfListComplexMarketDataWithMetaDataResponse >	ListComplexMarketDataAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfListComplexMarketDataWithMetaDataResponse > >	ListComplexMarketDataWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope. More...

UpsertStructuredDataResponse	UpsertComplexMarketData (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0)
	[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. More...

Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse >	UpsertComplexMarketDataWithHttpInfo (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0)
	[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. More...

async System.Threading.Tasks.Task< UpsertStructuredDataResponse >	UpsertComplexMarketDataAsync (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > >	UpsertComplexMarketDataWithHttpInfoAsync (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ ComplexMarketDataApi() [1/4]

Lusid.Sdk.Api.ComplexMarketDataApi.ComplexMarketDataApi ( )

inline

Initializes a new instance of the ComplexMarketDataApi class.

Returns

◆ ComplexMarketDataApi() [2/4]

Lusid.Sdk.Api.ComplexMarketDataApi.ComplexMarketDataApi ( string basePath )

inline

Initializes a new instance of the ComplexMarketDataApi class.

Returns

◆ ComplexMarketDataApi() [3/4]

Lusid.Sdk.Api.ComplexMarketDataApi.ComplexMarketDataApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the ComplexMarketDataApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ ComplexMarketDataApi() [4/4]

Lusid.Sdk.Api.ComplexMarketDataApi.ComplexMarketDataApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the ComplexMarketDataApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ DeleteComplexMarketData()

AnnulStructuredDataResponse Lusid.Sdk.Api.ComplexMarketDataApi.DeleteComplexMarketData	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to delete.
requestBody	The complex market data Ids to delete, each keyed by a unique correlation id.
operationIndex	Index associated with the operation.

Returns: AnnulStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ DeleteComplexMarketDataAsync()

async System.Threading.Tasks.Task<AnnulStructuredDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.DeleteComplexMarketDataAsync	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to delete.
requestBody	The complex market data Ids to delete, each keyed by a unique correlation id.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of AnnulStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ DeleteComplexMarketDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AnnulStructuredDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.DeleteComplexMarketDataWithHttpInfo	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to delete.
requestBody	The complex market data Ids to delete, each keyed by a unique correlation id.
operationIndex	Index associated with the operation.

Returns: ApiResponse of AnnulStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ DeleteComplexMarketDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<AnnulStructuredDataResponse> > Lusid.Sdk.Api.ComplexMarketDataApi.DeleteComplexMarketDataWithHttpInfoAsync	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] DeleteComplexMarketData: Delete one or more items of complex market data, assuming they are present. Delete one or more specified complex market data items from a single scope. Each item is identified by a unique id which includes information about its type as well as the exact effective datetime (to the microsecond) at which it entered the system (became valid). In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each quote in the response. The response will return both the collection of successfully deleted complex market data items, as well as those that failed. For the failures a reason will be provided explaining why the it could not be deleted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to delete.
requestBody	The complex market data Ids to delete, each keyed by a unique correlation id.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (AnnulStructuredDataResponse)

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.ComplexMarketDataApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetComplexMarketData()

GetComplexMarketDataResponse Lusid.Sdk.Api.ComplexMarketDataApi.GetComplexMarketData	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	maxAge = `default(string?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to retrieve.
requestBody	The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.
effectiveAt	The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body. (optional)
asAt	The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAge	The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved. (optional)
operationIndex	Index associated with the operation.

Returns: GetComplexMarketDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ GetComplexMarketDataAsync()

async System.Threading.Tasks.Task<GetComplexMarketDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.GetComplexMarketDataAsync	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	maxAge = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to retrieve.
requestBody	The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.
effectiveAt	The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body. (optional)
asAt	The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAge	The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of GetComplexMarketDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ GetComplexMarketDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<GetComplexMarketDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.GetComplexMarketDataWithHttpInfo	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	maxAge = `default(string?)`,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to retrieve.
requestBody	The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.
effectiveAt	The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body. (optional)
asAt	The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAge	The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of GetComplexMarketDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ GetComplexMarketDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<GetComplexMarketDataResponse> > Lusid.Sdk.Api.ComplexMarketDataApi.GetComplexMarketDataWithHttpInfoAsync	(	string	scope,
		Dictionary< string, ComplexMarketDataId >	requestBody,
		DateTimeOrCutLabel?	effectiveAt = `default(DateTimeOrCutLabel?)`,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	maxAge = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] GetComplexMarketData: Get complex market data Get one or more items of complex market data from a single scope. Each item can be identified by its time invariant complex market data identifier. For each id LUSID will return the most recent matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified which defines how far back to look back for data from the specified effective datetime. LUSID will return the most recent item within this window. In the request each complex market data id must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each item in the response. The response will return three collections. One, the successfully retrieved complex market data. Two, those that had a valid identifier but could not be found. Three, those that failed because LUSID could not construct a valid identifier from the request. For the ids that failed to resolve or could not be found a reason will be provided explaining why that is the case. It is important to always check the failed and not found sets for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the complex market data to retrieve.
requestBody	The time invariant set of complex data identifiers to retrieve the data for. These need to be keyed by a unique correlation id allowing the retrieved item to be identified in the response.
effectiveAt	The effective datetime at which to retrieve the complex market data. Defaults to the current LUSID system datetime if not specified. Must match the Effective at of each ComplexMarketDataId given in the request body. (optional)
asAt	The asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAge	The duration of the look back window in an ISO8601 time interval format e.g. P1Y2M3DT4H30M (1 year, 2 months, 3 days, 4 hours and 30 minutes). This is subtracted from the provided effectiveAt datetime to generate a effective datetime window inside which a complex market data item must exist to be retrieved. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (GetComplexMarketDataResponse)

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ ListComplexMarketData()

ResourceListOfListComplexMarketDataWithMetaDataResponse Lusid.Sdk.Api.ComplexMarketDataApi.ListComplexMarketData	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfListComplexMarketDataWithMetaDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ ListComplexMarketDataAsync()

async System.Threading.Tasks.Task<ResourceListOfListComplexMarketDataWithMetaDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.ListComplexMarketDataAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfListComplexMarketDataWithMetaDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ ListComplexMarketDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfListComplexMarketDataWithMetaDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.ListComplexMarketDataWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfListComplexMarketDataWithMetaDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ ListComplexMarketDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfListComplexMarketDataWithMetaDataResponse> > Lusid.Sdk.Api.ComplexMarketDataApi.ListComplexMarketDataWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData List the set of ComplexMarketData at the specified date/time, along with the scope the data was stored in and its identifier in that scope.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfListComplexMarketDataWithMetaDataResponse)

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ UpsertComplexMarketData()

UpsertStructuredDataResponse Lusid.Sdk.Api.ComplexMarketDataApi.UpsertComplexMarketData	(	string	scope,
		Dictionary< string, UpsertComplexMarketDataRequest >	requestBody,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to use when updating or inserting the complex market data.
requestBody	The set of complex market data items to update or insert keyed by a unique correlation id.
operationIndex	Index associated with the operation.

Returns: UpsertStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ UpsertComplexMarketDataAsync()

async System.Threading.Tasks.Task<UpsertStructuredDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.UpsertComplexMarketDataAsync	(	string	scope,
		Dictionary< string, UpsertComplexMarketDataRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to use when updating or inserting the complex market data.
requestBody	The set of complex market data items to update or insert keyed by a unique correlation id.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of UpsertStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

◆ UpsertComplexMarketDataWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<UpsertStructuredDataResponse> Lusid.Sdk.Api.ComplexMarketDataApi.UpsertComplexMarketDataWithHttpInfo	(	string	scope,
		Dictionary< string, UpsertComplexMarketDataRequest >	requestBody,
		int	operationIndex = `0`
	)

inline

[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to use when updating or inserting the complex market data.
requestBody	The set of complex market data items to update or insert keyed by a unique correlation id.
operationIndex	Index associated with the operation.

Returns: ApiResponse of UpsertStructuredDataResponse

Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.

◆ UpsertComplexMarketDataWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<UpsertStructuredDataResponse> > Lusid.Sdk.Api.ComplexMarketDataApi.UpsertComplexMarketDataWithHttpInfoAsync	(	string	scope,
		Dictionary< string, UpsertComplexMarketDataRequest >	requestBody,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. Update or insert one or more complex market data items in a single scope. An item will be updated if it already exists and inserted if it does not. In the request each complex market data item must be keyed by a unique correlation id. This id is ephemeral and is not stored by LUSID. It serves only as a way to easily identify each complex market data in the response. The response will return both the collection of successfully updated or inserted complex market data, as well as those that failed. For the failures a reason will be provided explaining why the item could not be updated or inserted. It is important to always check the failed set for any unsuccessful results.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope to use when updating or inserting the complex market data.
requestBody	The set of complex market data items to update or insert keyed by a unique correlation id.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (UpsertStructuredDataResponse)

Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ComplexMarketDataApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ComplexMarketDataApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ComplexMarketDataApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.ComplexMarketDataApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/ComplexMarketDataApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ComplexMarketDataApi() [1/4]

◆ ComplexMarketDataApi() [2/4]

◆ ComplexMarketDataApi() [3/4]

◆ ComplexMarketDataApi() [4/4]

Member Function Documentation

◆ DeleteComplexMarketData()

◆ DeleteComplexMarketDataAsync()

◆ DeleteComplexMarketDataWithHttpInfo()

◆ DeleteComplexMarketDataWithHttpInfoAsync()

◆ GetBasePath()

◆ GetComplexMarketData()

◆ GetComplexMarketDataAsync()

◆ GetComplexMarketDataWithHttpInfo()

◆ GetComplexMarketDataWithHttpInfoAsync()

◆ ListComplexMarketData()

◆ ListComplexMarketDataAsync()

◆ ListComplexMarketDataWithHttpInfo()

◆ ListComplexMarketDataWithHttpInfoAsync()

◆ UpsertComplexMarketData()

◆ UpsertComplexMarketDataAsync()

◆ UpsertComplexMarketDataWithHttpInfo()

◆ UpsertComplexMarketDataWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory