Skip to main content

Get Virtual Documents

/api/unitresults/virtualdocument/{scope}/$get

GetVirtualDocument

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.