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

Inheritance diagram for Lusid.Sdk.Api.SearchApi:

[legend]

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

	SearchApi (String basePath)
	Initializes a new instance of the SearchApi class. More...

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

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

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

PagedResourceListOfPortfolioGroupSearchResult	SearchPortfolioGroups (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioGroupSearchResult >	SearchPortfolioGroupsWithHttpInfo (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups More...

async System.Threading.Tasks.Task< PagedResourceListOfPortfolioGroupSearchResult >	SearchPortfolioGroupsAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioGroupSearchResult > >	SearchPortfolioGroupsWithHttpInfoAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups More...

PagedResourceListOfPortfolioSearchResult	SearchPortfolios (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Portfolios Search through all portfolios More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioSearchResult >	SearchPortfoliosWithHttpInfo (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Portfolios Search through all portfolios More...

async System.Threading.Tasks.Task< PagedResourceListOfPortfolioSearchResult >	SearchPortfoliosAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Portfolios Search through all portfolios More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPortfolioSearchResult > >	SearchPortfoliosWithHttpInfoAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Portfolios Search through all portfolios More...

PagedResourceListOfPropertyDefinitionSearchResult	SearchProperties (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Property Definitions Search through all Property Definitions More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPropertyDefinitionSearchResult >	SearchPropertiesWithHttpInfo (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string))
	[EARLY ACCESS] Search Property Definitions Search through all Property Definitions More...

async System.Threading.Tasks.Task< PagedResourceListOfPropertyDefinitionSearchResult >	SearchPropertiesAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Property Definitions Search through all Property Definitions More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPropertyDefinitionSearchResult > >	SearchPropertiesWithHttpInfoAsync (string search=default(string), string filter=default(string), string sortBy=default(string), int? limit=default(int?), string page=default(string), System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EARLY ACCESS] Search Property Definitions Search through all Property Definitions 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...

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

Constructor & Destructor Documentation

◆ SearchApi() [1/4]

Lusid.Sdk.Api.SearchApi.SearchApi ( )

inline

Initializes a new instance of the SearchApi class.

Returns

◆ SearchApi() [2/4]

Lusid.Sdk.Api.SearchApi.SearchApi ( String basePath )

inline

Initializes a new instance of the SearchApi class.

Returns

◆ SearchApi() [3/4]

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

inline

Initializes a new instance of the SearchApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ SearchApi() [4/4]

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

inline

Initializes a new instance of the SearchApi 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.SearchApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ SearchPortfolioGroups()

PagedResourceListOfPortfolioGroupSearchResult Lusid.Sdk.Api.SearchApi.SearchPortfolioGroups	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups

Exceptions

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

Parameters

search	A parameter used for searching any portfolio group field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: PagedResourceListOfPortfolioGroupSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPortfolioGroupsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPortfolioGroupSearchResult> Lusid.Sdk.Api.SearchApi.SearchPortfolioGroupsAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups

Exceptions

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

Parameters

search	A parameter used for searching any portfolio group field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPortfolioGroupSearchResult

Implements Lusid.Sdk.Api.ISearchApiAsync.

◆ SearchPortfolioGroupsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPortfolioGroupSearchResult> Lusid.Sdk.Api.SearchApi.SearchPortfolioGroupsWithHttpInfo	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups

Exceptions

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

Parameters

search	A parameter used for searching any portfolio group field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: ApiResponse of PagedResourceListOfPortfolioGroupSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPortfolioGroupsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPortfolioGroupSearchResult> > Lusid.Sdk.Api.SearchApi.SearchPortfolioGroupsWithHttpInfoAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Portfolio Groups Search through all portfolio groups

Exceptions

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

Parameters

search	A parameter used for searching any portfolio group field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Scope, use "id.scope eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPortfolioGroupSearchResult)

Implements Lusid.Sdk.Api.ISearchApiAsync.

◆ SearchPortfolios()

PagedResourceListOfPortfolioSearchResult Lusid.Sdk.Api.SearchApi.SearchPortfolios	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Portfolios Search through all portfolios

Exceptions

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

Parameters

search	A parameter used for searching any portfolio field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the portfolio Type, use "type eq 'Transaction'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: PagedResourceListOfPortfolioSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPortfoliosAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPortfolioSearchResult> Lusid.Sdk.Api.SearchApi.SearchPortfoliosAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Portfolios Search through all portfolios

Exceptions

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

Parameters

search	A parameter used for searching any portfolio field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the portfolio Type, use "type eq 'Transaction'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPortfolioSearchResult

Implements Lusid.Sdk.Api.ISearchApiAsync.

◆ SearchPortfoliosWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPortfolioSearchResult> Lusid.Sdk.Api.SearchApi.SearchPortfoliosWithHttpInfo	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Portfolios Search through all portfolios

Exceptions

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

Parameters

search	A parameter used for searching any portfolio field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the portfolio Type, use "type eq 'Transaction'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: ApiResponse of PagedResourceListOfPortfolioSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPortfoliosWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPortfolioSearchResult> > Lusid.Sdk.Api.SearchApi.SearchPortfoliosWithHttpInfoAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Portfolios Search through all portfolios

Exceptions

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

Parameters

search	A parameter used for searching any portfolio field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the portfolio Type, use "type eq 'Transaction'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPortfolioSearchResult)

Implements Lusid.Sdk.Api.ISearchApiAsync.

◆ SearchProperties()

PagedResourceListOfPropertyDefinitionSearchResult Lusid.Sdk.Api.SearchApi.SearchProperties	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Property Definitions Search through all Property Definitions

Exceptions

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

Parameters

search	A parameter used for searching any field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Value Type, use "valueType eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: PagedResourceListOfPropertyDefinitionSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPropertiesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPropertyDefinitionSearchResult> Lusid.Sdk.Api.SearchApi.SearchPropertiesAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Property Definitions Search through all Property Definitions

Exceptions

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

Parameters

search	A parameter used for searching any field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Value Type, use "valueType eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPropertyDefinitionSearchResult

Implements Lusid.Sdk.Api.ISearchApiAsync.

◆ SearchPropertiesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPropertyDefinitionSearchResult> Lusid.Sdk.Api.SearchApi.SearchPropertiesWithHttpInfo	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`
	)

inline

[EARLY ACCESS] Search Property Definitions Search through all Property Definitions

Exceptions

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

Parameters

search	A parameter used for searching any field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Value Type, use "valueType eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)

Returns: ApiResponse of PagedResourceListOfPropertyDefinitionSearchResult

Implements Lusid.Sdk.Api.ISearchApiSync.

◆ SearchPropertiesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPropertyDefinitionSearchResult> > Lusid.Sdk.Api.SearchApi.SearchPropertiesWithHttpInfoAsync	(	string	search = `default(string)`,
		string	filter = `default(string)`,
		string	sortBy = `default(string)`,
		int?	limit = `default(int?)`,
		string	page = `default(string)`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

inline

[EARLY ACCESS] Search Property Definitions Search through all Property Definitions

Exceptions

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

Parameters

search	A parameter used for searching any field. Wildcards() are supported at the end of words (e.g. 'Port'). Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
filter	Expression to filter the result set. For example, to filter on the Value Type, use "valueType eq 'string'" Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. Multiple fields can be denoted by a comma e.g. -MyFieldName,AnotherFieldName,-AFurtherFieldName (optional)
limit	When paginating, only return this number of records (optional)
page	Encoded page string returned from a previous search result that will retrieve the next page of data. When this field is supplied, filter, sortBy and search fields should not be supplied. (optional)
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPropertyDefinitionSearchResult)

Implements Lusid.Sdk.Api.ISearchApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.SearchApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.SearchApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.SearchApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.SearchApi.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/stable/sdk/Lusid.Sdk/Api/SearchApi.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SearchApi() [1/4]

◆ SearchApi() [2/4]

◆ SearchApi() [3/4]

◆ SearchApi() [4/4]

Member Function Documentation

◆ GetBasePath()

◆ SearchPortfolioGroups()

◆ SearchPortfolioGroupsAsync()

◆ SearchPortfolioGroupsWithHttpInfo()

◆ SearchPortfolioGroupsWithHttpInfoAsync()

◆ SearchPortfolios()

◆ SearchPortfoliosAsync()

◆ SearchPortfoliosWithHttpInfo()

◆ SearchPortfoliosWithHttpInfoAsync()

◆ SearchProperties()

◆ SearchPropertiesAsync()

◆ SearchPropertiesWithHttpInfo()

◆ SearchPropertiesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory