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

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

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

Public Member Functions

System.Threading.Tasks.Task< UpsertStructuredDataResponseCreateDataMapAsync (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateDataMap: Create data map More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertStructuredDataResponse > > CreateDataMapWithHttpInfoAsync (string scope, Dictionary< string, CreateDataMapRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 CreateDataMap: Create data map More...
 
System.Threading.Tasks.Task< AnnulStructuredDataResponseDeleteStructuredResultDataAsync (string scope, Dictionary< string, StructuredResultDataId > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] DeleteStructuredResultData: Delete structured result data More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< ResourceListOfAddressKeyDefinitionGetAddressKeyDefinitionsForDocumentAsync (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. More...
 
System.Threading.Tasks.Task< 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. More...
 
System.Threading.Tasks.Task< GetDataMapResponseGetDataMapAsync (string scope, Dictionary< string, DataMapKey > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] GetDataMap: Get data map More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< GetStructuredResultDataResponseGetStructuredResultDataAsync (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))
 GetStructuredResultData: Get structured result data More...
 
System.Threading.Tasks.Task< 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))
 GetStructuredResultData: Get structured result data More...
 
System.Threading.Tasks.Task< GetVirtualDocumentResponseGetVirtualDocumentAsync (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 More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< PagedResourceListOfVirtualRowGetVirtualDocumentRowsAsync (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 More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< UpsertStructuredDataResponseUpsertResultValueAsync (string scope, Dictionary< string, UpsertResultValuesDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EXPERIMENTAL] UpsertResultValue: Upsert result value More...
 
System.Threading.Tasks.Task< 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 More...
 
System.Threading.Tasks.Task< UpsertStructuredDataResponseUpsertStructuredResultDataAsync (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertStructuredResultData: Upsert structured result data More...
 
System.Threading.Tasks.Task< ApiResponse< UpsertStructuredDataResponse > > UpsertStructuredResultDataWithHttpInfoAsync (string scope, Dictionary< string, UpsertStructuredResultDataRequest > requestBody, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 UpsertStructuredResultData: Upsert structured result data 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

◆ CreateDataMapAsync()

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create or update data maps.
requestBodyIndividual data map creation requests.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertStructuredDataResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ CreateDataMapWithHttpInfoAsync()

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create or update data maps.
requestBodyIndividual data map creation requests.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertStructuredDataResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ DeleteStructuredResultDataAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope from which to delete data items.
requestBodyThe data IDs to delete, each keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AnnulStructuredDataResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ DeleteStructuredResultDataWithHttpInfoAsync()

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

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

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetAddressKeyDefinitionsForDocumentAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the document for which address key definitions are retrieved.
codeThe code of the document for which address key definitions are retrieved.
sourceThe source of the document for which address key definitions are retrieved.
resultTypeThe result type of the document for which address key definitions are retrieved.
effectiveAtThe effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional)
asAtThe asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAddressKeyDefinition

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetAddressKeyDefinitionsForDocumentWithHttpInfoAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the document for which address key definitions are retrieved.
codeThe code of the document for which address key definitions are retrieved.
sourceThe source of the document for which address key definitions are retrieved.
resultTypeThe result type of the document for which address key definitions are retrieved.
effectiveAtThe effective datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional)
asAtThe asAt datetime to query the document for which the address key definitions are retrieved. Defaults to querying the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAddressKeyDefinition)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetDataMapAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope from which to retrieve data maps.
requestBodyThe data map keys to look up, each keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of GetDataMapResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetDataMapWithHttpInfoAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope from which to retrieve data maps.
requestBodyThe data map keys to look up, each keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (GetDataMapResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetStructuredResultDataAsync()

System.Threading.Tasks.Task<GetStructuredResultDataResponse> Lusid.Sdk.Api.IStructuredResultDataApiAsync.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) 
)

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope from which to retrieve data items.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
asAtThe asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional)
maxAgeThe duration of the look-back window in ISO8601 time interval format, for example &#39;P1Y2M3DT4H30M&#39; (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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of GetStructuredResultDataResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetStructuredResultDataWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<GetStructuredResultDataResponse> > Lusid.Sdk.Api.IStructuredResultDataApiAsync.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) 
)

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope from which to retrieve data items.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
asAtThe asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional)
maxAgeThe duration of the look-back window in ISO8601 time interval format, for example &#39;P1Y2M3DT4H30M&#39; (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)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (GetStructuredResultDataResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetVirtualDocumentAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to construct the virtual documents.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
asAtThe asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of GetVirtualDocumentResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetVirtualDocumentRowsAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to retrieve the virtual document.
codeThe code of the virtual document to retrieve.
sourceThe source of the virtual document to retrieve.
resultTypeThe result type of the virtual document to retrieve.
effectiveAtThe effectiveAt datetime at which to retrieve the virtual document.
asAtThe asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfVirtualRow

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetVirtualDocumentRowsWithHttpInfoAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to retrieve the virtual document.
codeThe code of the virtual document to retrieve.
sourceThe source of the virtual document to retrieve.
resultTypeThe result type of the virtual document to retrieve.
effectiveAtThe effectiveAt datetime at which to retrieve the virtual document.
asAtThe asAt datetime at which to retrieve the virtual document. Defaults to returning the latest version if not specified. (optional)
pageThe 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)
limitWhen paginating, limit the number of returned results to this many. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfVirtualRow)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ GetVirtualDocumentWithHttpInfoAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to construct the virtual documents.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
asAtThe asAt datetime at which to retrieve the structured result data. Defaults to returning the latest version if not specified. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (GetVirtualDocumentResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ UpsertResultValueAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to construct the virtual documents.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertStructuredDataResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ UpsertResultValueWithHttpInfoAsync()

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

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to construct the virtual documents.
requestBodyThe time invariant set of structured data identifiers to retrieve, keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertStructuredDataResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ UpsertStructuredResultDataAsync()

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create or update data items.
requestBodyThe set of data items to create or update, keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of UpsertStructuredDataResponse

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.

◆ UpsertStructuredResultDataWithHttpInfoAsync()

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

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.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope in which to create or update data items.
requestBodyThe set of data items to create or update, keyed by a unique, ephemeral correlation ID.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (UpsertStructuredDataResponse)

Implemented in Lusid.Sdk.Api.StructuredResultDataApi.


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