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

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

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

Public Member Functions

System.Threading.Tasks.Task< AnnulStructuredDataResponseDeleteComplexMarketDataAsync (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. More...
 
System.Threading.Tasks.Task< 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. More...
 
System.Threading.Tasks.Task< GetComplexMarketDataResponseGetComplexMarketDataAsync (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 More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< ResourceListOfListComplexMarketDataWithMetaDataResponseListComplexMarketDataAsync (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] ListComplexMarketData: List the set of ComplexMarketData More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< UpsertStructuredDataResponseUpsertComplexMarketDataAsync (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertStructuredDataResponse > > UpsertComplexMarketDataWithHttpInfoAsync (string scope, Dictionary< string, UpsertComplexMarketDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertComplexMarketData: Upsert a set of complex market data items. This creates or updates the data in Lusid. More...
 
- Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- 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

Member Function Documentation

◆ DeleteComplexMarketDataAsync()

System.Threading.Tasks.Task<AnnulStructuredDataResponse> Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the complex market data to delete.
requestBodyThe complex market data Ids to delete, each keyed by a unique correlation id.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AnnulStructuredDataResponse

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ DeleteComplexMarketDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AnnulStructuredDataResponse> > Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the complex market data to delete.
requestBodyThe complex market data Ids to delete, each keyed by a unique correlation id.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AnnulStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ GetComplexMarketDataAsync()

System.Threading.Tasks.Task<GetComplexMarketDataResponse> Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the complex market data to retrieve.
requestBodyThe 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.
effectiveAtThe 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)
asAtThe asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAgeThe 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of GetComplexMarketDataResponse

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ GetComplexMarketDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetComplexMarketDataResponse> > Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the complex market data to retrieve.
requestBodyThe 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.
effectiveAtThe 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)
asAtThe asAt datetime at which to retrieve the complex market data. Defaults to return the latest version if not specified. (optional)
maxAgeThe 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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (GetComplexMarketDataResponse)

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ ListComplexMarketDataAsync()

System.Threading.Tasks.Task<ResourceListOfListComplexMarketDataWithMetaDataResponse> Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfListComplexMarketDataWithMetaDataResponse

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ ListComplexMarketDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfListComplexMarketDataWithMetaDataResponse> > Lusid.Sdk.Api.IComplexMarketDataApiAsync.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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the ComplexMarketData. Defaults to latest if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfListComplexMarketDataWithMetaDataResponse)

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ UpsertComplexMarketDataAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the complex market data.
requestBodyThe set of complex market data items to update or insert keyed by a unique correlation id.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertStructuredDataResponse

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.

◆ UpsertComplexMarketDataWithHttpInfoAsync()

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

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.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope to use when updating or inserting the complex market data.
requestBodyThe set of complex market data items to update or insert keyed by a unique correlation id.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertStructuredDataResponse)

Implemented in Lusid.Sdk.Api.ComplexMarketDataApi.


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