net.leanix.api

Class SuggestionsApi

java.lang.Object

net.leanix.api.SuggestionsApi

public class SuggestionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SuggestionsApi()
SuggestionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
SuggestionsResponse	getSuggestions(String q, String object, Integer count, Boolean perType) getSuggestions Retrieves a list of suggestions for a search term
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestionsApi

public SuggestionsApi()

SuggestionsApi

public SuggestionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getSuggestions

public SuggestionsResponse getSuggestions(String q,
                                          String object,
                                          Integer count,
                                          Boolean perType)
                                   throws ApiException

getSuggestions Retrieves a list of suggestions for a search term

Parameters:

q - search term (required)

object - suggestions object type (optional, default to factSheet)

count - number of suggestions, defaultValue is 50 if perType = false, 25 otherwise (optional)

perType - if suggestions are to be grouped per object type (optional, default to false)

Returns:

SuggestionsResponse

Throws:

ApiException - if fails to make API call