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

Inheritance diagram for Lusid.Sdk.Api.ApplicationMetadataApi:

[legend]

Public Member Functions
	ApplicationMetadataApi ()
	Initializes a new instance of the ApplicationMetadataApi class. More...

	ApplicationMetadataApi (string basePath)
	Initializes a new instance of the ApplicationMetadataApi class. More...

	ApplicationMetadataApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the ApplicationMetadataApi class using Configuration object More...

	ApplicationMetadataApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the ApplicationMetadataApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

FileResponse	GetExcelAddin (string? version=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetExcelAddin: Download Excel Addin Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned More...

Lusid.Sdk.Client.ApiResponse< FileResponse >	GetExcelAddinWithHttpInfo (string? version=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	GetExcelAddin: Download Excel Addin Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned More...

async System.Threading.Tasks.Task< FileResponse >	GetExcelAddinAsync (string? version=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetExcelAddin: Download Excel Addin Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< FileResponse > >	GetExcelAddinWithHttpInfoAsync (string? version=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetExcelAddin: Download Excel Addin Download the LUSID Excel Addin for Microsoft Excel. Not providing a specific value will return the latest version being returned More...

VersionSummaryDto	GetLusidVersions (int operationIndex=0, ConfigurationOptions? opts=null)
	GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem More...

Lusid.Sdk.Client.ApiResponse< VersionSummaryDto >	GetLusidVersionsWithHttpInfo (int operationIndex=0, ConfigurationOptions? opts=null)
	GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem More...

async System.Threading.Tasks.Task< VersionSummaryDto >	GetLusidVersionsAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< VersionSummaryDto > >	GetLusidVersionsWithHttpInfoAsync (int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem More...

ResourceListOfAccessControlledResource	ListAccessControlledResources (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListAccessControlledResources: Get resources available for access control Get the comprehensive set of resources that are available for access control More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessControlledResource >	ListAccessControlledResourcesWithHttpInfo (string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null)
	ListAccessControlledResources: Get resources available for access control Get the comprehensive set of resources that are available for access control More...

async System.Threading.Tasks.Task< ResourceListOfAccessControlledResource >	ListAccessControlledResourcesAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListAccessControlledResources: Get resources available for access control Get the comprehensive set of resources that are available for access control More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfAccessControlledResource > >	ListAccessControlledResourcesWithHttpInfoAsync (string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	ListAccessControlledResources: Get resources available for access control Get the comprehensive set of resources that are available for access control 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...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ ApplicationMetadataApi() [1/4]

Lusid.Sdk.Api.ApplicationMetadataApi.ApplicationMetadataApi ( )

inline

Initializes a new instance of the ApplicationMetadataApi class.

Returns

◆ ApplicationMetadataApi() [2/4]

Lusid.Sdk.Api.ApplicationMetadataApi.ApplicationMetadataApi ( string basePath )

inline

Initializes a new instance of the ApplicationMetadataApi class.

Returns

◆ ApplicationMetadataApi() [3/4]

Lusid.Sdk.Api.ApplicationMetadataApi.ApplicationMetadataApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the ApplicationMetadataApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ ApplicationMetadataApi() [4/4]

Lusid.Sdk.Api.ApplicationMetadataApi.ApplicationMetadataApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the ApplicationMetadataApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ GetBasePath()

string Lusid.Sdk.Api.ApplicationMetadataApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetExcelAddin()

FileResponse Lusid.Sdk.Api.ApplicationMetadataApi.GetExcelAddin	(	string?	version = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetExcelAddin: 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.ApiException Thrown when fails to make API call

Parameters

version	The requested version of the Excel plugin (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: FileResponse

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ GetExcelAddinAsync()

async System.Threading.Tasks.Task<FileResponse> Lusid.Sdk.Api.ApplicationMetadataApi.GetExcelAddinAsync	(	string?	version = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetExcelAddin: 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.ApiException Thrown when fails to make API call

Parameters

version	The requested version of the Excel plugin (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of FileResponse

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

◆ GetExcelAddinWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<FileResponse> Lusid.Sdk.Api.ApplicationMetadataApi.GetExcelAddinWithHttpInfo	(	string?	version = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetExcelAddin: 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.ApiException Thrown when fails to make API call

Parameters

version	The requested version of the Excel plugin (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of FileResponse

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ GetExcelAddinWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<FileResponse> > Lusid.Sdk.Api.ApplicationMetadataApi.GetExcelAddinWithHttpInfoAsync	(	string?	version = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetExcelAddin: 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.ApiException Thrown when fails to make API call

Parameters

version	The requested version of the Excel plugin (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (FileResponse)

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

◆ GetLusidVersions()

VersionSummaryDto Lusid.Sdk.Api.ApplicationMetadataApi.GetLusidVersions	(	int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: VersionSummaryDto

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ GetLusidVersionsAsync()

async System.Threading.Tasks.Task<VersionSummaryDto> Lusid.Sdk.Api.ApplicationMetadataApi.GetLusidVersionsAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of VersionSummaryDto

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

◆ GetLusidVersionsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<VersionSummaryDto> Lusid.Sdk.Api.ApplicationMetadataApi.GetLusidVersionsWithHttpInfo	(	int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of VersionSummaryDto

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ GetLusidVersionsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<VersionSummaryDto> > Lusid.Sdk.Api.ApplicationMetadataApi.GetLusidVersionsWithHttpInfoAsync	(	int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

GetLusidVersions: Get LUSID versions Get the semantic versions associated with LUSID and its ecosystem

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.
opts	Options for this request.

Returns: Task of ApiResponse (VersionSummaryDto)

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

◆ ListAccessControlledResources()

ResourceListOfAccessControlledResource Lusid.Sdk.Api.ApplicationMetadataApi.ListAccessControlledResources	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

filter	Optional. Expression to filter the result set. For example, to filter on the Application, use "application eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ResourceListOfAccessControlledResource

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ ListAccessControlledResourcesAsync()

async System.Threading.Tasks.Task<ResourceListOfAccessControlledResource> Lusid.Sdk.Api.ApplicationMetadataApi.ListAccessControlledResourcesAsync	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

filter	Optional. Expression to filter the result set. For example, to filter on the Application, use "application eq 'string'" 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.
opts	Options for this request.

Returns: Task of ResourceListOfAccessControlledResource

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

◆ ListAccessControlledResourcesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessControlledResource> Lusid.Sdk.Api.ApplicationMetadataApi.ListAccessControlledResourcesWithHttpInfo	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

filter	Optional. Expression to filter the result set. For example, to filter on the Application, use "application eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfAccessControlledResource

Implements Lusid.Sdk.Api.IApplicationMetadataApiSync.

◆ ListAccessControlledResourcesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfAccessControlledResource> > Lusid.Sdk.Api.ApplicationMetadataApi.ListAccessControlledResourcesWithHttpInfoAsync	(	string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

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

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

filter	Optional. Expression to filter the result set. For example, to filter on the Application, use "application eq 'string'" 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.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfAccessControlledResource)

Implements Lusid.Sdk.Api.IApplicationMetadataApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.ApplicationMetadataApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.ApplicationMetadataApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.ApplicationMetadataApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.ApplicationMetadataApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/ApplicationMetadataApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ApplicationMetadataApi() [1/4]

◆ ApplicationMetadataApi() [2/4]

◆ ApplicationMetadataApi() [3/4]

◆ ApplicationMetadataApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ GetExcelAddin()

◆ GetExcelAddinAsync()

◆ GetExcelAddinWithHttpInfo()

◆ GetExcelAddinWithHttpInfoAsync()

◆ GetLusidVersions()

◆ GetLusidVersionsAsync()

◆ GetLusidVersionsWithHttpInfo()

◆ GetLusidVersionsWithHttpInfoAsync()

◆ ListAccessControlledResources()

◆ ListAccessControlledResourcesAsync()

◆ ListAccessControlledResourcesWithHttpInfo()

◆ ListAccessControlledResourcesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory