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

Inheritance diagram for Lusid.Sdk.Api.ISearchApiSync:

Public Member Functions
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 More...

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 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 More...

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 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 More...

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 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

◆ SearchPortfolioGroups()

PagedResourceListOfPortfolioGroupSearchResult Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfolioGroupsWithHttpInfo()

ApiResponse<PagedResourceListOfPortfolioGroupSearchResult> Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfolios()

PagedResourceListOfPortfolioSearchResult Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPortfoliosWithHttpInfo()

ApiResponse<PagedResourceListOfPortfolioSearchResult> Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchProperties()

PagedResourceListOfPropertyDefinitionSearchResult Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

◆ SearchPropertiesWithHttpInfo()

ApiResponse<PagedResourceListOfPropertyDefinitionSearchResult> Lusid.Sdk.Api.ISearchApiSync.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

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

Implemented in Lusid.Sdk.Api.SearchApi.

The documentation for this interface 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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SearchPortfolioGroups()

◆ SearchPortfolioGroupsWithHttpInfo()

◆ SearchPortfolios()

◆ SearchPortfoliosWithHttpInfo()

◆ SearchProperties()

◆ SearchPropertiesWithHttpInfo()