LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
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, ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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), ConfigurationOptions? opts=null) |
[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, ConfigurationOptions? opts=null) |
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, ConfigurationOptions? opts=null) |
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), ConfigurationOptions? opts=null) |
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), ConfigurationOptions? opts=null) |
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... | |
Represents a collection of functions to interact with the API endpoints
|
inline |
Initializes a new instance of the ComplexMarketDataApi class.
|
inline |
Initializes a new instance of the ComplexMarketDataApi class.
|
inline |
Initializes a new instance of the ComplexMarketDataApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the ComplexMarketDataApi class using a Configuration object and client instance.
client | The client interface for synchronous API access. |
asyncClient | The client interface for asynchronous API access. |
configuration | The configuration object. |
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
inline |
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
asAt | The asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional) |
operationIndex | Index associated with the operation. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiSync.
|
inline |
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.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
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. |
opts | Options for this request. |
Implements Lusid.Sdk.Api.IComplexMarketDataApiAsync.
|
getset |
The client for accessing this underlying API asynchronously.
|
getset |
The client for accessing this underlying API synchronously.
|
getset |
Gets or sets the configuration object
An instance of the Configuration
|
getset |
Provides a factory method hook for the creation of exceptions.