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

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

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

Public Member Functions

System.Threading.Tasks.Task< FileResponseGetExcelAddinAsync (string version=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Download Excel Addin More...
 
System.Threading.Tasks.Task< ApiResponse< FileResponse > > GetExcelAddinWithHttpInfoAsync (string version=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Download Excel Addin More...
 
System.Threading.Tasks.Task< VersionSummaryDtoGetLusidVersionsAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Get LUSID versions More...
 
System.Threading.Tasks.Task< ApiResponse< VersionSummaryDto > > GetLusidVersionsWithHttpInfoAsync (System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Get LUSID versions More...
 
System.Threading.Tasks.Task< ResourceListOfAccessControlledResourceListAccessControlledResourcesAsync (string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Get resources available for access control More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfAccessControlledResource > > ListAccessControlledResourcesWithHttpInfoAsync (string filter=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] Get resources available for access control 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

◆ GetExcelAddinAsync()

System.Threading.Tasks.Task<FileResponse> Lusid.Sdk.Api.IApplicationMetadataApiAsync.GetExcelAddinAsync ( string  version = default(string),
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] Download Excel Addin

Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
versionThe requested version of the Excel plugin (optional)
cancellationTokenCancellation Token to cancel the request.
Returns
Task of FileResponse

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.

◆ GetExcelAddinWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<FileResponse> > Lusid.Sdk.Api.IApplicationMetadataApiAsync.GetExcelAddinWithHttpInfoAsync ( string  version = default(string),
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] Download Excel Addin

Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
versionThe requested version of the Excel plugin (optional)
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (FileResponse)

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.

◆ GetLusidVersionsAsync()

System.Threading.Tasks.Task<VersionSummaryDto> Lusid.Sdk.Api.IApplicationMetadataApiAsync.GetLusidVersionsAsync ( System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken))

[EARLY ACCESS] Get LUSID versions

Get the semantic versions associated with LUSID and its ecosystem

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
cancellationTokenCancellation Token to cancel the request.
Returns
Task of VersionSummaryDto

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.

◆ GetLusidVersionsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<VersionSummaryDto> > Lusid.Sdk.Api.IApplicationMetadataApiAsync.GetLusidVersionsWithHttpInfoAsync ( System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken))

[EARLY ACCESS] Get LUSID versions

Get the semantic versions associated with LUSID and its ecosystem

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (VersionSummaryDto)

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.

◆ ListAccessControlledResourcesAsync()

System.Threading.Tasks.Task<ResourceListOfAccessControlledResource> Lusid.Sdk.Api.IApplicationMetadataApiAsync.ListAccessControlledResourcesAsync ( string  filter = default(string),
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] Get resources available for access control

Get the comprehensive set of resources that are available for access control

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
filterOptional. Expression to filter the result set. For example, to filter on the Application, use &quot;application eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfAccessControlledResource

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.

◆ ListAccessControlledResourcesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfAccessControlledResource> > Lusid.Sdk.Api.IApplicationMetadataApiAsync.ListAccessControlledResourcesWithHttpInfoAsync ( string  filter = default(string),
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] Get resources available for access control

Get the comprehensive set of resources that are available for access control

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
filterOptional. Expression to filter the result set. For example, to filter on the Application, use &quot;application eq &#39;string&#39;&quot; Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfAccessControlledResource)

Implemented in Lusid.Sdk.Api.ApplicationMetadataApi.


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