net.leanix.api

Class SearchbookmarksApi

java.lang.Object

net.leanix.api.SearchbookmarksApi

public class SearchbookmarksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchbookmarksApi()
SearchbookmarksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
BookmarkSuggestionsResponse	getBookmarkSuggestions(String type, String subtype, String q, Boolean personalized, String sort, List<String> cursor, Integer pageSize, String sortDirection, UUID factSheetId, Boolean predefinedOnly) getBookmarkSuggestions Returns a list of bookmark suggestions for a given search term or all the bookmarks matching filter
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchbookmarksApi

public SearchbookmarksApi()

SearchbookmarksApi

public SearchbookmarksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBookmarkSuggestions

public BookmarkSuggestionsResponse getBookmarkSuggestions(String type,
                                                          String subtype,
                                                          String q,
                                                          Boolean personalized,
                                                          String sort,
                                                          List<String> cursor,
                                                          Integer pageSize,
                                                          String sortDirection,
                                                          UUID factSheetId,
                                                          Boolean predefinedOnly)
                                                   throws ApiException

getBookmarkSuggestions Returns a list of bookmark suggestions for a given search term or all the bookmarks matching filter

Parameters:

type - Bookmark type (optional)

subtype - Bookmark subtype (optional)

q - Search term (optional)

personalized - Personalized (optional, default to false)

sort - Sorting. Default sorting criterion is bookmark name. (optional)

cursor - Pagination cursor. The result page will start with the entry immediately after the entry corresponding to the cursor. Order of the cursor values matters.This parameter needs to be specified multiple times: once for each entry in the list, e.g., cursor=b2h5by1vaHlv&cursor=Ym9va21hcmsj (optional)

pageSize - Page size (optional, default to 40)

sortDirection - The direction of the sorting. Default sorting order for name is ASC, for date fields - DSC. (optional)

factSheetId - FactSheet ID, which must appear in bookmark (applicable only to bookmarks of BookmarkType VISUALIZER) (optional)

predefinedOnly - Indicates if only predefined bookmarks should be returned. (optional, default to false)

Returns:

BookmarkSuggestionsResponse

Throws:

ApiException - if fails to make API call