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

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

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

Public Member Functions

System.Threading.Tasks.Task< ResourceListOfQueryableKeyGetAllQueryableKeysAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from all endpoints. More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfQueryableKey > > GetAllQueryableKeysWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetAllQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from all endpoints. 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

◆ GetAllQueryableKeysAsync()

System.Threading.Tasks.Task<ResourceListOfQueryableKey> Lusid.Sdk.Api.IQueryableKeysApiAsync.GetAllQueryableKeysAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from all endpoints.

When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtFor user defined DerivedValuation keys. (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 ResourceListOfQueryableKey

Implemented in Lusid.Sdk.Api.QueryableKeysApi.

◆ GetAllQueryableKeysWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfQueryableKey> > Lusid.Sdk.Api.IQueryableKeysApiAsync.GetAllQueryableKeysWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetAllQueryableKeys: Query the set of supported &quot;addresses&quot; that can be queried from all endpoints.

When a request is made, the user needs to know what keys can be passed to it for queryable data. This endpoint provides all supported keys,

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtFor user defined DerivedValuation keys. (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 (ResourceListOfQueryableKey)

Implemented in Lusid.Sdk.Api.QueryableKeysApi.


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