docs/SearchApi.md in purecloudplatformclientv2-84.0.0 vs docs/SearchApi.md in purecloudplatformclientv2-85.0.0

- old
+ new

@@ -17,10 +17,11 @@ [**get_users_search**](SearchApi.html#get_users_search) | Search users using the q64 value returned from a previous search [**get_voicemail_search**](SearchApi.html#get_voicemail_search) | Search voicemails using the q64 value returned from a previous search [**post_documentation_gkn_search**](SearchApi.html#post_documentation_gkn_search) | Search gkn documentation [**post_documentation_search**](SearchApi.html#post_documentation_search) | Search documentation [**post_groups_search**](SearchApi.html#post_groups_search) | Search groups +[**post_knowledge_knowledgebase_search**](SearchApi.html#post_knowledge_knowledgebase_search) | Search Documents [**post_locations_search**](SearchApi.html#post_locations_search) | Search locations [**post_search**](SearchApi.html#post_search) | Search resources. [**post_search_suggest**](SearchApi.html#post_search_suggest) | Suggest resources. [**post_users_search**](SearchApi.html#post_users_search) | Search users [**post_voicemail_search**](SearchApi.html#post_voicemail_search) | Search voicemails @@ -708,9 +709,78 @@ ### Return type [**GroupsSearchResponse**](GroupsSearchResponse.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_knowledge_knowledgebase_search"></a> + +## [**KnowledgeSearchResponse**](KnowledgeSearchResponse.html) post_knowledge_knowledgebase_search(knowledge_base_id, opts) + + + +Search Documents + + + +Wraps POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/search + +Requires ALL permissions: + +* knowledge:knowledgebase:search + + +### Example +```{"language":"ruby"} +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::SearchApi.new + +knowledge_base_id = "knowledge_base_id_example" # String | Knowledge base ID + +opts = { + body: PureCloud::KnowledgeSearchRequest.new # KnowledgeSearchRequest | +} + +begin + #Search Documents + result = api_instance.post_knowledge_knowledgebase_search(knowledge_base_id, opts) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling SearchApi->post_knowledge_knowledgebase_search: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **knowledge_base_id** | **String**| Knowledge base ID | | + **body** | [**KnowledgeSearchRequest**](KnowledgeSearchRequest.html)| | [optional] | +{: class="table table-striped"} + + +### Return type + +[**KnowledgeSearchResponse**](KnowledgeSearchResponse.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json