Navigation:  Integration via REST web services > Published web services > Knowledge base >

ARTICLES

 Previous  Top  Next

This method runs a search from the search term entered, then returns an article collection with superficial data, using a REST endpoint.

 

Service URL

https://<domain>/apigateway/se/exp/chatbot/api/articles.php

 

Method

GET

 

Input parameters

ID #

Type

Required

Description

fgLanguage

NUMERIC

X

Language code

nmSearchTerm

STRING

X

Term to be searched

oidKnowledgeBase

STRING

 

Primary key of a knowledge base (KBKNOWLEDGEBASE.OID)

 

Output parameter

{

 "success": true,

 "response": {

         "total": 1,

         "results": [

                 {

                         "oid": "article oid",

                         "identifier": "article identifier",

                         "title": "article title",

                         "knowledgeBaseTitle": "knowledge base title",

                         "excerpt": "initial excerpt of the article without formatting",

                         "shareLink": "link to article",

                         "isPublic": "if the link is public"

                 }

         ]

 }

}