LUSID C# SDK
|
Represents a collection of functions to interact with the API endpoints More...
Public Member Functions | |
StructuredResultDataApi () | |
Initializes a new instance of the StructuredResultDataApi class. More... | |
StructuredResultDataApi (string basePath) | |
Initializes a new instance of the StructuredResultDataApi class. More... | |
StructuredResultDataApi (Lusid.Sdk.Client.Configuration configuration) | |
Initializes a new instance of the StructuredResultDataApi class using Configuration object More... | |
StructuredResultDataApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration) | |
Initializes a new instance of the StructuredResultDataApi class using a Configuration object and client instance. More... | |
string | GetBasePath () |
Gets the base path of the API client. More... | |
UpsertStructuredDataResponse | CreateDataMap (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0) |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > | CreateDataMapWithHttpInfo (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0) |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< UpsertStructuredDataResponse > | CreateDataMapAsync (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > > | CreateDataMapWithHttpInfoAsync (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
AnnulStructuredDataResponse | DeleteStructuredResultData (string scope, Dictionary< string, StructuredResultDataId > requestBody, int operationIndex=0) |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< AnnulStructuredDataResponse > | DeleteStructuredResultDataWithHttpInfo (string scope, Dictionary< string, StructuredResultDataId > requestBody, int operationIndex=0) |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< AnnulStructuredDataResponse > | DeleteStructuredResultDataAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< AnnulStructuredDataResponse > > | DeleteStructuredResultDataWithHttpInfoAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
ResourceListOfAddressKeyDefinition | GetAddressKeyDefinitionsForDocument (string scope, string code, string source, string resultType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use. More... | |
Lusid.Sdk.Client.ApiResponse< ResourceListOfAddressKeyDefinition > | GetAddressKeyDefinitionsForDocumentWithHttpInfo (string scope, string code, string source, string resultType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use. More... | |
async System.Threading.Tasks.Task< ResourceListOfAddressKeyDefinition > | GetAddressKeyDefinitionsForDocumentAsync (string scope, string code, string source, string resultType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAddressKeyDefinition > > | GetAddressKeyDefinitionsForDocumentWithHttpInfoAsync (string scope, string code, string source, string resultType, DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use. More... | |
GetDataMapResponse | GetDataMap (string scope, Dictionary< string, DataMapKey > requestBody, int operationIndex=0) |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< GetDataMapResponse > | GetDataMapWithHttpInfo (string scope, Dictionary< string, DataMapKey > requestBody, int operationIndex=0) |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< GetDataMapResponse > | GetDataMapAsync (string scope, Dictionary< string, DataMapKey > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetDataMapResponse > > | GetDataMapWithHttpInfoAsync (string scope, Dictionary< string, DataMapKey > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
GetStructuredResultDataResponse | GetStructuredResultData (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0) |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< GetStructuredResultDataResponse > | GetStructuredResultDataWithHttpInfo (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0) |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< GetStructuredResultDataResponse > | GetStructuredResultDataAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetStructuredResultDataResponse > > | GetStructuredResultDataWithHttpInfoAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), string? maxAge=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
GetVirtualDocumentResponse | GetVirtualDocument (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< GetVirtualDocumentResponse > | GetVirtualDocumentWithHttpInfo (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< GetVirtualDocumentResponse > | GetVirtualDocumentAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< GetVirtualDocumentResponse > > | GetVirtualDocumentWithHttpInfoAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results. More... | |
PagedResourceListOfVirtualRow | GetVirtualDocumentRows (string scope, string code, string source, string resultType, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0) |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. More... | |
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfVirtualRow > | GetVirtualDocumentRowsWithHttpInfo (string scope, string code, string source, string resultType, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0) |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. More... | |
async System.Threading.Tasks.Task< PagedResourceListOfVirtualRow > | GetVirtualDocumentRowsAsync (string scope, string code, string source, string resultType, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfVirtualRow > > | GetVirtualDocumentRowsWithHttpInfoAsync (string scope, string code, string source, string resultType, DateTimeOrCutLabel effectiveAt, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension. More... | |
UpsertStructuredDataResponse | UpsertResultValue (string scope, Dictionary< string, UpsertResultValuesDataRequest > requestBody, int operationIndex=0) |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > | UpsertResultValueWithHttpInfo (string scope, Dictionary< string, UpsertResultValuesDataRequest > requestBody, int operationIndex=0) |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< UpsertStructuredDataResponse > | UpsertResultValueAsync (string scope, Dictionary< string, UpsertResultValuesDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > > | UpsertResultValueWithHttpInfoAsync (string scope, Dictionary< string, UpsertResultValuesDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
UpsertStructuredDataResponse | UpsertStructuredResultData (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0) |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > | UpsertStructuredResultDataWithHttpInfo (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0) |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< UpsertStructuredDataResponse > | UpsertStructuredResultDataAsync (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results. More... | |
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< UpsertStructuredDataResponse > > | UpsertStructuredResultDataWithHttpInfoAsync (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to 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 StructuredResultDataApi class.
|
inline |
Initializes a new instance of the StructuredResultDataApi class.
|
inline |
Initializes a new instance of the StructuredResultDataApi class using Configuration object
configuration | An instance of Configuration |
|
inline |
Initializes a new instance of the StructuredResultDataApi 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 |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data maps. |
requestBody | Individual data map creation requests. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data maps. |
requestBody | Individual data map creation requests. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data maps. |
requestBody | Individual data map creation requests. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] CreateDataMap: Create data map Create or update one or more structured result store address definition data maps in a particular scope. Note these are immutable and cannot be changed once created. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map object in the response. The response returns both the collection of successfully created or updated data maps, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data maps. |
requestBody | Individual data map creation requests. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to delete data items. |
requestBody | The data IDs to delete, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to delete data items. |
requestBody | The data IDs to delete, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to delete data items. |
requestBody | The data IDs to delete, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data Delete one or more structured result data items from a particular 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 data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully deleted data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to delete data items. |
requestBody | The data IDs to delete, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the document for which address key definitions are retrieved. |
code | The code of the document for which address key definitions are retrieved. |
source | The source of the document for which address key definitions are retrieved. |
resultType | The result type of the document for which address key definitions are retrieved. |
effectiveAt | The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
asAt | The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the document for which address key definitions are retrieved. |
code | The code of the document for which address key definitions are retrieved. |
source | The source of the document for which address key definitions are retrieved. |
resultType | The result type of the document for which address key definitions are retrieved. |
effectiveAt | The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
asAt | The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the document for which address key definitions are retrieved. |
code | The code of the document for which address key definitions are retrieved. |
source | The source of the document for which address key definitions are retrieved. |
resultType | The result type of the document for which address key definitions are retrieved. |
effectiveAt | The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
asAt | The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EARLY ACCESS] GetAddressKeyDefinitionsForDocument: Get AddressKeyDefinitions for a virtual document. For a given virtual document retrieve all the address key definitions that are in use.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope of the document for which address key definitions are retrieved. |
code | The code of the document for which address key definitions are retrieved. |
source | The source of the document for which address key definitions are retrieved. |
resultType | The result type of the document for which address key definitions are retrieved. |
effectiveAt | The effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
asAt | The asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
|
inline |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data maps. |
requestBody | The data map keys to look up, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data maps. |
requestBody | The data map keys to look up, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data maps. |
requestBody | The data map keys to look up, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetDataMap: Get data map Retrieve one or more structured result store address definition data maps from a particular scope. Each data map can be identified by its invariant key, which can be thought of as a permanent URL. For each ID, LUSID returns the most recently matched item. In the request, each data map must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data map in the response. The response returns three collections. The first contains successfully retrieved data maps. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data maps. |
requestBody | The data map keys to look up, each keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data items. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
maxAge | The duration of the look-back window in ISO8601 time interval format, for example '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 data item must exist to be retrieved. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data items. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
maxAge | The duration of the look-back window in ISO8601 time interval format, for example '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 data item must exist to be retrieved. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data items. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
maxAge | The duration of the look-back window in ISO8601 time interval format, for example '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 data item must exist to be retrieved. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetStructuredResultData: Get structured result data Retrieve one or more structured result data items from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided (or default) effective datetime. An optional maximum age range window can be specified to control how far back to look from the specified effective datetime. LUSID returns the most recent item within this window. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns three collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found. The third contains 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope from which to retrieve data items. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
maxAge | The duration of the look-back window in ISO8601 time interval format, for example '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 data item must exist to be retrieved. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to retrieve the virtual document. |
code | The code of the virtual document to retrieve. |
source | The source of the virtual document to retrieve. |
resultType | The result type of the virtual document to retrieve. |
effectiveAt | The effectiveAt datetime at which to retrieve the virtual document. |
asAt | The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional) |
page | The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to retrieve the virtual document. |
code | The code of the virtual document to retrieve. |
source | The source of the virtual document to retrieve. |
resultType | The result type of the virtual document to retrieve. |
effectiveAt | The effectiveAt datetime at which to retrieve the virtual document. |
asAt | The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional) |
page | The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to retrieve the virtual document. |
code | The code of the virtual document to retrieve. |
source | The source of the virtual document to retrieve. |
resultType | The result type of the virtual document to retrieve. |
effectiveAt | The effectiveAt datetime at which to retrieve the virtual document. |
asAt | The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional) |
page | The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EARLY ACCESS] GetVirtualDocumentRows: Get Virtual Document Rows Retrieve the rows of the virtual document with the specified identifiers and the given effectiveAt date time. Get virtual document rows merges multiple StructuredResultData items upserted with UpsertStructuredResultData for a single StructuredResultDataId. Since an item of StructuredResultData is always upserted with a StructuredResultDataId, of which effectiveAt is a part, then merging across the asAt dimension is supported but not merging across the effectiveAt dimension.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to retrieve the virtual document. |
code | The code of the virtual document to retrieve. |
source | The source of the virtual document to retrieve. |
resultType | The result type of the virtual document to retrieve. |
effectiveAt | The effectiveAt datetime at which to retrieve the virtual document. |
asAt | The asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional) |
page | The pagination token to use to continue listing virtual document rows from a previous call to list virtual document rows. This value is returned from the previous call. If a pagination token is provided the filter, effectiveAt, and asAt fields must not have changed since the original request. (optional) |
limit | When paginating, limit the number of returned results to this many. (optional) |
filter | Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] GetVirtualDocument: Get Virtual Documents Retrieve one or more virtual documents from a particular scope. Each item can be identified by its time invariant structured result data identifier. For each ID, LUSID returns the most recently matched item with respect to the provided effective datetime. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns two collections. The first contains successfully retrieved data items. The second contains those with a valid identifier but that could not be found, or 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 is provided. It is important to check the failed sets for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
asAt | The asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional) |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[EXPERIMENTAL] UpsertResultValue: Upsert result value Create or update one or more Upsert one or more result values in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to construct the virtual documents. |
requestBody | The time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data items. |
requestBody | The set of data items to create or update, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data items. |
requestBody | The set of data items to create or update, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
inline |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data items. |
requestBody | The set of data items to create or update, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiSync.
|
inline |
[BETA] UpsertStructuredResultData: Upsert structured result data Create or update one or more structured result data items in a particular scope. An item is updated if it already exists and created if it does not. In the request, each data item must be keyed by a unique correlation ID. This ID is ephemeral and not stored by LUSID. It serves only to easily identify each data item in the response. The response returns both the collection of successfully created or updated data items, as well as those that failed. For each failure, a reason is provided. It is important to check the failed set for any unsuccessful results.
Lusid.Sdk.Client.ApiException | Thrown when fails to make API call |
scope | The scope in which to create or update data items. |
requestBody | The set of data items to create or update, keyed by a unique, ephemeral correlation ID. |
operationIndex | Index associated with the operation. |
cancellationToken | Cancellation Token to cancel the request. |
Implements Lusid.Sdk.Api.IStructuredResultDataApiAsync.
|
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.